com.tsgrp.opencontent.wizard.workflow

Class Wizard2WorkflowImpl

java.lang.Object

com.tsgrp.opencontent.wizard.workflow.Wizard2WorkflowImpl

All Implemented Interfaces:

IWizard2Workflow

Direct Known Subclasses:

AlfrescoWizard2WorkflowImpl

public class Wizard2WorkflowImpl
extends java.lang.Object
implements IWizard2Workflow

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Wizard2WorkflowImpl()

Method Summary

Modifier and Type	Method and Description
boolean	cancelForm(java.lang.String ticket, java.lang.String formId, java.lang.String comments) Cancel the form
java.lang.String	checkinActivities(java.lang.String ticket, java.lang.String pageSetName, javax.activation.DataHandler objectContent) Deprecated.
java.lang.String	checkinRole(java.lang.String ticket, java.lang.String oldRoleName, java.lang.String newRoleName, java.lang.String roleOwner, java.lang.String[] page_sets, java.lang.String[] users, java.lang.String[] groups, javax.activation.DataHandler objectContent) Checks in a role, updating its content and other attributes.
Wizard2AdminResult	createActivities(java.lang.String ticket, java.lang.String pageSetName, javax.activation.DataHandler content) Creates an activities object for the specified pageset with the passed in content
void	createOrUpdateWorkflowDefinition(java.lang.String psiName, java.lang.String objectId, java.lang.String stringifiedWorkflow, java.lang.String ticket) Util function for creating a Workflow Definition repo object and attaching it to a Page Set Instance
Wizard2AdminResult	createRole(java.lang.String ticket, WizardRole role, java.lang.String pageSetName, javax.activation.DataHandler content) Creates a role object.
WizardActivitiesDefinition	getActivities(java.lang.String ticket, PageSetDefinition psDef) Return the activities object for the given page set definition
java.lang.String[]	getAllRoleNames(java.lang.String ticket) Return the role names currently in the system.
WizardRole	getRole(java.lang.String ticket, java.lang.String roleName) Return the role object specified by the role name.
WizardRole[]	getRoles(java.lang.String ticket, PageSetDefinition psDef) Return the roles associated with the given page set definition.
Wizard2AdminResult	getRolesByPageSet(java.lang.String ticket, java.lang.String pageSetName) Deprecated.
boolean	hasWorkflowDefinition(java.lang.String objectId, java.lang.String ticket) Util method for figuring out if a page set instance has an accompanying workflow definition
void	removeWorkflowDefinition(java.lang.String psiName, java.lang.String objectId, java.lang.String ticket) Util function for removing a workflow definition from its Page Set Instance repo object

Methods inherited from class java.lang.Object

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

Constructor Detail

Wizard2WorkflowImpl

protected Wizard2WorkflowImpl()

Method Detail

getRole

public WizardRole getRole(java.lang.String ticket,
                          java.lang.String roleName)

Description copied from interface: IWizard2Workflow

Return the role object specified by the role name. If the role is not found, this method returns null

Specified by:

getRole in interface IWizard2Workflow

Parameters:

ticket - authentication ticket

roleName - the role to return

Returns:

the WizardRole, or null if the role is not found

getAllRoleNames

public java.lang.String[] getAllRoleNames(java.lang.String ticket)

Description copied from interface: IWizard2Workflow

Return the role names currently in the system. This method can be removed if/when we remove the restriction that roles must have unique names in the system.

Specified by:

getAllRoleNames in interface IWizard2Workflow

Parameters:

ticket - authentication ticket

Returns:

a String[] of the list of role names in the system

createRole

public Wizard2AdminResult createRole(java.lang.String ticket,
                                     WizardRole role,
                                     java.lang.String pageSetName,
                                     javax.activation.DataHandler content)

Description copied from interface: IWizard2Workflow

Creates a role object. Note that setting the priority on the given role to -1 will direct this method to set the priority to 1 + the existing max priority

Specified by:

createRole in interface IWizard2Workflow

Parameters:

ticket - authentication ticket

role - the role

pageSetName - the page set name

content - DataHandler holding the content of the new role being created

Returns:

Wizard2AdminResult with a contentResult holding the new object

createActivities

public Wizard2AdminResult createActivities(java.lang.String ticket,
                                           java.lang.String pageSetName,
                                           javax.activation.DataHandler content)

Creates an activities object for the specified pageset with the passed in content

Specified by:

createActivities in interface IWizard2Workflow

Parameters:

ticket - Authentication ticket

pageSetName - the pagesetName for which this activities object is being created

content - DataHandler holding the content for this activities object

Returns:

