|
||||||||||
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.WcmWorkflowTemplate
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 |
public static final java.lang.String STYLE_APROVAL
public static final java.lang.String STYLE_SEQUENCE
public static final java.lang.String STYLE_DESIGNER
public static final java.lang.String KEY
Constructor Detail |
public WcmWorkflowTemplate(java.lang.String style)
style
- String styleMethod Detail |
public java.lang.String getStyle()
public java.lang.String getName()
public void setWorkClassName(java.lang.String name)
name
- string.public java.lang.String getWorkClassName()
public void setName(java.lang.String name)
name
- string.public boolean getRouteToEditor()
public void setRouteToEditor(boolean routing)
routing
- boolean.public WcmWorkflowParameter 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 WcmWorkflowParameter putAttachment(java.lang.String name, boolean isArray) throws java.lang.Exception
name
- String name of attachment.isArray
- Boolean indicates if array
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 WcmWorkflowStep putStep(java.lang.String name, java.lang.String type, java.lang.String processorId, boolean canReassign, ParticipantRef[] participants) throws java.lang.Exception
name
- String name of step.type
- String type of step.processorId
- String processor id for step.canReassign
- boolean for step reassignment settingparticipants
- String array of participants to add to the Step.
java.lang.Exception
public WcmWorkflowStep getStep(java.lang.String name) throws java.lang.Exception
name
- String name of step.
java.lang.Exception
public void deleteStep(java.lang.String name) throws java.lang.Exception
name
- String name of step to remove.
java.lang.Exception
public java.util.ListIterator getSteps() throws java.lang.Exception
java.lang.Exception
public void putStepProcessor(java.lang.String id, java.lang.String name) throws java.lang.Exception
id
- String used to identify the step processorname
- String display name of the step processor
java.lang.Exception
public java.util.ListIterator getStepProcessors()
public java.lang.String getDefaultProcessorId()
public void setDefaultProcessorId(java.lang.String defaultStepProcessorId)
defaultStepProcessorId
- string.public filenet.vw.api.VWWorkflowDefinition getWorkflowDefinition()
public void setWorkflowDefinition(filenet.vw.api.VWWorkflowDefinition workflowDefinition)
workflowDefinition
- VWWorkflowDefinition.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 |