com.tsgrp.opencontent.solr.lifecycle

Class SolrLifecycleImpl

java.lang.Object

com.tsgrp.opencontent.core.lifecycle.AbstractLifecycleImpl

com.tsgrp.opencontent.solr.lifecycle.SolrLifecycleImpl

All Implemented Interfaces:

ILifecycle

public class SolrLifecycleImpl
extends AbstractLifecycleImpl

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SolrLifecycleImpl()

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 repository lifecycle state of a given object.
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.

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

Constructor Detail

SolrLifecycleImpl

protected SolrLifecycleImpl()

Method Detail

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.

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

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

Description copied from interface: ILifecycle

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

demote

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

Description copied from interface: ILifecycle

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.

See Also:

com.tsgrp.opencontent.core.lifecycle.ILifecycle#demote(java.lang.String, java.lang.String, java.lang.String)

getCurrentState

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

Description copied from interface: ILifecycle

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

See Also:

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

promote

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

Description copied from interface: ILifecycle

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.

See Also:

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

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.

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.

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.

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)

getStates

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

Description copied from interface: ILifecycle

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