com.filenet.wcm.toolkit.server.util.workflow
Class WcmWorkflowTemplate

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.workflow.WcmWorkflowTemplate

public class WcmWorkflowTemplate
extends java.lang.Object

Definition class for describing a workflow template.


Field Summary
static java.lang.String KEY
          The key string _workflowTemplate
static java.lang.String STYLE_APROVAL
          Approval Template
static java.lang.String STYLE_DESIGNER
          Designer Template
static java.lang.String STYLE_SEQUENCE
          Sequence Template
 
Constructor Summary
WcmWorkflowTemplate(java.lang.String style)
          Default constructor creates a basic template using a specified value for the template style.
 
Method Summary
 void deleteAttachment(java.lang.String name)
          Delete a attachment from the list.
 void deleteAttachments()
          Delete all attachments.
 void deleteField(java.lang.String name)
          Delete a field from the list.
 void deleteFields()
          Delete all fields.
 void deleteStep(java.lang.String name)
          Delete a step from the list.
 WcmWorkflowParameter getAttachment(java.lang.String name)
          Get a attachment from the list.
 java.util.Iterator getAttachments()
          Returns the iterator for the attachments list.
 java.lang.String getDefaultProcessorId()
          Get the workflow default Step Processor Id string
 WcmWorkflowParameter getField(java.lang.String name)
          Get a field from the list.
 java.util.Iterator getFields()
          Returns the iterator for the fields list.
 java.lang.String getName()
          Get the workflow name string
 boolean getRouteToEditor()
          Get the workflow routing style for workflows of type "Sequence".
 WcmWorkflowStep getStep(java.lang.String name)
          Get a step from the list.
 java.util.ListIterator getStepProcessors()
          Returns the iterator for the step processor list.
 java.util.ListIterator getSteps()
          Returns the iterator for the steps list.
 java.lang.String getStyle()
          Get the workflow style string
 java.lang.String getWorkClassName()
          Get the work class name string
 filenet.vw.api.VWWorkflowDefinition getWorkflowDefinition()
          Get the VWWorkflowDefinition
 WcmWorkflowParameter putAttachment(java.lang.String name, boolean isArray)
          Put a new attachment into the list.
 void putAttachment(WcmWorkflowParameter workflowParameter)
          Put a new attachment into the list.
 WcmWorkflowParameter putField(java.lang.String name, int type, boolean isArray)
          Put a new field into the list.
 void putField(WcmWorkflowParameter workflowParameter)
          Put a new field into the list.
 WcmWorkflowStep putStep(java.lang.String name, java.lang.String type, java.lang.String processorId, boolean canReassign, ParticipantRef[] participants)
          Put a new step into the list.
 void putStepProcessor(java.lang.String id, java.lang.String name)
          Add a step processor to the list of available step processors.
 void setDefaultProcessorId(java.lang.String defaultStepProcessorId)
          Sets the workflow default Step Processor Id string
 void setName(java.lang.String name)
          Sets the workflow name string
 void setRouteToEditor(boolean routing)
          Set the workflow routing style for workflows of type "Sequence".
 void setWorkClassName(java.lang.String name)
          Sets the work class name string
 void setWorkflowDefinition(filenet.vw.api.VWWorkflowDefinition workflowDefinition)
          Sets the workflow definition VWWorkflowDefinition
 void toXML(java.lang.StringBuffer buffer)
          Append an XML string, that represents this object, to the end of the buffer passed to this method.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STYLE_APROVAL

public static final java.lang.String STYLE_APROVAL
Approval Template

See Also:
Constant Field Values

STYLE_SEQUENCE

public static final java.lang.String STYLE_SEQUENCE
Sequence Template

See Also:
Constant Field Values

STYLE_DESIGNER

public static final java.lang.String STYLE_DESIGNER
Designer Template

See Also:
Constant Field Values

KEY

public static final java.lang.String KEY
The key string _workflowTemplate

See Also:
Constant Field Values
Constructor Detail

WcmWorkflowTemplate

public WcmWorkflowTemplate(java.lang.String style)
Default constructor creates a basic template using a specified value for the template style.

Parameters:
style - String style
Method Detail

getStyle

public java.lang.String getStyle()
Get the workflow style string

Returns:
style string.

getName

public java.lang.String getName()
Get the workflow name string

Returns:
name string.

setWorkClassName

public void setWorkClassName(java.lang.String name)
Sets the work class name string

Parameters:
name - string.

getWorkClassName

public java.lang.String getWorkClassName()
Get the work class name string

Returns:
name string.

setName

public void setName(java.lang.String name)
Sets the workflow name string

Parameters:
name - string.

getRouteToEditor

public boolean getRouteToEditor()
Get the workflow routing style for workflows of type "Sequence". If set to true, rejecting any step will route the step back to the Editor, otherwise the step is routed back to the previous step.

Returns:
routing boolean.

setRouteToEditor

public void setRouteToEditor(boolean routing)
Set the workflow routing style for workflows of type "Sequence". If set to true, rejecting any step will route the step back to the Editor, otherwise the step is routed back to the previous step.

Parameters:
routing - boolean.

putField

public WcmWorkflowParameter putField(java.lang.String name,
                                     int type,
                                     boolean isArray)
                              throws java.lang.Exception
