fc65d74c62
git-svn-id: https://svn.code.sf.net/p/flaim/code/trunk@247 0109f412-320b-0410-ab79-c3e0c5ffbbe6
101 lines
3.5 KiB
Java
101 lines
3.5 KiB
Java
//------------------------------------------------------------------------------
|
|
// Desc: Restore Client
|
|
//
|
|
// Tabs: 3
|
|
//
|
|
// Copyright (c) 2004-2006 Novell, Inc. All Rights Reserved.
|
|
//
|
|
// This program is free software; you can redistribute it and/or
|
|
// modify it under the terms of version 2 of the GNU General Public
|
|
// License as published by the Free Software Foundation.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program; if not, contact Novell, Inc.
|
|
//
|
|
// To contact Novell about this file by physical or electronic mail,
|
|
// you may find current contact information at www.novell.com
|
|
//
|
|
// $Id: RestoreClient.java 3110 2006-01-19 13:09:08 -0700 (Thu, 19 Jan 2006) dsanders $
|
|
//------------------------------------------------------------------------------
|
|
|
|
package xflaim;
|
|
|
|
/**
|
|
* This interface defines the client side interface to XFlaim's restore
|
|
* subsystem. Clients must pass an object that implements this interface
|
|
* into the call to {@link DbSystem#dbRestore DbSystem::dbRestore}
|
|
* See the documentation regarding Backup/Restore operations for more details.
|
|
* @see DefaultRestoreClient
|
|
*/
|
|
public interface RestoreClient
|
|
{
|
|
/**
|
|
*
|
|
* @return Returns a status code. The integer should one of the constants
|
|
* found in {@link xflaim.RCODE xflaim.RCODE}.
|
|
* Note that returning anything other than NE_XFLM_OK will cause the
|
|
* restore operation to abort an XFLaimException to be thrown.
|
|
*/
|
|
public int openBackupSet();
|
|
|
|
/**
|
|
*
|
|
* @param iFileNum
|
|
* @return Returns a status code. The integer should one of the constants
|
|
* found in {@link xflaim.RCODE xflaim.RCODE}.
|
|
* Note that returning anything other than NE_XFLM_OK will cause the
|
|
* restore operation to abort an XFLaimException to be thrown.
|
|
*/
|
|
public int openRflFile(
|
|
int iFileNum);
|
|
|
|
/**
|
|
*
|
|
* @param iFileNum
|
|
* @return Returns a status code. The integer should one of the constants
|
|
* found in {@link xflaim.RCODE xflaim.RCODE}.
|
|
* Note that returning anything other than NE_XFLM_OK will cause the
|
|
* restore operation to abort an XFLaimException to be thrown.
|
|
*/
|
|
public int openIncFile(
|
|
int iFileNum);
|
|
|
|
/**
|
|
*
|
|
* @param Buffer
|
|
* @param BytesRead NOTE: Will have a length of 1 Function
|
|
* must store the number of valid bytes in Buffer into BytesRead[0].
|
|
* (This allows us to pass that value back to the calling function.)
|
|
* @return Returns a status code. The integer should one of the constants
|
|
* found in {@link xflaim.RCODE xflaim.RCODE}.
|
|
* Note that returning anything other than NE_XFLM_OK will cause the
|
|
* restore operation to abort an XFLaimException to be thrown.
|
|
*/
|
|
public int read(
|
|
byte[] Buffer,
|
|
int[] BytesRead);
|
|
|
|
/**
|
|
*
|
|
* @return Returns a status code. The integer should one of the constants
|
|
* found in {@link xflaim.RCODE xflaim.RCODE}.
|
|
* Note that returning anything other than NE_XFLM_OK will cause the
|
|
* restore operation to abort an XFLaimException to be thrown.
|
|
*/
|
|
public int close();
|
|
|
|
/**
|
|
*
|
|
* @return Returns a status code. The integer should one of the constants
|
|
* found in {@link xflaim.RCODE xflaim.RCODE}.
|
|
* Note that returning anything other than NE_XFLM_OK will cause the
|
|
* restore operation to abort an XFLaimException to be thrown.
|
|
*/
|
|
public int abortFile();
|
|
}
|