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

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

public class WcmWorkflowStep
extends java.lang.Object

Definition class for describing a step in a workflow.


Field Summary
static java.lang.String TYPE_DYNAMIC
          Normal steps, can be removed
static java.lang.String TYPE_IMPLICIT
          Typically the hidden Editor step
static java.lang.String TYPE_STATIC
          Required steps, can not be removed
 
Constructor Summary
WcmWorkflowStep()
          Default constructor.
 
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 deleteParticipants()
          Delete all participants.
 boolean getAddRejectRoute()
          Get whether the workflow step should have a reject route.
 WcmWorkflowParameter getAttachment(java.lang.String name)
          Get a attachment from the list.
 java.util.Iterator getAttachments()
          Returns the iterator for the attachments list.
 boolean getCanReassign()
          Get whether the workflow step can be reassigned
 long getDeadline()
          Get the workflow step deadline information
 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 getInstructions()
          Get the workflow step instructions string
 java.lang.String getName()
          Get the workflow step name string
 java.util.Iterator getParticipants()
          Returns the iterator for the participants list.
 java.util.Iterator getParticipants(boolean sort)
          Returns the iterator for the participants list.
 int getParticipantsCount()
          Returns the count of items in the participants list.
 java.lang.String getProcessorId()
          Get the workflow step processor id string
 java.lang.String[] getResponses()
          Get the list of step responses
 java.lang.String getType()
          Get the workflow step type
 boolean getVoting()
          Get whether the workflow step supports voting approval routing
 java.lang.String getVotingLimit()
          Get the workflow step voting limit information
 void 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.
 void 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.
 void putParticipant(ParticipantRef participantRef)
          Put a new participant into the list.
 void setAddRejectRoute(boolean addRejectRoute)
          Set whether the workflow step should have a reject route.
 void setCanReassign(boolean canReassign)
          Set whether the workflow step can be reassigned
 void setDeadline(long deadline)
          Sets the workflow step deadline information
 void setInstructions(java.lang.String instructions)
          Sets the workflow step instructions string
 void setName(java.lang.String name)
          Sets the workflow step name string
 void setProcessorId(java.lang.String processorId)
          Sets the workflow step processor id string
 void setResponses(java.lang.String[] responses)
          Sets the list of step responses
 void setType(java.lang.String type)
          Set the workflow step type
 void setVoting(boolean voting)
          Set whether the workflow step supports voting approval routing
 void setVotingLimit(java.lang.String limit)
          Sets the workflow step voting limit information
 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

TYPE_IMPLICIT

public static final java.lang.String TYPE_IMPLICIT
Typically the hidden Editor step

See Also:
Constant Field Values

TYPE_STATIC

public static final java.lang.String TYPE_STATIC
Required steps, can not be removed

See Also:
Constant Field Values

TYPE_DYNAMIC

public static final java.lang.String TYPE_DYNAMIC
Normal steps, can be removed

See Also:
Constant Field Values
Constructor Detail

WcmWorkflowStep

public WcmWorkflowStep()
Default constructor. Creates array lists for the workflow step participants, fields, and attachments.

Method Detail

getName

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

Returns:
name string.

setName

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

Parameters:
name - string.

getProcessorId

public java.lang.String getProcessorId()
Get the workflow step processor id string

Returns:
processor id string.

setProcessorId

public void setProcessorId(java.lang.String processorId)
Sets the workflow step processor id string

Parameters:
processorId - String processor id string.

getInstructions

public java.lang.String getInstructions()
Get the workflow step instructions string

Returns:
instructions string.

setInstructions

public void setInstructions(java.lang.String instructions)
Sets the workflow step instructions string

Parameters:
instructions - string.

getCanReassign

public boolean getCanReassign()
Get whether the workflow step can be reassigned

Returns:
canReassign boolean.

setCanReassign

public void setCanReassign(boolean canReassign)
Set whether the workflow step can be reassigned

Parameters:
canReassign - boolean.

getType

public java.lang.String getType()
Get the workflow step type

Returns:
type String.

setType

public void setType(java.lang.String type)
Set the workflow step type

Parameters:
type - String.

getAddRejectRoute

public boolean getAddRejectRoute()
Get whether the workflow step should have a reject route.

Returns:
addRejectRoute boolean.

setAddRejectRoute

public void setAddRejectRoute(boolean addRejectRoute)
Set whether the workflow step should have a reject route.

Parameters:
addRejectRoute - boolean.

getDeadline

public long getDeadline()
Get the workflow step deadline information

Returns:
deadline float.

setDeadline

public void setDeadline(long deadline)
Sets the workflow step deadline information

Parameters:
deadline - long value.

getVoting

public boolean getVoting()
Get whether the workflow step supports voting approval routing

Returns:
voting boolean.

setVoting

public void setVoting(boolean voting)
Set whether the workflow step supports voting approval routing

Parameters:
voting - boolean.

getVotingLimit

public java.lang.String getVotingLimit()
Get the workflow step voting limit information

Returns:
limit String.

setVotingLimit

public void setVotingLimit(java.lang.String limit)
Sets the workflow step voting limit information

Parameters:
limit - String value.

getParticipants

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

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

getParticipants

public java.util.Iterator getParticipants(boolean sort)
                                   throws java.lang.Exception
Returns the iterator for the participants list. Can be used to loop through the participants in the list.

Parameters:
sort - true to short the participant list.
Returns:
iterator Iterator for the list.
Throws:
java.lang.Exception

getParticipantsCount

public int getParticipantsCount()
                         throws java.lang.Exception
Returns the count of items in the participants list. Can be used to loop through the participants in the list.

Returns:
count int.
Throws:
java.lang.Exception

putParticipant

public void putParticipant(ParticipantRef participantRef)
                    throws java.lang.Exception
Put a new participant into the list.

Parameters:
participantRef - String name of participant.
Throws:
java.lang.Exception

deleteParticipants

public void deleteParticipants()
                        throws java.lang.Exception
Delete all participants.

Throws:
java.lang.Exception

getResponses

public java.lang.String[] getResponses()
                                throws java.lang.Exception
Get the list of step responses

Returns:
responses String[].
Throws:
java.lang.Exception

setResponses

public void setResponses(java.lang.String[] responses)
                  throws java.lang.Exception
Sets the list of step responses

Parameters:
responses - String[].
Throws:
java.lang.Exception

putField

public void 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 void putAttachment(java.lang.String name,
                          boolean isArray)
                   throws java.lang.Exception
Put a new attachment into the list.

Parameters:
name - String name of attachment.
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

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.