com.businessobjects.sdk.plugin.desktop.replication
Interface IReplicationBase

All Known Subinterfaces:

IReplication

public interface IReplicationBase

This interface represents a replication job. A replication job is a schedulable object that contains configuration settings for replicating a set of info objects between this cluster and a remote cluster.

See Also:

IRemoteCluster

Nested Class Summary

static interface	IReplicationBase.CeApplicationRefreshMode Contains options that determine whether the entire contents of the chosen applications will be refreshed.
static interface	IReplicationBase.CeConflictResolutionMode Contains constants that are used to specify how to handle replication conflicts.

Field Summary

static java.lang.String	KIND
static java.lang.String	PROGID

Method Summary

void	enableCleanup(boolean enabled) Indicate whether object cleanup (propagating deletions to this cluster) is enabled, starting with the next replication.
int	getApplicationRefreshMode() Gets the application refresh mode.
int	getConflictResolutionMode() Returns the conflict resolution mode.
int	getMaxCUIDsReturned() Get the max object CUIDs returned for cleanup at the next replication
java.lang.String	getNextStartCUID() Get the start CUID for cleanup at the next replication
java.util.Collection	getRefreshApplicationObjects() Returns the CUID collection of applications to refresh.
java.lang.String	getRemoteManifest() Sets the CUID of the manifest (defined on the remote cluster) that determines what content will be replicated.
boolean	getReplicateDocumentTemplates() Returns whether document templates will be replicated.
boolean	getReplicateLocalInstances() Returns whether locally run completed instances will be replicated.
boolean	getReplicateRemoteSchedules() Returns whether remote schedules will be replicated.
java.lang.String	getResultMIMEType() Returns the MIME type for the result data.
boolean	isCleanupEnabled() Indicate whether object cleanup (propagating deletions to this cluster) is enabled, starting with the next replication.
boolean	isPushEnabled() Returns whether two-way replication and remote scheduling are enabled.
void	setApplicationRefreshMode(int mode) set the application refresh mode
void	setConflictResolutionMode(int mode) Sets the conflict resolution mode.
void	setPushEnabled(boolean enable) Sets whether two-way replication and remote scheduling are enabled.
void	setRemoteManifest(java.lang.String cuid) Sets the CUID of the manifest (defined on the remote cluster).
void	setReplicateDocumentTemplates(boolean include) Sets whether document templates will be replicated.
void	setReplicateLocalInstances(boolean include) Sets whether locally run completed instances will be replicated.
void	setReplicateRemoteSchedules(boolean include) Sets whether remote schedules will be replicated.
void	writeResult(java.io.OutputStream stream) Writes the result to the specific OutputStream.

Field Detail

KIND

static final java.lang.String KIND

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

See Also:

Constant Field Values

Method Detail

setConflictResolutionMode

void setConflictResolutionMode(int mode)
                               throws SDKException

Sets the conflict resolution mode.

Parameters:

mode - the conflict resolution mode. Must be a value from CeConflictResolutionMode.

Throws:

SDKException - if the value is not one of the options from CeConflictResolutionMode.

getConflictResolutionMode

int getConflictResolutionMode()

Returns the conflict resolution mode. See CeConflictResolutionMode.

Returns:

the conflict resolution mode

InfoObject properties to query for:

SI_PROCESSINFO.SI_CONFLICT_RESOLUTION_MODE

setRemoteManifest

void setRemoteManifest(java.lang.String cuid)

Sets the CUID of the manifest (defined on the remote cluster). that determines what content will be replicated.

Parameters:

cuid - the CUID of the manifest. No validation is done until replication time.

See Also:

IManifest

getRemoteManifest

java.lang.String getRemoteManifest()

Sets the CUID of the manifest (defined on the remote cluster) that determines what content will be replicated.

Returns:

the CUID of the manifest, or null if the property has not been set.

See Also:

IManifest

InfoObject properties to query for:

SI_PROCESSINFO.SI_REMOTE_MANIFEST

setPushEnabled

void setPushEnabled(boolean enable)

Sets whether two-way replication and remote scheduling are enabled.

Parameters:

enable - true to enable two-way replication and remote scheduling, false to disable both

isPushEnabled

boolean isPushEnabled()