Put a new field into the list.

Parameters:
name - String name of field.
type - int type of field.
isArray - boolean flag for whether the filed is multi-valued.
Throws:
java.lang.Exception

putField

public void putField(WcmWorkflowParameter workflowParameter)
              throws java.lang.Exception
Put a new field into the list.

Parameters:
workflowParameter - WcmWorkflowParameter object holding field information.
Throws:
java.lang.Exception

getField

public WcmWorkflowParameter getField(java.lang.String name)
                              throws java.lang.Exception
Get a field from the list.

Parameters:
name - String name of field.
Throws:
java.lang.Exception

deleteField

public void deleteField(java.lang.String name)
                 throws java.lang.Exception
Delete a field from the list.

Parameters:
name - String name of field to remove.
Throws:
java.lang.Exception

deleteFields

public void deleteFields()
                  throws java.lang.Exception
Delete all fields.

Throws:
java.lang.Exception

getFields

public java.util.Iterator getFields()
                             throws java.lang.Exception
Returns the iterator for the fields list. Can be used to loop through the fields in the list.

Returns:
iterator Iterator for the list.
Throws:
java.lang.Exception

putAttachment

public WcmWorkflowParameter putAttachment(java.lang.String name,
                                          boolean isArray)
                                   throws java.lang.Exception
Put a new attachment into the list.

Parameters:
name - String name of attachment.
isArray - Boolean indicates if array
Throws:
java.lang.Exception

putAttachment

public void putAttachment(WcmWorkflowParameter workflowParameter)
                   throws java.lang.Exception
Put a new attachment into the list.

Parameters:
workflowParameter - WcmWorkflowParameter object holding attachment information.
Throws:
java.lang.Exception

getAttachment

public WcmWorkflowParameter getAttachment(java.lang.String name)
                                   throws java.lang.Exception
Get a attachment from the list.

Parameters:
name - String name of attachment.
Throws:
java.lang.Exception

deleteAttachment

public void deleteAttachment(java.lang.String name)
                      throws java.lang.Exception
Delete a attachment from the list.

Parameters:
name - String name of attachment to remove.
Throws:
java.lang.Exception

deleteAttachments

public void deleteAttachments()
                       throws java.lang.Exception
Delete all attachments.

Throws:
java.lang.Exception

getAttachments

public java.util.Iterator getAttachments()
                                  throws java.lang.Exception
Returns the iterator for the attachments list. Can be used to loop through the attachments in the list.

Returns:
iterator Iterator for the list.
Throws:
java.lang.Exception

putStep

public WcmWorkflowStep putStep(java.lang.String name,
                               java.lang.String type,
                               java.lang.String processorId,
                               boolean canReassign,
                               ParticipantRef[] participants)
                        throws java.lang.Exception
Put a new step into the list.

Parameters:
name - String name of step.
type - String type of step.
processorId - String processor id for step.
canReassign - boolean for step reassignment setting
participants - String array of participants to add to the Step.
Returns:
workflowStep WcmWorkflowStep created.
Throws:
java.lang.Exception

getStep

public WcmWorkflowStep getStep(java.lang.String name)
                        throws java.lang.Exception
Get a step from the list.

Parameters:
name - String name of step.
Throws:
java.lang.Exception

deleteStep

public void deleteStep(java.lang.String name)
                throws java.lang.Exception
Delete a step from the list.

Parameters:
name - String name of step to remove.
Throws:
java.lang.Exception

getSteps

public java.util.ListIterator getSteps()
                                throws java.lang.Exception
Returns the iterator for the steps list. Can be used to loop through the steps in the list.

Returns:
iterator ListIterator for the list.
Throws:
java.lang.Exception

putStepProcessor

public void putStepProcessor(java.lang.String id,
                             java.lang.String name)
                      throws java.lang.Exception
Add a step processor to the list of available step processors.

Parameters:
id - String used to identify the step processor
name - String display name of the step processor
Throws:
java.lang.Exception

getStepProcessors

public java.util.ListIterator getStepProcessors()
Returns the iterator for the step processor list. Can be used to loop through the step processors in the list.

Returns:
iterator ListIterator for the list.

getDefaultProcessorId

public java.lang.String getDefaultProcessorId()
Get the workflow default Step Processor Id string

Returns:
defaultStepProcessorId string.

setDefaultProcessorId

public void setDefaultProcessorId(java.lang.String defaultStepProcessorId)
Sets the workflow default Step Processor Id string

Parameters:
defaultStepProcessorId - string.

getWorkflowDefinition

public filenet.vw.api.VWWorkflowDefinition getWorkflowDefinition()
Get the VWWorkflowDefinition

Returns:
workflowDefinition as VWWorkflowDefinition.

setWorkflowDefinition

public void setWorkflowDefinition(filenet.vw.api.VWWorkflowDefinition workflowDefinition)
Sets the workflow definition VWWorkflowDefinition

Parameters:
workflowDefinition - VWWorkflowDefinition.

toXML

public void toXML(java.lang.StringBuffer buffer)
           throws java.lang.Exception
Append an XML string, that represents this object, to the end of the buffer passed to this method.

Parameters:
buffer - StringBuffer to append XML data.
Throws:
java.lang.Exception


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.