com.businessobjects.sdk.lcm

Class ScenarioOptions

java.lang.Object

com.businessobjects.sdk.lcm.ScenarioOptions

public class ScenarioOptions
extends Object

Scenario options

See Also:

package description

Method Summary

Modifier and Type	Method and Description
static ScenarioOptions	defaults() Returns options default values.
ScenarioOptions	enableRollback(boolean enableRollback) Sets rollback option.
ScenarioOptions	includeApplicationSecurity(boolean includeApplicationSecurity) Sets application security option.
ScenarioOptions	includeComments(boolean includeComments) Sets comment option.
ScenarioOptions	includeFederationJobsRelationship(boolean includeFederationJobsRelationship) Sets option to keep federation jobs relationship into imported objects.
ScenarioOptions	includeSecurity(boolean includeSecurity) Sets general security option.
ScenarioOptions	includeTopLevelSecurity(boolean includeTopLevelSecurity) Sets top level security option.
ScenarioOptions	includeUserSecurity(boolean includeUserSecurity) Sets user security option.
ScenarioOptions	setRenamePattern(String renamePattern) Sets rename pattern option used to commit homonymous objects.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

defaults

public static ScenarioOptions defaults()

Returns options default values.

Returns:

a new default option instance

enableRollback

public ScenarioOptions enableRollback(boolean enableRollback)

Sets rollback option.

Rollback only applies to scenario created in scheduled workflow.

Parameters:

enableRollback - rollback flag

Returns:

current options

includeComments

public ScenarioOptions includeComments(boolean includeComments)

Sets comment option.

Parameters:

includeComments - comment flag

Returns:

current options

includeSecurity

public ScenarioOptions includeSecurity(boolean includeSecurity)

Sets general security option.

Parameters:

includeSecurity - security flag

Returns:

current options

includeUserSecurity

public ScenarioOptions includeUserSecurity(boolean includeUserSecurity)

Sets user security option.

Option is used only if general security is enabled.

Parameters:

includeUserSecurity - security flag

Returns:

current options

includeTopLevelSecurity

public ScenarioOptions includeTopLevelSecurity(boolean includeTopLevelSecurity)

Sets top level security option.

Option is used only if general security is enabled.

Parameters:

includeTopLevelSecurity - security flag

Returns:

current options

includeApplicationSecurity

public ScenarioOptions includeApplicationSecurity(boolean includeApplicationSecurity)

Sets application security option.

Option is used only if general security is enabled.

Parameters:

includeApplicationSecurity - security flag

Returns:

current options

includeFederationJobsRelationship

public ScenarioOptions includeFederationJobsRelationship(boolean includeFederationJobsRelationship)

Sets option to keep federation jobs relationship into imported objects.

Option is used only with promote and import scenarios.

Parameters:

includeFederationJobsRelationship - federation jobs relationship flag

Returns:

current options

setRenamePattern

public ScenarioOptions setRenamePattern(String renamePattern)

Sets rename pattern option used to commit homonymous objects.

Parameters:

renamePattern - rename pattern

Returns:

current options