com.novell.admin.ns

Class MOOManagerCallBack

java.lang.Object

com.novell.admin.ns.MOOManagerCallBack

public abstract class MOOManagerCallBack
extends java.lang.Object

This class describes a callback mechanism service for multiple object operations.

See Also:

MOOManager

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABORT_UPDATE
static int	CONTINUE_UPDATE
protected int	updateInterval

Constructor Summary

Constructors

Constructor and Description
MOOManagerCallBack(int inupdateInterval) Constructs a MOOManagerCallBack object.

Method Summary

Modifier and Type	Method and Description
abstract void	finished(int totaloeCount) CallBack from MOOManager.updateObjects
int	getUpdateInterval()
abstract int	handleException(java.lang.Exception e, ObjectEntry errorOE) CallBack from MOOManager.updateObjects when an exception occurs
abstract int	update(ObjectEntry nextOE, int oeCount) CallBack from MOOManager.updateObjects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ABORT_UPDATE

public static final int ABORT_UPDATE

See Also:

Constant Field Values

CONTINUE_UPDATE

public static final int CONTINUE_UPDATE

See Also:

Constant Field Values

updateInterval

protected int updateInterval

Constructor Detail

MOOManagerCallBack

public MOOManagerCallBack(int inupdateInterval)

Constructs a MOOManagerCallBack object.

Parameters:

inupdateInterval - - The interval with which to call update() on this callback. If 1, then update will be called before each attempt to update an ObjectEntry on the MOOManager. If 10, then update will be called before trying to update the 10th, 20th, 30th, etc. ObjectEntries on the MOOManager. If set to 0, then update will never be called during the MOOManager.updateObjects() process

Method Detail

getUpdateInterval

public int getUpdateInterval()

update

public abstract int update(ObjectEntry nextOE,
                           int oeCount)

CallBack from MOOManager.updateObjects

Parameters:

nextOE - The next ObjectEntry to be modified. It has not been processed yet, but is about to be tried.

oeCount - The number count of the associated Objectentry from 1 to Total_Number_of__OE's

Returns:

int Either ABORT_UPDATE or CONTINUE_UPDATE

handleException

public abstract int handleException(java.lang.Exception e,
                                    ObjectEntry errorOE)

CallBack from MOOManager.updateObjects when an exception occurs

Parameters:

e - The exception that occured.

errorOE - The ObjectEntry that caused an error when being modified. This ObjectEntry will not be modified. This may be null if an error outside of a specif OE update occurred.

Returns:

int either ABORT_UPDATE or CONTINUE_UPDATE

finished

public abstract void finished(int totaloeCount)

CallBack from MOOManager.updateObjects

Parameters:

totaloeCount - The number count of the associated Objectentry(s) that have been processed. Processing does not mean successfully completed but an attempt was made. The updateObjects() call is now complete and will be returning. The returned count may be 0 if no OE's existed or were attempted to be processed. This is called as the last thing before returning from updateObjects() with the number of currently completed objects, whether any exceptions occurred or whether the update() or handleException() calls above returned ABORT_UPDATE