com.tsgrp.opencontent.wizard.workflow

Interface IWizard2Workflow

All Known Implementing Classes:

AlfrescoWizard2WorkflowImpl, Wizard2WorkflowImpl

public interface IWizard2Workflow

Interface methods that require workflow implementation specific resources.

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) Checks in the activities object with the content specified.
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 the workflow activities for the given page set.
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 pageSetDef) 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 pageSetDef) Return the roles associated with the given page set definition.
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

Method Detail

getRole

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

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

Parameters:

ticket - authentication ticket

roleName - the role to return

Returns:

the WizardRole, or null if the role is not found

getAllRoleNames

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

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.

Parameters:

ticket - authentication ticket

Returns:

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

createRole

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

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

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

getActivities

WizardActivitiesDefinition getActivities(java.lang.String ticket,
                                         PageSetDefinition pageSetDef)

Return the activities object for the given page set definition

Parameters:

ticket - authentication ticket

pageSetDef - 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

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

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

Parameters:

ticket - authentication ticket

pageSetName - the page set name

objectContent - the new content

Returns:

the new object ID

createActivities

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

Creates the workflow activities for the given page set.

Parameters:

ticket - authentication ticket

pageSetName - the page set associated with the new activities object

content - DataHandler holding the content for this activities object

Returns:

Wizard2AdminResult

checkinRole

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. This method can be removed if/when we rebuild the AW Admin.

Parameters:

ticketAuthentication - ticket

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

getRoles

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

Return the roles associated with the given page set definition.

Parameters:

ticket - authentication ticket

pageSetDef - 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

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

Cancel the form

Parameters:

ticket -

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

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

Parameters:

psiName - page set instance name

objectId - objectId of a page set instance

stringifiedWorkflow - content of the workflow definition

ticket - valid OC ticket

removeWorkflowDefinition

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

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

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

Parameters:

objectId - object id of a page set instance

ticket - valid oc ticket

Returns:

true if a workflow definition is attached, false otherwise