Returns whether two-way replication and remote scheduling are enabled.

Returns:

true if two-way replication and remote scheduling are enabled, false otherwise.

InfoObject properties to query for:

SI_PROCESSINFO.SI_PUSH_ENABLED

isCleanupEnabled

boolean isCleanupEnabled()
                         throws SDKException

Indicate whether object cleanup (propagating deletions to this cluster) is enabled, starting with the next replication.

Returns:

true if yes, otherwise false.

Throws:

SDKException

InfoObject properties to query for:

SI_PROCESSINFO.SI_ENABLED

enableCleanup

void enableCleanup(boolean enabled)

Indicate whether object cleanup (propagating deletions to this cluster) is enabled, starting with the next replication.

Parameters:

enabled -

getMaxCUIDsReturned

int getMaxCUIDsReturned()
                        throws SDKException

Get the max object CUIDs returned for cleanup at the next replication

Returns:

int maxinum number of CUIDs will be returned to slave at the next replication

Throws:

SDKException

InfoObject properties to query for:

SI_PROCESSINFO.SI_CLEANUP_OPTIONS

getNextStartCUID

java.lang.String getNextStartCUID()
                                  throws SDKException

Get the start CUID for cleanup at the next replication

Returns:

a CUID

Throws:

SDKException

InfoObject properties to query for:

SI_PROCESSINFO.SI_CLEANUP_OPTIONS

getRefreshApplicationObjects

java.util.Collection getRefreshApplicationObjects()

Returns the CUID collection of applications to refresh. Only these applications will be refreshed.

Returns:

a collection of application CUIDs that should be refreshed

InfoObject properties to query for:

SI_PROCESSINFO.SI_REFRESH_APP_OBJECTS

getApplicationRefreshMode

int getApplicationRefreshMode()

Gets the application refresh mode. By default the refresh mode is CeApplicationRefreshMode.OFF.

Returns:

int to indicate the refresh mode, refer to IReplicationBase.CeApplicationRefreshMode.

InfoObject properties to query for:

SI_PROCESSINFO.SI_APP_REFRESH_MODE

setApplicationRefreshMode

void setApplicationRefreshMode(int mode)
                               throws SDKException

set the application refresh mode

Parameters:

mode - of CeApplicationRefreshMode value, refer to IReplicationBase.CeApplicationRefreshMode.

Throws:

SDKException

setReplicateRemoteSchedules

void setReplicateRemoteSchedules(boolean include)

Sets whether remote schedules will be replicated. Default is true.

Parameters:

include - true to replicate remote schedules

getReplicateRemoteSchedules

boolean getReplicateRemoteSchedules()

Returns whether remote schedules will be replicated.

Returns:

true if remote schedules will be replicated

InfoObject properties to query for:

SI_PROCESSINFO.SI_REPLICATE_REMOTESCHEDULES

setReplicateDocumentTemplates

void setReplicateDocumentTemplates(boolean include)

Sets whether document templates will be replicated. Default value is true.

Parameters:

include - true to replicate document templates

getReplicateDocumentTemplates

boolean getReplicateDocumentTemplates()

Returns whether document templates will be replicated. Default value is true.

Returns:

true if document templates will be replicated

InfoObject properties to query for:

SI_PROCESSINFO.SI_REPLICATE_DOCUMENTTEMPLATES

setReplicateLocalInstances

void setReplicateLocalInstances(boolean include)

Sets whether locally run completed instances will be replicated. Default value is true.

Parameters:

include - true to replicate locally run completed instances

getReplicateLocalInstances

boolean getReplicateLocalInstances()

Returns whether locally run completed instances will be replicated. Default value is true.

Returns:

true if locally run completed instances will be replicated

InfoObject properties to query for:

SI_PROCESSINFO.SI_REPLICATE_DOCUMENTTEMPLATES

getResultMIMEType

java.lang.String getResultMIMEType()

Returns the MIME type for the result data.

InfoObject properties to query for:

SI_FILES

writeResult

void writeResult(java.io.OutputStream stream)
                 throws SDKException

Writes the result to the specific OutputStream.

Parameters:

stream - An OutputStream stream object.

Throws:

SDKException - This is thrown if the process is unsuccessful

InfoObject properties to query for:

SI_FILES