com.businessobjects.sdk.biar
Interface ICommonOptions

All Known Subinterfaces:

IExportOptions, IImportOptions

public interface ICommonOptions

This interface represents the set of BIAR options that are common to both export and import operations.

Method Summary

java.lang.String	getBIARPassword() Gets the password that will be used to encrypt/decrypt the BIAR file contents.
boolean	isIncludeSecurity() Returns the value of the "Include security" option.
ICommonOptions	setBIARPassword(java.lang.String password) Sets the password that will be used to encrypt/decrypt the BIAR file contents.
ICommonOptions	setFrom(ICommonOptions options) Copies the values from the specified set of options into this object.
ICommonOptions	setIncludeSecurity(boolean includeSecurity) Sets the value of the "Include security" option.

Method Detail

getBIARPassword

java.lang.String getBIARPassword()

Gets the password that will be used to encrypt/decrypt the BIAR file contents. Uses AES 256 encryption.

Returns:

The BIAR file's password or null if no password is set.

isIncludeSecurity

boolean isIncludeSecurity()

Returns the value of the "Include security" option.

Returns:

true if the "Include security" option is enabled.

See Also:

ICommonOptions.setIncludeSecurity(boolean)

setIncludeSecurity

ICommonOptions setIncludeSecurity(boolean includeSecurity)

Sets the value of the "Include security" option. If set to true, then object security information is included during the import or export operation.

If set to false during export, security information is not included in the archive and cannot be reconstructed from the archive when the objects are imported. If set to false during import, then all security information included in the archive is ignored.

Parameters:

includeSecurity - the value for the "Include security" option

Returns:

This instance.

setFrom

ICommonOptions setFrom(ICommonOptions options)

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

Parameters:

options - the object that contains the options to be copied

Returns:

This instance.

setBIARPassword

ICommonOptions setBIARPassword(java.lang.String password)

Sets the password that will be used to encrypt/decrypt the BIAR file contents. The password cannot be an empty string. If it is an empty string it is treated the same as null. If the password is null, then the BIAR password is removed.

Parameters:

password - The password that will be used for the BIAR file.