com.businessobjects.sdk.plugin.desktop.remotecluster
Interface ICleanupOptions

public interface ICleanupOptions

This interface defines options for configuring propagation of object deletions from a remote cluster to this cluster.

Field Summary

static int	DEFAULT_CLEANUP_INTERVAL
static int	DEFAULT_MAX_CUIDS_RETURNED
static int	RETURN_ALL_CUIDS

Method Summary

int	getCleanupInterval() Returns how often object deletions should be replicated from this remote cluster.
java.util.Date	getLastCleanupTime() For internal use only.
int	getMaxCUIDsReturned() Returns the maximum number of object CUIDs to include in each replication where object cleanup is enabled.
java.lang.String	getNextStartCUID() For internal use only.
void	setCleanupInterval(int hours) Sets how often object deletions should be replicated from this remote cluster.
void	setLastCleanupTime(java.util.Date ts) For internal use only.
void	setMaxCUIDsReturned(int num) Sets the maximum number of object CUIDs to include in each replication where object cleanup is enabled.
void	setNextStartCUID(java.lang.String cuid) For internal use only.

Field Detail

RETURN_ALL_CUIDS

static final int RETURN_ALL_CUIDS

See Also:

Constant Field Values

DEFAULT_CLEANUP_INTERVAL

static final int DEFAULT_CLEANUP_INTERVAL

See Also:

Constant Field Values

DEFAULT_MAX_CUIDS_RETURNED

static final int DEFAULT_MAX_CUIDS_RETURNED

See Also:

Constant Field Values

Method Detail

setMaxCUIDsReturned

void setMaxCUIDsReturned(int num)

Sets the maximum number of object CUIDs to include in each replication where object cleanup is enabled.

A very large value will affect replication job processing time and (to a lesser degree) bandwidth, but object deletions on the remote cluster will be propagated sooner.

Parameters:

num - the maximum number of object CUIDs to return with each cleanup replication

getMaxCUIDsReturned

int getMaxCUIDsReturned()
                        throws SDKException

Returns the maximum number of object CUIDs to include in each replication where object cleanup is enabled.

A very large value will affect replication job processing time and (to a lesser degree) bandwidth, but object deletions on the remote cluster will be propagated sooner.

Returns:

the maximum number of object CUIDs to return with each cleanup replication

Throws:

SDKException - if this value has not been set

setNextStartCUID

void setNextStartCUID(java.lang.String cuid)

For internal use only.

getNextStartCUID

java.lang.String getNextStartCUID()
                                  throws SDKException

For internal use only.

Throws:

SDKException

setLastCleanupTime

void setLastCleanupTime(java.util.Date ts)

For internal use only.

getLastCleanupTime

java.util.Date getLastCleanupTime()
                                  throws SDKException

For internal use only.

Throws:

SDKException

setCleanupInterval

void setCleanupInterval(int hours)

Sets how often object deletions should be replicated from this remote cluster. The real cleanup interval will be at least this long, and may be longer depending on when replication jobs are scheduled.

Parameters:

hours - the cleanup interval in hours

getCleanupInterval

int getCleanupInterval()
                       throws SDKException

Returns how often object deletions should be replicated from this remote cluster. The real cleanup interval will be at least this long, and may be longer depending on when replication jobs are scheduled.

Returns:

the cleanup interval in hours

Throws:

SDKException - if this value has not been set