|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.util.workflow.WcmWorkflowStep
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 |
public static final java.lang.String TYPE_IMPLICIT
public static final java.lang.String TYPE_STATIC
public static final java.lang.String TYPE_DYNAMIC
Constructor Detail |
public WcmWorkflowStep()
Method Detail |
public java.lang.String getName()
public void setName(java.lang.String name)
name
- string.public java.lang.String getProcessorId()
public void setProcessorId(java.lang.String processorId)
processorId
- String processor id string.public java.lang.String getInstructions()
public void setInstructions(java.lang.String instructions)
instructions
- string.public boolean getCanReassign()
public void setCanReassign(boolean canReassign)
canReassign
- boolean.public java.lang.String getType()
public void setType(java.lang.String type)
type
- String.public boolean getAddRejectRoute()
public void setAddRejectRoute(boolean addRejectRoute)
addRejectRoute
- boolean.public long getDeadline()
public void setDeadline(long deadline)
deadline
- long value.public boolean getVoting()
public void setVoting(boolean voting)
voting
- boolean.public java.lang.String getVotingLimit()
public void setVotingLimit(java.lang.String limit)
limit
- String value.public java.util.Iterator getParticipants() throws java.lang.Exception
java.lang.Exception
public java.util.Iterator getParticipants(boolean sort) throws java.lang.Exception
sort
- true to short the participant list.
java.lang.Exception
public int getParticipantsCount() throws java.lang.Exception
java.lang.Exception
public void putParticipant(ParticipantRef participantRef) throws java.lang.Exception
participantRef
- String name of participant.
java.lang.Exception
public void deleteParticipants() throws java.lang.Exception
java.lang.Exception
public java.lang.String[] getResponses() throws java.lang.Exception
java.lang.Exception
public void setResponses(java.lang.String[] responses) throws java.lang.Exception
responses
- String[].
java.lang.Exception
public void putField(java.lang.String name, int type, boolean isArray) throws java.lang.Exception
name
- String name of field.type
- int type of field.isArray
- boolean flag for whether the filed is multi-valued.
java.lang.Exception
public void putField(WcmWorkflowParameter workflowParameter) throws java.lang.Exception
workflowParameter
- WcmWorkflowParameter object holding field information.
java.lang.Exception
public WcmWorkflowParameter getField(java.lang.String name) throws java.lang.Exception
name
- String name of field.
java.lang.Exception
public void deleteField(java.lang.String name) throws java.lang.Exception
name
- String name of field to remove.
java.lang.Exception
public void deleteFields() throws java.lang.Exception
java.lang.Exception
public java.util.Iterator getFields() throws java.lang.Exception
java.lang.Exception
public void putAttachment(java.lang.String name, boolean isArray) throws java.lang.Exception
name
- String name of attachment.
java.lang.Exception
public void putAttachment(WcmWorkflowParameter workflowParameter) throws java.lang.Exception
workflowParameter
- WcmWorkflowParameter object holding attachment information.
java.lang.Exception
public WcmWorkflowParameter getAttachment(java.lang.String name) throws java.lang.Exception
name
- String name of attachment.
java.lang.Exception
public void deleteAttachment(java.lang.String name) throws java.lang.Exception
name
- String name of attachment to remove.
java.lang.Exception
public void deleteAttachments() throws java.lang.Exception
java.lang.Exception
public java.util.Iterator getAttachments() throws java.lang.Exception
java.lang.Exception
public void toXML(java.lang.StringBuffer buffer) throws java.lang.Exception
buffer
- StringBuffer to append XML data.
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |