|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWWorkflowCollectionDefinition
public final class VWWorkflowCollectionDefinition
Represents zero or more workflow definitions.
VWWorkflowDefinition
,
Serialized FormField Summary | |
---|---|
static int |
COLLECTION_EXTENSION_SCENARIO_COLLECTION
Indicates that the extension object is a scenario collection. |
static java.lang.String |
COLLECTION_VALIDATION_KEY
The key for the collection validation errors in the HashMap object returned by the validate method. |
static int |
WORKFLOW_COLLECTION_SOURCE_NEW
Indicates there is no source of the workflow collection (it is new). |
static int |
WORKFLOW_COLLECTION_SOURCE_PEP
Indicates a PEP file is the source of the workflow collection. |
static int |
WORKFLOW_COLLECTION_SOURCE_XPDL
Indicates an XPDL file is the source of the workflow collection. |
Constructor Summary | |
---|---|
VWWorkflowCollectionDefinition()
|
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
void |
addWorkflow(VWWorkflowDefinition theWorkflow)
Adds a workflow to this collection. |
java.lang.String |
asXPDLString()
Retrieves an XPDL formatted representation of this instance. |
void |
export(java.io.OutputStream theStream,
VWSession session)
Writes this instance in a self-contained form to a specified output stream. |
void |
exportToFile(java.lang.String theFileName,
VWSession session)
Writes this instance in a self-contained form to a specified file. |
java.lang.String |
getApplicationSpaceName()
Get the application name |
java.lang.String |
getAuthorTool()
Identifies the application that generated this instance. |
java.lang.String |
getDescription()
Returns a description of this collection. |
VWWorkflowDefinition |
getMainWorkflow()
Gets a reference to the main workflow in this instance. |
java.lang.String |
getName()
Gets the name of this instance. |
int |
getSource()
Identifies the source of this collection. |
VWWorkflowDefinition |
getWorkflow(java.lang.String theName)
Retrieves a workflow definition from this collection, based on the specified name. |
int |
getWorkflowIndex(java.lang.String theName)
Returns the index into the array of workflow definitions in this collection for specified workflow. |
VWWorkflowDefinition[] |
getWorkflows()
Gets the set of workflows associated with this collection. |
boolean |
isExistingWorkflowName(java.lang.String theName)
Check to see whether a workflow definition having the specified name exists in this collection. |
static VWWorkflowCollectionDefinition |
read(java.io.InputStream theStream)
Evaluates and creates a workflow collection based on the values read from a specified input stream. |
static VWWorkflowCollectionDefinition |
readFromFile(java.lang.String theFileName)
Evaluates and creates a workflow collection based on the values read from a specified file. |
java.lang.Object |
registerCollectionExtension(int nExtensionType,
filenet.vw.api.IVWCollectionExtension collectionExtension)
Register a collection extension |
VWWorkflowDefinition |
removeWorkflow(java.lang.String theWorkflowName)
Removes the specified workflow from this collection. |
void |
setApplicationSpaceName(java.lang.String newApplicationSpaceName)
Set the application space name |
void |
setAuthorTool(java.lang.String theAuthorTool)
Specifies the identifier for the application that generated this instance. |
void |
setDescription(java.lang.String theDescription)
Specifies a description for this collection. |
void |
setMainWorkflowByName(java.lang.String theName)
Specifies the the main workflow in this collection. |
void |
setName(java.lang.String theName)
Changes the name of this instance. |
void |
toXPDL(java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
java.util.HashMap |
validate(VWSession theSession,
boolean fixupSteps)
Validates this instance. |
void |
write(java.io.OutputStream theStream)
Writes this instance to a specified output stream. |
void |
writeToFile(java.lang.String theFileName)
Writes this instance to a specified file. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int WORKFLOW_COLLECTION_SOURCE_NEW
public static final int WORKFLOW_COLLECTION_SOURCE_PEP
public static final int WORKFLOW_COLLECTION_SOURCE_XPDL
public static final java.lang.String COLLECTION_VALIDATION_KEY
validate
method.
public static final int COLLECTION_EXTENSION_SCENARIO_COLLECTION
registerCollectionExtension(int, IVWCollectionExtension)
,
Constant Field ValuesConstructor Detail |
---|
public VWWorkflowCollectionDefinition()
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public java.util.HashMap validate(VWSession theSession, boolean fixupSteps) throws VWException
VWWorkflowDefinition.setValidateFlag
).
theSession
- The current VWSession object if logged on. This is needed
for various parts of the validation process. This can be null; however, areas of validation requiring a
logon will not be validated.fixupSteps
- A boolean value of true to indicate that the step ID values for joins (steps that are AND'd)
are to be filled in. Specify false if you do not want the step IDs to be filled in for the join, or to
indicate that the caller has already specified the join step IDs.
The values associated with the keys in the HashMap are arrays of VWValidationError objects that describe the validation errors encountered if the corresponding workflow is invalid. If the workflow definition is found to be valid, the object associated with the key will be a zero length array (VWValidationError[0]). If the corresponding workflow has the validate flag set to false, the workflow will not be validated and the object in the HashMap corresponding to the name of that workflow will be null.
VWException
COLLECTION_VALIDATION_KEY
,
VWValidationError
,
VWWorkflowDefinition.setValidateFlag(boolean)
,
VWWorkflowDefinition.getValidateFlag()
public void addWorkflow(VWWorkflowDefinition theWorkflow) throws VWException
theWorkflow
- A VWWorkflowDefinition object for the workflow to be added into this collection.
VWException
- Thrown if a workflow with the same name as the workflow being added already
exists in this workflow collection.VWWorkflowDefinition
public VWWorkflowDefinition removeWorkflow(java.lang.String theWorkflowName) throws VWException
theWorkflowName
- A String containing the name of the workflow to be deleted.
VWException
- Thrown if the specified workflow name is null or invalid.VWWorkflowDefinition
public java.lang.String getName()
public void setName(java.lang.String theName) throws VWException
theName
- A String containing the name of this workflow collection, or null.
VWException
- Thrown if an error occurs.public java.lang.String getAuthorTool()
public void setAuthorTool(java.lang.String theAuthorTool) throws VWException
theAuthorTool
- A String identifying the application that generated this workflow collection. This can be
null if you do not want to identify this application.
VWException
public java.lang.String getDescription()
public void setDescription(java.lang.String theDescription)
theDescription
- A String containing the description for this workflow collection. This can be null if
you do not want to supply a description.public VWWorkflowDefinition getWorkflow(java.lang.String theName) throws VWException
theName
- A String containing the name of the workflow to retrieve from this instance.
VWException
- Thrown if the specified workflow cannot be found in this collection.VWWorkflowDefinition
public VWWorkflowDefinition[] getWorkflows() throws VWException
VWException
- Thrown if an error occurs while attempting to retrieve the workflow objects in this
collection.VWWorkflowDefinition
public int getWorkflowIndex(java.lang.String theName) throws VWException
theName
- A String containing the name of the workflow in this collection.
VWException
- Thrown if the specified workflow cannot be found in this collection.VWWorkflowDefinition
public static VWWorkflowCollectionDefinition read(java.io.InputStream theStream) throws VWException
theStream
- An InputStream object from which to read the VWWorkflowCollectionDefinition object definition.
VWException
- Thrown if a workflow collection cannot be evaluated from the input stream specified.write(java.io.OutputStream)
public static VWWorkflowCollectionDefinition readFromFile(java.lang.String theFileName) throws VWException
theFileName
- A String containing the name of the file from which to read the VWWorkflowCollectionDefinition
object definition.
VWException
- Thrown if a workflow collection cannot be evaluated from the file specified.writeToFile(java.lang.String)
public void write(java.io.OutputStream theStream) throws VWException
theStream
- An OutputStream object to which to write this collection.
VWException
- Thrown if this instance cannot be written to the OutputStream specified.read(InputStream)
public void writeToFile(java.lang.String theFileName) throws VWException
theFileName
- A String containing the name of the file to which to write this collection.
VWException
- Thrown if this instance cannot be written to the file specified.readFromFile(java.lang.String)
,
write(java.io.OutputStream)
public void export(java.io.OutputStream theStream, VWSession session) throws VWException
theStream
- An OutputStream object to which to write this collection.session
- A VWSession object
VWException
- Thrown if this instance cannot be written to the output stream specified.read(InputStream)
public void exportToFile(java.lang.String theFileName, VWSession session) throws VWException
theFileName
- A String containing the name of the file to which to write this collection.session
- A VWSession object
VWException
- Thrown if this instance cannot be written to the file specified.readFromFile(java.lang.String)
,
write(java.io.OutputStream)
public java.lang.String asXPDLString() throws VWException
VWException
- Thrown if an XPDL-formatted representation of this collection cannot be retrieved.VWWorkflowCollectionDefinition.write
public void toXPDL(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XPDL string is nonextensible, and cannot be modified in any way.
theBuffer
- A StringBuffer that will be appended with the XPDL content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public boolean isExistingWorkflowName(java.lang.String theName) throws VWException
theName
- Name of the workflow being checked for.
VWException
- Thrown when a low-level array access error occurs.VWWorkflowDefinition
public VWWorkflowDefinition getMainWorkflow()
public void setMainWorkflowByName(java.lang.String theName) throws VWException
theName
- A String containing the name of the workflow to assign as the main workflow in this collection.
The specified workflow must exist in this collection.
VWException
- Thrown if a the specified workflow does not exist in this collection.public java.lang.String getApplicationSpaceName()
public void setApplicationSpaceName(java.lang.String newApplicationSpaceName)
newApplicationSpaceName
- the new application space namepublic int getSource()
public java.lang.Object registerCollectionExtension(int nExtensionType, filenet.vw.api.IVWCollectionExtension collectionExtension)
nExtensionType
- the extension typecollectionExtension
- a class that implements IVWCollectionExtension
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |