com.businessobjects.sdk.biar
Interface IImportOptions

All Superinterfaces:

java.lang.Cloneable, ICommonOptions

public interface IImportOptions
extends ICommonOptions, java.lang.Cloneable

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

Nested Class Summary

static class	IImportOptions.OrphanHandling This enum defines constants for the different ways BIAR may handle orphaned InfoObjects during import.
static class	IImportOptions.SecurityImportMode This enum defines constants for how BIAR may import InfoObjects security.

Method Summary

java.lang.Object	clone()
IImportCallback	getCallback() Returns the import callback object.
IImportOptions.OrphanHandling	getOrphanHandling() Returns how BIAR will handle orphaned InfoObjects.
IImportOptions.SecurityImportMode	getSecurityImportMode()
boolean	isFailUnresolvedCUIDs() Returns the value of the "Fail unresolved IDs" option.
boolean	isIncludeSecurity() Deprecated. Use IImportOptions.getSecurityImportMode() instead.
boolean	isTwoStepImport() Returns the value of the "Two step import" option.
IImportOptions	setCallback(IImportCallback cb) Sets a callback to be asynchronously notified of certain events during the import process.
IImportOptions	setFailUnresolvedCUIDs(boolean failUnresolvedCUIDs) Sets the value of the "Fail unresolved CUIDs" option.
IImportOptions	setFrom(IImportOptions opts) Copies the values from the specified set of options into this object.
IImportOptions	setOrphanHandling(IImportOptions.OrphanHandling orphanHandling) Sets how BIAR will handle orphaned InfoObjects.
IImportOptions	setSecurityImportMode(IImportOptions.SecurityImportMode securityImportMode) Sets how BIAR will import security, depends on whether the object already exists on the CMS.
IImportOptions	setTwoStepImport(boolean twoStepImport) Sets the value of the "Two step import" option.

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

getBIARPassword, setBIARPassword, setFrom, setIncludeSecurity

Method Detail

clone

java.lang.Object clone()

getCallback

IImportCallback getCallback()

Returns the import callback object.

Returns:

The import callback object.

See Also:

IImportOptions.setCallback(IImportCallback)

getOrphanHandling

IImportOptions.OrphanHandling getOrphanHandling()

Returns how BIAR will handle orphaned InfoObjects.

Returns:

The OrphanHandling enum

See Also:

IImportOptions.OrphanHandling

isFailUnresolvedCUIDs

boolean isFailUnresolvedCUIDs()

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

Returns:

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

See Also:

#setFailUnresolvedIDs(boolean)

isTwoStepImport

boolean isTwoStepImport()

Returns the value of the "Two step import" option.

Returns:

true if the "Two step import" option is enabled.

See Also:

IImportOptions.setTwoStepImport(boolean)

isIncludeSecurity

@Deprecated
boolean isIncludeSecurity()

Deprecated. Use IImportOptions.getSecurityImportMode() instead.

Description copied from interface: ICommonOptions

Returns the value of the "Include security" option.

Specified by:

isIncludeSecurity in interface ICommonOptions

Returns:

true if the "Include security" option is enabled.

See Also:

ICommonOptions.setIncludeSecurity(boolean)

getSecurityImportMode

IImportOptions.SecurityImportMode getSecurityImportMode()

Returns:

the security import behavior, depends on whether the object already exists on the CMS.

setCallback

IImportOptions setCallback(IImportCallback cb)

Sets a callback to be asynchronously notified of certain events during the import process.

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

Parameters:

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

Returns:

This instance.

setFailUnresolvedCUIDs

IImportOptions setFailUnresolvedCUIDs(boolean failUnresolvedCUIDs)

Sets the value of the "Fail unresolved CUIDs" option. If set to true, an exception is thrown when an exported object contains a reference to an object that cannot be found in the source archive or in the destination system. This can also occur if the referenced object cannot be accessed due to security restrictions on the object.

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

Parameters:

failUnresolvedCUIDs - the value for the "Fail unresolved CUIDs" option

Returns:

This instance.

setTwoStepImport

IImportOptions setTwoStepImport(boolean twoStepImport)

Sets the value of the "Two step import" option. If set to true, all files are imported in a separate step from the objects. This can result in performance improvements in applications that do not require associated files to be imported.

Parameters:

twoStepImport - the value for the "Two step import" option

Returns:

This instance.

See Also:

IObjectManager.importFiles()

setFrom

IImportOptions setFrom(IImportOptions 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.

setOrphanHandling

IImportOptions setOrphanHandling(IImportOptions.OrphanHandling orphanHandling)

Sets how BIAR will handle orphaned InfoObjects.

Returns:

The OrphanHandling enum

See Also:

IImportOptions.OrphanHandling

setSecurityImportMode

IImportOptions setSecurityImportMode(IImportOptions.SecurityImportMode securityImportMode)

Sets how BIAR will import security, depends on whether the object already exists on the CMS.