com.businessobjects.sdk.biar
Interface IExportOptions

All Superinterfaces:

java.lang.Cloneable, ICommonOptions

public interface IExportOptions
extends ICommonOptions, java.lang.Cloneable

This interface represents the set of options that are applied during a BIAR export operation. To create an instance, use BIARFactory.createExportOptions().

Method Summary

java.lang.Object	clone()
IExportCallback	getCallback() Returns the export callback object.
boolean	isFailUnresolvedIDs() Returns the value of the "Fail unresolved IDs" option.
boolean	isIncludeDependencies() Returns the value of the "Include dependencies" option.
IExportOptions	setCallback(IExportCallback cb) Specifies an object containing callbacks to be invoked when certain events occur during the export process.
IExportOptions	setFailUnresolvedIDs(boolean failUnresolvedIDs) Sets the value of the "Fail unresolved IDs" option.
IExportOptions	setFrom(IExportOptions opts) Copies the values from the specified set of options into this object.
IExportOptions	setIncludeDependencies(boolean includeDependencies) Sets the value of the "Include dependencies" option.

Methods inherited from interface com.businessobjects.sdk.biar.ICommonOptions

getBIARPassword, isIncludeSecurity, setBIARPassword, setFrom, setIncludeSecurity

Method Detail

clone

java.lang.Object clone()

getCallback

IExportCallback getCallback()

Returns the export callback object.

Returns:

The export callback object.

See Also:

IExportOptions.setCallback(IExportCallback)

isFailUnresolvedIDs

boolean isFailUnresolvedIDs()

Returns the value of the "Fail unresolved IDs" option.

Returns:

true if the "Fail unresolved IDs" option is enabled.

See Also:

IExportOptions.setFailUnresolvedIDs(boolean)

isIncludeDependencies

boolean isIncludeDependencies()

Returns the value of the "Include dependencies" option.

Returns:

true if the "Include dependencies" option is enabled.

See Also:

IExportOptions.setIncludeDependencies(boolean)

setCallback

IExportOptions setCallback(IExportCallback cb)

Specifies an object containing callbacks to be invoked when certain events occur during the export process. If a callback object is set, recoverable exceptions are handled by the callback method implementations instead of being thrown.

Note that callbacks are invoked asynchronously and do not block execution of the export.

Parameters:

cb - the object containing the callback methods to invoke when events occur during the export process

Returns:

This instance.

setFailUnresolvedIDs

IExportOptions setFailUnresolvedIDs(boolean failUnresolvedIDs)

Sets the value of the "Fail unresolved IDs" option. If set to true, an exception is thrown when an exported object contains a reference to an object that either cannot be found in the source system or cannot be exported due to security restrictions on the object.

If this option is disabled, properties that contain references to unresolved IDs are removed and the export process continues.

Parameters:

failUnresolvedIDs - the value for the "Fail unresolved IDs" option

Returns:

This instance.

setIncludeDependencies

IExportOptions setIncludeDependencies(boolean includeDependencies)

Sets the value of the "Include dependencies" option. If set to true, all objects related to the exported objects are exported.

Note that object relations are resolved recursively, which can cause the archive file to be quite large.

Parameters:

includeDependencies - the value for the "include dependencies" option

Returns:

This instance.

setFrom

IExportOptions setFrom(IExportOptions opts)

Copies the values from the specified set of options into this object.

Parameters:

opts - the object that contains the options to be copied

Returns:

This instance.