a Wizard2AdminResult object

getActivities

public WizardActivitiesDefinition getActivities(java.lang.String ticket,
                                                PageSetDefinition psDef)

Description copied from interface: IWizard2Workflow

Return the activities object for the given page set definition

Specified by:

getActivities in interface IWizard2Workflow

Parameters:

ticket - authentication ticket

psDef - the page set definition object with the pageSetName populated

Returns:

a WizardActivitiesDefinition object. Currently, this will only have the pageSetName and objectId attributes populated. If the page set does not have an activities XML, this method should return null

See Also:

WizardActivitiesDefinition.setPageSetName(String)

checkinActivities

@Deprecated
public java.lang.String checkinActivities(java.lang.String ticket,
                                                       java.lang.String pageSetName,
                                                       javax.activation.DataHandler objectContent)

Deprecated.

Description copied from interface: IWizard2Workflow

Checks in the activities object with the content specified. This method can be removed if/when we rebuild the AW Admin.

Specified by:

checkinActivities in interface IWizard2Workflow

Parameters:

ticket - authentication ticket

pageSetName - the page set name

objectContent - the new content

Returns:

the new object ID

checkinRole

public java.lang.String checkinRole(java.lang.String ticket,
                                    java.lang.String oldRoleName,
                                    java.lang.String newRoleName,
                                    java.lang.String roleOwner,
                                    java.lang.String[] page_sets,
                                    java.lang.String[] users,
                                    java.lang.String[] groups,
                                    javax.activation.DataHandler objectContent)

Description copied from interface: IWizard2Workflow

Checks in a role, updating its content and other attributes. This method can be removed if/when we rebuild the AW Admin.

Specified by:

checkinRole in interface IWizard2Workflow

oldRoleName - the old roleName of this role object

newRoleName - the new roleName of this role object

roleOwner - the role owner

page_sets - the page_sets this role is attached to - currently the wizard only supports one page_set per role

users - users associated with this role

groups - groups associated with this role

objectContent - the content to checkin

Returns:

the objectId of the new role version

getRolesByPageSet

@Deprecated
public Wizard2AdminResult getRolesByPageSet(java.lang.String ticket,
                                                         java.lang.String pageSetName)

Deprecated.

getRoles

public WizardRole[] getRoles(java.lang.String ticket,
                             PageSetDefinition psDef)

Description copied from interface: IWizard2Workflow

Return the roles associated with the given page set definition.

Specified by:

getRoles in interface IWizard2Workflow

Parameters:

ticket - authentication ticket

psDef - the page set definition object with the pageSetName populated

Returns:

an array of WizardRole objects. If the given page set definition does not have any roles, an empty array is returned

cancelForm

public boolean cancelForm(java.lang.String ticket,
                          java.lang.String formId,
                          java.lang.String comments)

Description copied from interface: IWizard2Workflow

Cancel the form

Specified by:

cancelForm in interface IWizard2Workflow

formId - a string, used to identify the form

comments - a string that include the comments for cancelling the form

Returns:

true if form is cancelled properly

createOrUpdateWorkflowDefinition

public void createOrUpdateWorkflowDefinition(java.lang.String psiName,
                                             java.lang.String objectId,
                                             java.lang.String stringifiedWorkflow,
                                             java.lang.String ticket)

Description copied from interface: IWizard2Workflow

Util function for creating a Workflow Definition repo object and attaching it to a Page Set Instance

Specified by:

createOrUpdateWorkflowDefinition in interface IWizard2Workflow

Parameters:

psiName - page set instance name

objectId - objectId of a page set instance

stringifiedWorkflow - content of the workflow definition

ticket - valid OC ticket

removeWorkflowDefinition

public void removeWorkflowDefinition(java.lang.String psiName,
                                     java.lang.String objectId,
                                     java.lang.String ticket)

Description copied from interface: IWizard2Workflow

Util function for removing a workflow definition from its Page Set Instance repo object

Specified by:

removeWorkflowDefinition in interface IWizard2Workflow

Parameters:

psiName - name of the page set instance whose WF defintion we're removing

objectId - object id of the workflow definition

ticket - valid oc ticket

hasWorkflowDefinition

public boolean hasWorkflowDefinition(java.lang.String objectId,
                                     java.lang.String ticket)

Description copied from interface: IWizard2Workflow

Util method for figuring out if a page set instance has an accompanying workflow definition

Specified by:

hasWorkflowDefinition in interface IWizard2Workflow

Parameters:

objectId - object id of a page set instance

ticket - valid oc ticket

Returns:

true if a workflow definition is attached, false otherwise