com.tsgrp.opencontent.core.lifecycle

Interface ILifecycle

All Known Implementing Classes:

AbstractLifecycleImpl, AlfrescoEmbLifecycleImpl, DCTMLifecycleImpl, DynamoLifecycleImpl, ElasticsearchLifecycleImpl, HBaseLifecycleImpl, S3LifecycleImpl, SolrLifecycleImpl

public interface ILifecycle

Interface methods to check and manage objects' lifecycle states.

Copyright © Technology Services Group, Inc.

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.util.Map<java.lang.String,LifecycleDefinition>	getAllLifecycleDefinitions() This method returns all LifecycleDefinitions contained in the InstalledLifecycles Returns null if the map does not exist.
java.lang.String	getCurrentState(java.lang.String ticket, java.lang.String objectId) Check the current repository lifecycle state of a given object.
LifecycleDefinition	getLifecycleDefinition(java.lang.String name) This method returns the LifecycleDefinition object specified by name.
LifecycleDefinition	getOcLifecycleDefinition(java.lang.String name, java.lang.String objectType)
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) Suspend a single object.

Method Detail

getStates

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

Returns the states for the given lifecycle.

Parameters:

ticket - a valid authentication ticket

lifecycleName - the name of the lifecycle policy

Returns:

list of LifecycleState objects

resume

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

Resume a single object from the specified state.

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

suspend

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

Suspend a single object.

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

promote

boolean promote(java.lang.String ticket,
                java.lang.String objectId,
                java.lang.String statename)

Promote a single object to the specified state.

Parameters:

ticket - a valid authentication ticket

objectId - the object ID of the object to promote

statename - the state to promote the object to

Returns:

true if the promotion was successful, otherwise false.

demote

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

Demote a single object to the specified state. See impl specific comments for any confusion regarding impl specific behavior.

Parameters:

ticket - a valid authentication ticket

objectId - the object ID of the object to demote

statename - the state to demote the object to

demoteToBase - boolean to indicate whether to demote to base or not

Returns:

true if the demotion was successful, otherwise false.

getCurrentState

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

Check the current repository lifecycle state of a given object. e.g. alfresco the qname {} and in documentum the lifecycle state name.

Parameters:

ticket - a valid authentication ticket

objectId - the object ID of the object to check state

Returns:

the current state of the object or null if there is no lifecycle

attachLifecycleById

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.

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

attachLifecycleByName

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.

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

detachLifecycle

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

Detach a lifecycle from the object.

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

getLifecycleDefinition

LifecycleDefinition getLifecycleDefinition(java.lang.String name)

This method returns the LifecycleDefinition object specified by name. If the specified LifecycleDefinition does not exist, the method returns null.

Parameters:

name - - name of an installed wizard lifecycle

Returns:

LifecycleDefinition specified by name, or null if it does not exist.

getOcLifecycleDefinition

LifecycleDefinition getOcLifecycleDefinition(java.lang.String name,
                                             java.lang.String objectType)

getAllLifecycleDefinitions

java.util.Map<java.lang.String,LifecycleDefinition> getAllLifecycleDefinitions()

This method returns all LifecycleDefinitions contained in the InstalledLifecycles Returns null if the map does not exist.

Returns:

Map or null if InstalledLifecycles doesn't exist