org.infoglue.cms.applications.workflowtool.function
Class Owner

java.lang.Object
  org.infoglue.cms.applications.workflowtool.util.InfoglueWorkflowBase
      org.infoglue.cms.applications.workflowtool.function.InfoglueFunction
          org.infoglue.cms.applications.workflowtool.function.Owner

All Implemented Interfaces:

com.opensymphony.workflow.FunctionProvider

public class Owner
extends InfoglueFunction

This function is used for creating an owner object that can be used to set the owner in the workflow definition file.

If the group argument is specified, then all users that are members of both the role and the group will be owners. Otherwise all users that are members of the role will be owners.

<result old-status="Finished" status="Queued" step="1" owner="${owner}">

Context in

Name	Type	Class	Required	Default	Comments
role	argument	String	true	-	The name of the InfoGlueRole.
group	argument	String	false	-	The name of the InfoGlueGroup.

Context out

Name	Type	Class	Comments
owner	parameter	org.infoglue.cms.util.workflow.Owner	The owner object.

Field Summary

Fields inherited from class org.infoglue.cms.applications.workflowtool.function.InfoglueFunction

LOCALE_PARAMETER, PRINCIPAL_PARAMETER

Fields inherited from class org.infoglue.cms.applications.workflowtool.util.InfoglueWorkflowBase

ERROR_PROPERTYSET_PREFIX, FUNCTION_STATUS_PROPERTYSET_KEY, UTF8_ENCODING, WORKFLOW_PROPERTYSET_PREFIX

Constructor Summary

Owner()
Default constructor.

Method Summary

protected void	execute() Checks if the group is specified, creates the owner object and stores it in the parameters.
protected void	initialize() Method used for initializing the function; will be called before execute is called.

Methods inherited from class org.infoglue.cms.applications.workflowtool.function.InfoglueFunction

execute, getLocale, getPrincipal, getRequestParameter, setFunctionStatus

Methods inherited from class org.infoglue.cms.applications.workflowtool.util.InfoglueWorkflowBase

argumentExists, getArgument, getArgument, getDatabase, getParameter, getParameter, getParameter, getParameters, getParameterStringValue, getPropertySet, getPropertySetDataString, getPropertySetString, getVariableFromMaps, parameterExists, propertySetContains, removeFromPropertySet, removeFromPropertySet, setParameter, setPropertySetDataString, setPropertySetString, storeContext, throwException, throwException, translate, translateVariables

Methods inherited from class java.lang.Object

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

Constructor Detail

Owner

public Owner()

Default constructor.

Method Detail

execute

protected void execute()
                throws com.opensymphony.workflow.WorkflowException

Checks if the group is specified, creates the owner object and stores it in the parameters.

Specified by:

execute in class InfoglueFunction

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs during the execution.

initialize

protected void initialize()
                   throws com.opensymphony.workflow.WorkflowException

Method used for initializing the function; will be called before execute is called.

Note! You must call super.initialize() first.

Overrides:

initialize in class InfoglueFunction

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs during the initialization.