com.tsgrp.opencontent.dctm.lifecycle

Class DCTMLifecycleImpl

java.lang.Object

com.tsgrp.opencontent.core.lifecycle.AbstractLifecycleImpl

com.tsgrp.opencontent.dctm.lifecycle.DCTMLifecycleImpl

All Implemented Interfaces:

ILifecycle

public class DCTMLifecycleImpl
extends AbstractLifecycleImpl
implements ILifecycle

Service methods to check and manage lifcycle states of sysobjects.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DCTMLifecycleImpl()

Method Summary

Modifier and Type	Method and Description
LifecycleResult	attachLifecycleById(java.lang.String ticket, java.lang.String objectId, java.lang.String lifecycleId, java.lang.String state) Attach the lifecycle identified by the given id to the object.
LifecycleResult	attachLifecycleByName(java.lang.String ticket, java.lang.String objectId, java.lang.String lifecycleName, java.lang.String state) Attach the lifecycle identified by the given name to the object.
boolean	demote(java.lang.String ticket, java.lang.String objectId, java.lang.String stateName, boolean demoteToBase) Demote a single object to the specified state.
LifecycleResult	detachLifecycle(java.lang.String ticket, java.lang.String objectId) Detach a lifecycle from the object.
java.lang.String	getCurrentState(java.lang.String ticket, java.lang.String objectId) Check the current lifecycle state of a given sysobject.
LifecycleState[]	getStates(java.lang.String ticket, java.lang.String lifecycleName) Returns the states for the given lifecycle.
boolean	promote(java.lang.String ticket, java.lang.String objectId, java.lang.String stateName) Promote a single object to the specified state.
LifecycleResult	resume(java.lang.String ticket, java.lang.String objectId, java.lang.String state, boolean resumeBaseState) Resume a single object from the specified state.
LifecycleResult	suspend(java.lang.String ticket, java.lang.String objectId, java.lang.String state) Note - the state name does not matter in documentum.

Methods inherited from class com.tsgrp.opencontent.core.lifecycle.AbstractLifecycleImpl

getAllLifecycleDefinitions, getConfiguredLifecycleStateRepoNameForObjectId, getLifecycleDefinition, getOcConfiguredLifecycleStateRepoNameForObjectType, getOcLifecycleDefinition

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tsgrp.opencontent.core.lifecycle.ILifecycle

getAllLifecycleDefinitions, getLifecycleDefinition, getOcLifecycleDefinition

Constructor Detail

DCTMLifecycleImpl

protected DCTMLifecycleImpl()

Method Detail

getStates

public LifecycleState[] getStates(java.lang.String ticket,
                                  java.lang.String lifecycleName)

Description copied from interface: ILifecycle

Returns the states for the given lifecycle.

Specified by:

getStates in interface ILifecycle

Parameters:

ticket - a valid authentication ticket

lifecycleName - the name of the lifecycle policy

Returns:

list of LifecycleState objects

promote

public boolean promote(java.lang.String ticket,
                       java.lang.String objectId,
                       java.lang.String stateName)

Promote a single object to the specified state.

Specified by:

promote in interface ILifecycle

Parameters:

ticket - a valid authentication ticket

objectId - the object ID of the sysobject to promote

statename - the state to promote the object to

Returns:

whether the promotion was successful

demote

public boolean demote(java.lang.String ticket,
                      java.lang.String objectId,
                      java.lang.String stateName,
                      boolean demoteToBase)

Demote a single object to the specified state. Performs this by getting the previous state name in the lifecycle, then demotes, and repeats until at the target state. UNLESS demoteToBase is set to true, in which case, the supplied stateName parameter is assumed to be the base state and is passed through directly to the dfc demote call.

Specified by:

demote in interface ILifecycle

Parameters:

ticket - a valid authentication ticket

objectId - the object ID of the sysobject to demote

statename - the state to demote the object to

Returns:

whether the demotion was successful

getCurrentState

public java.lang.String getCurrentState(java.lang.String ticket,
                                        java.lang.String objectId)

Check the current lifecycle state of a given sysobject.

Specified by:

getCurrentState in interface ILifecycle

Parameters:

ticket - a valid authentication ticket

objectId - the object ID of the sysobject to check state

Returns:

the current state of the object

attachLifecycleById

public LifecycleResult attachLifecycleById(java.lang.String ticket,
                                           java.lang.String objectId,
                                           java.lang.String lifecycleId,
                                           java.lang.String state)

Description copied from interface: ILifecycle

Attach the lifecycle identified by the given id to the object.

Specified by:

attachLifecycleById in interface ILifecycle

Parameters:

ticket - a valid authentication ticket

objectId - object id the lifecycle is to be attached to

lifecycleId - id of the lifecycle to attach

state - initial state name/state position of the lifecycle (if null, default to position 0)

Returns:

• LifecycleResult
• error returns false if life cycle is successfully attached, otherwise true

See Also:

ILifecycle.attachLifecycleById(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

attachLifecycleByName

public LifecycleResult attachLifecycleByName(java.lang.String ticket,
                                             java.lang.String objectId,
                                             java.lang.String lifecycleName,
                                             java.lang.String state)

Description copied from interface: ILifecycle

Attach the lifecycle identified by the given name to the object.

Specified by:

attachLifecycleByName in interface ILifecycle

Parameters:

ticket - a valid authentication ticket

objectId - object id the lifecycle is to be attached to

lifecycleName - name of the lifecycle to attach

state - initial state name/state position of the lifecycle (if null, default to position 0)

Returns:

• LifecycleResult
• error returns false if life cycle is successfully attached, otherwise true

See Also:

ILifecycle.attachLifecycleByName(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

detachLifecycle

public LifecycleResult detachLifecycle(java.lang.String ticket,
                                       java.lang.String objectId)

Description copied from interface: ILifecycle

Detach a lifecycle from the object.

Specified by:

detachLifecycle in interface ILifecycle

Parameters:

ticket - a valid authentication ticket

objectId - object id to detach the a lifecycle from

Returns:

• LifecycleResult
• error returns false if life cycle is successfully detached, otherwise true

See Also:

ILifecycle.detachLifecycle(java.lang.String, java.lang.String)

resume

public LifecycleResult resume(java.lang.String ticket,
                              java.lang.String objectId,
                              java.lang.String state,
                              boolean resumeBaseState)

Description copied from interface: ILifecycle

Resume a single object from the specified state.

Specified by:

resume in interface ILifecycle

Parameters:

ticket - a valid authentication ticket

objectId - the object ID of the object to resume

state - the state to resume from

resumeBaseState - True to resume base state, false otherwise.

Returns:

• LifecycleResult
• error returns true if method failed, otherwise false

See Also:

ILifecycle.resume(java.lang.String, java.lang.String, java.lang.String, boolean)

suspend

public LifecycleResult suspend(java.lang.String ticket,
                               java.lang.String objectId,
                               java.lang.String state)

Note - the state name does not matter in documentum. Documentum lifecycles can only suspend to one state. This method ignores the state name.

Specified by:

suspend in interface ILifecycle

Parameters:

ticket - a valid authentication ticket

objectId - the object ID of the object to suspend

state - the state to suspend

Returns:

• LifecycleResult
• error returns true if method failed, otherwise false

See Also:

ILifecycle.suspend(java.lang.String, java.lang.String, java.lang.String)