git-svn-id: https://svn.code.sf.net/p/flaim/code/trunk@247 0109f412-320b-0410-ab79-c3e0c5ffbbe6
71 lines
2.9 KiB
Java
71 lines
2.9 KiB
Java
//------------------------------------------------------------------------------
|
|
// Desc: Db Check Status
|
|
//
|
|
// 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: DbCheckStatus.java 3110 2006-01-19 13:09:08 -0700 (Thu, 19 Jan 2006) dsanders $
|
|
//------------------------------------------------------------------------------
|
|
package xflaim;
|
|
|
|
/**
|
|
* This interface alows XFlaim to periodically pass information back to the
|
|
* client about the status of an ongoing database check operation. The
|
|
* implementor may do anything it wants with the information, such as write
|
|
* it to a log file or display it on the screen. Additionally, it allows
|
|
* the implementor to chose, on a case-by-case basis, whether to attempt
|
|
* to fix problems manually, request XFLaim attempt to fix them or
|
|
* ignore them alltogether.
|
|
*/
|
|
public interface DbCheckStatus
|
|
{
|
|
/**
|
|
* Called periodically by XFlaim to inform the client of the status
|
|
* of an ongoing database check operation.
|
|
* @param ProgCheck A class who's public data members contain
|
|
* information about what exactly has been checked so far and
|
|
* what problems have been found.
|
|
* @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
|
|
* check operation to abort and an XFLaimException to be thrown.
|
|
* @see xflaim.CHECKINFO
|
|
*/
|
|
int reportProgress(
|
|
CHECKINFO ProgCheck);
|
|
|
|
/**
|
|
* Called by XFlaim when an error has been detected during a database
|
|
* check.
|
|
* @param CorruptInfo A class who's public data members contain
|
|
* information describing the nature of the currption.
|
|
* @param bFix This is an array containing a single element. If the
|
|
* client writes a true into that element, then XFlaim will attempt
|
|
* to fix the corruption.
|
|
* @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
|
|
* check operation to abort and an XFLaimException to be thrown.
|
|
* @see xflaim.CORRUPTINFO
|
|
*/
|
|
int reportCheckErr(
|
|
CORRUPTINFO CorruptInfo,
|
|
boolean[] bFix);
|
|
}
|