|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWInstructionElement
VWStepElement
public final class VWInstructionElement
Use this class to access the current operation on a workflow object, along with the operation parameters. An Instruction Element represents the Instruction invocation for the workflow object, which eliminates needing to retrieve the entire workflow object. Once you have an Instruction Element, your application can fetch a workflow object.
The following methods can create an instance of this class:
VWQueue.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
,
VWRoster.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
,
VWQueueElement
,
VWQueueQuery
,
VWRosterElement
,
VWRosterQuery
,
VWWorkObject
,
Serialized FormField Summary | |
---|---|
static int |
MODE_IN
Deprecated. Value of 1: indicates that the field has an IN mode. |
static int |
MODE_IN_OUT
Deprecated. Value of 3: indicates that the field has an IN and OUT mode. |
static int |
MODE_OUT
Deprecated. Value of 2: indicates that the field has an OUT mode. |
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
Deprecated. For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
Deprecated. For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
Deprecated. For FileNet internal use only, do not call. |
void |
doAbort()
Deprecated. Unlocks the workflow object associated with the Instruction Element, without updating the workflow object fields. |
void |
doDispatch()
Deprecated. Saves changes made to the work object associated with this Instruction Element, unlocks the work object, and moves the current step to the next workflow step. |
void |
doLock(boolean overrideLock)
Deprecated. Locks a workflow object. |
static VWException[] |
doLockMany(VWInstructionElement[] intrs,
boolean overrideLock)
Deprecated. Locks Instruction Elements associated with workflow objects in a single call. |
void |
doRefresh(boolean lock,
boolean overrideLock)
Deprecated. Fetches the specified Instruction Element to get the most current information. |
void |
doSave(boolean unlock)
Deprecated. Saves the workflow object associated with the Instruction Element. |
static VWException[] |
doSaveMany(VWInstructionElement[] invs)
Deprecated. Saves and updates information for each workflow object specified by the passed array of Instruction Elements. |
void |
doTerminate()
Deprecated. Terminates the workflow object associated with the Instruction Element. |
static VWException[] |
doTerminateMany(VWInstructionElement[] elements)
Deprecated. Terminates workflow objects associated with the passed Instruction Elements. |
static VWException[] |
doUnlockMany(VWInstructionElement[] invs,
boolean save,
boolean dispatch)
Deprecated. Unlocks the array of workflow objects specified by the passed Instruction Elements. |
int |
fetchLockedStatus()
Deprecated. Checks the status of the workflow object. |
VWWorkObject |
fetchWorkObject(boolean lock,
boolean overrideLock)
Deprecated. Fetches a workflow object specified in the Instruction Element. |
java.lang.String |
getExceptionDescription()
Deprecated. Returns the string value the user set as the description of the VWException. |
java.lang.String |
getExceptionInstructionSheet()
Deprecated. Returns the string value the user set as the name of the exception instruction sheet. |
java.lang.String |
getExceptionMap()
Deprecated. Gets the exception workflow map for the workflow object associated with the Instruction Element. |
int |
getFieldMode(java.lang.String fieldName)
Deprecated. Specifies the parameter mode for the specified field as IN, OUT, or INOUT. |
java.lang.String[] |
getFieldNames()
Deprecated. Lists the field names for the Instruction Element parameters. |
java.lang.Object |
getFieldValue(java.lang.String fieldName)
Deprecated. Gets the value of the specified field. |
boolean |
getIsAltered()
Deprecated. Determines whether or not the fields have been modified. |
java.lang.String |
getOperationName()
Deprecated. Gets the name of the current Operation. |
VWParameter[] |
getParameterDataFields()
Deprecated. Gets the data fields for the Instruction Element, which excludes participant lists and attachments. |
int |
getServerLocation()
Deprecated. Gets the current server location of the work object. |
java.lang.String |
getStepName()
Deprecated. Gets the step name for this instance. |
java.lang.String |
getTag()
Deprecated. Gets the workflow object tag, as the workflow system stores it in the database. |
java.lang.String |
getWorkClassName()
Deprecated. Gets the name of the work class which can be used to instantiate the workflow object. |
java.lang.String |
getWorkFlowNumber()
Deprecated. Gets the workflow number. |
java.lang.String |
getWorkObjectName()
Deprecated. Gets the workflow object name. |
java.lang.String |
getWorkObjectNumber()
Deprecated. Gets the string version of the F_WobNum(workflow object number). |
java.lang.String |
getWorkPerformerClassName()
Deprecated. Gets the name of the Work Performer Class associated with the queue on which the workflow object currently resides. |
boolean |
hasBeenAltered(java.lang.String fieldName)
Deprecated. Determines whether or not the field has been modified. |
boolean |
hasFieldName(java.lang.String fieldName)
Deprecated. Determines whether or not the specified field exists. |
void |
lock(boolean overrideLock)
Deprecated. Replaced by doLock(boolean) |
static VWException[] |
lockMany(VWInstructionElement[] intrs,
boolean overrideLock)
Deprecated. Replaced by doLockMany(VWInstructionElement[], boolean) |
void |
logMessage(int loggingOption,
java.lang.String message)
Deprecated. Logs a message to the default server log. |
void |
refresh(boolean lock,
boolean overrideLock)
Deprecated. Replaced by doRefresh(boolean, boolean) |
void |
save()
Deprecated. Replaced by doSave(boolean) |
static VWException[] |
saveMany(VWInstructionElement[] invs)
Deprecated. Replaced by doSaveMany(VWInstructionElement[]) |
void |
setException(java.lang.String anInstructionSheetName,
java.lang.String aDescription)
Deprecated. Sets a exception condition for the workflow object specified by the Instruction Element. |
void |
setFieldValue(java.lang.String fieldName,
java.lang.Object fieldValue)
Deprecated. Sets a value for the specified field. |
void |
terminate()
Deprecated. Replaced by doTerminate() |
static VWException[] |
terminateMany(VWInstructionElement[] elements)
Deprecated. Replaced by doTerminateMany(VWInstructionElement[]) |
java.lang.String |
toString()
Deprecated. Provides a string version of the workflow object name. |
void |
unlock(boolean save,
boolean dispatch)
Deprecated. Replaced by doUnlockMany(VWInstructionElement[], boolean, boolean) |
static VWException[] |
unlockMany(VWInstructionElement[] invs,
boolean save,
boolean dispatch)
Deprecated. Replaced by doUnlockMany(VWInstructionElement[], boolean, boolean) |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int MODE_IN
public static final int MODE_OUT
getFieldMode(java.lang.String)
,
Constant Field Valuespublic static final int MODE_IN_OUT
getFieldMode(java.lang.String)
,
Constant Field ValuesMethod 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 VWWorkObject fetchWorkObject(boolean lock, boolean overrideLock) throws VWException
lock
- A Boolean value. Specify true to lock the workflow
object; false otherwise. See also next parameter, below.overrideLock
- A Boolean value. Specify true to override
an existing lock on the workflow object, except for a system lock.
VWException
- Thrown if this method cannot
fetch a workflow object specified in the Instruction Element.public void refresh(boolean lock, boolean overrideLock) throws VWException
doRefresh(boolean, boolean)
lock
- A Boolean value. Specify true to lock the workflow
object.overrideLock
- A Boolean value. Specify true to override
an existing lock on the workflow object, except for a system lock.
VWException
- Thrown if this method cannot
fetch the specified Instruction Element to update workflow
information.public void doRefresh(boolean lock, boolean overrideLock) throws VWException
lock
- A Boolean value. Specify true to lock the workflow
object.overrideLock
- A Boolean value. Specify true to override
an existing lock on the workflow object, except for a system
lock object.
VWException
- The fetch did not succeed.public static VWException[] unlockMany(VWInstructionElement[] invs, boolean save, boolean dispatch) throws VWException
doUnlockMany(VWInstructionElement[], boolean, boolean)
The workflow objects must be from the same queue or roster. Each Instruction Element must be from the same VWQueueQuery or VWRosterQuery object.
invs
- An array of Instruction Elements to be processed.save
- A Boolean value. Specify true to save workflow
object data field values.dispatch
- A Boolean value. Specify true to dispatch the
workflow objects. You must save a workflow object before
dispatching it.
VWException
- The method throws an exception if a general
system or database error occurs.public static VWException[] doUnlockMany(VWInstructionElement[] invs, boolean save, boolean dispatch) throws VWException
Each Instruction Element must be from the same VWQueueQuery or VWRosterQuery object.
invs
- An array of Instruction Elements to be processed.save
- A Boolean value. Specify true to save workflow object
data field values.dispatch
- A Boolean value. Specify true to dispatch the
workflow objects. You must save a workflow object before
dispatching it.
VWException
- The method throws an exception if a general
system or database error occurs.public static VWException[] saveMany(VWInstructionElement[] invs) throws VWException
doSaveMany(VWInstructionElement[])
The Instruction Elements must be from from the same queue or roster. Each Instruction Element must be from the same VWQueueQuery or VWRosterQuery object.
invs
- An array of Instruction Elements to be processed.
VWException
- The method throws an exception if a general
system or database error occurs.public static VWException[] doSaveMany(VWInstructionElement[] invs) throws VWException
The Instruction Elements must be from from the same queue or roster. Each Instruction Element must be from the same VWQueueQuery or VWRosterQuery object.
invs
- An array of Instruction Elements to be processed.
VWException
- The method throws an exception if a general
system or database error occurs.public void unlock(boolean save, boolean dispatch) throws VWException
doUnlockMany(VWInstructionElement[], boolean, boolean)
save
- A Boolean value. Specify true to save the workflow
object data field values.dispatch
- A Boolean value. Specify true to dispatch the
workflow object. You must save a workflow object before
dispatching it.
VWException
- The method throws an exception if the
workflow object could not be unlocked. An example would be if
it had not been locked by the current user.public void setException(java.lang.String anInstructionSheetName, java.lang.String aDescription) throws VWException
If a user sets the dispatch flag to 'true', the system catches an error in a parameter value only after the application saves the Instruction Element or unlocks the workflow object associated with the Instruction Element.
anInstructionSheetName
- The name of the
instruction sheet* Process Engine
executes when an exception
occurs. A null entry, which is the default, indicates that no
exception occurs. Any other entry means an exception occurs
when the system unlocks and dispatches a workflow object.aDescription
- -- The description of
a VWException, which is not a Java exception.
VWException
- An exception is thrown if the exception
strings could not be set.public java.lang.String getExceptionInstructionSheet()
setException(java.lang.String, java.lang.String)
public java.lang.String getExceptionDescription()
setException(java.lang.String, java.lang.String)
public void save() throws VWException
doSave(boolean)
VWException
- The method throws an exception if
the method could not save the workflow object. This would be
the case, for example, if a user other than the current user
locked the workflow object.public static VWException[] lockMany(VWInstructionElement[] intrs, boolean overrideLock) throws VWException
doLockMany(VWInstructionElement[], boolean)
doSaveMany(filenet.vw.api.VWInstructionElement[])
, to update groups of Instruction Elements.
The array of workflow objects comes from one of the following sources:
intrs
- An array of Instruction Elements to be processed.overrideLock
- A Boolean value. Specify true to override
locks that are not system locks.
VWException
- The method throws an exception if a general
system or database error occurs.doSaveMany(VWInstructionElement[])
public static VWException[] doLockMany(VWInstructionElement[] intrs, boolean overrideLock) throws VWException
doSaveMany(filenet.vw.api.VWInstructionElement[])
, to update groups of Instruction Elements.
The array of workflow objects come from one of the following sources:
intrs
- An array of Instruction Elements to be processed.overrideLock
- A Boolean value. Specify true to override
locks that are not system locks.
VWException
- The method throws an exception if a general
system or database error occurs.doSaveMany(VWInstructionElement[])
public void lock(boolean overrideLock) throws VWException
doLock(boolean)
overrideLock
- A Boolean value. Specify true to override
locks that are not system locks.
VWException
- Thrown if the
workflow object could not be locked.public void doLock(boolean overrideLock) throws VWException
overrideLock
- A Boolean value. Specify true to override
locks that are not system locks.
VWException
- Thrown if the
workflow object could not be locked.public static VWException[] terminateMany(VWInstructionElement[] elements) throws VWException
doTerminateMany(VWInstructionElement[])
elements
- An array of workflow objects to be processed.
VWException
- This method throws an error
if a general system or database error occurs.public static VWException[] doTerminateMany(VWInstructionElement[] elements) throws VWException
elements
- An array of workflow objects to be processed.
VWException
- This method throws an error
if a general system or database error occurs.public void terminate() throws VWException
doTerminate()
VWException
- This method throws an error if the workflow
object could not be terminated. An example of this would be if a
user other than the current user locks the workflow object.public void doTerminate() throws VWException
VWException
- This method throws an error if the workflow
object could not be terminated. An example of this would be if a
user other than the current user locks the workflow object.public int fetchLockedStatus() throws VWException
VWQueueElement
for status definitions.
VWException
- This method throws an error if the workflow
object lock status could not be determined.VWQueueElement
public java.lang.String[] getFieldNames()
public java.lang.Object getFieldValue(java.lang.String fieldName) throws VWException
fieldName
- The name of the specified
field.
VWException
- The method throws an exception if the
field specified in the fieldName parameter string does not exist.public void setFieldValue(java.lang.String fieldName, java.lang.Object fieldValue) throws VWException
Note: Only fields with OUT and INOUT parameter modes are editable.
fieldName
- The name of the required
field.fieldValue
- An object containing the value of the named
field. An object and an array of objects must be of one of the
following types: Integer, String, Double, or Boolean. A field can
have a null value.
VWException
- The method throws an exception if the
field specified in the fieldName parameter string does not exist.hasFieldName( String )
public boolean hasFieldName(java.lang.String fieldName) throws VWException
fieldName
- The name of the specified
field.
VWException
- The method throws an exception if the field
name parameter is null.public boolean getIsAltered()
public boolean hasBeenAltered(java.lang.String fieldName) throws VWException
fieldName
- The name of the specified
field.
VWException
- The method throws an exception if the field
name parameter is null.public int getFieldMode(java.lang.String fieldName) throws VWException
fieldName
- The name of the required
field.
VWException
- The method throws an exception if
the field specified in the fieldName parameter does not exist.public java.lang.String getWorkObjectName() throws VWException
VWException
- The method throws an exception if
the field specified in the fieldName parameter does not exist.public java.lang.String getWorkObjectNumber() throws VWException
VWException
- The method throws an exception if a
general system or database problem occurs.public java.lang.String getTag() throws VWException
VWException
- The method throws an exception if a
general system or database problem occurs.public java.lang.String getWorkClassName() throws VWException
VWException
- The method throws an exception if a
general system or database problem occurs.public java.lang.String getWorkPerformerClassName() throws VWException
VWException
- The method throws an exception if a
general system or database problem occurs.public java.lang.String getOperationName() throws VWException
VWException
- The method throws an exception if a
general system or database problem occurs.public void logMessage(int loggingOption, java.lang.String message) throws VWException
loggingOption
- An integer value that indicates the
available
Process Engine
message category to log. The programmer is
responsible for maintaining meaningful message grouping in each
category. Available logging categories or "option types" are:
message
- The text message to log.
VWException
- The method throws an exception if the
message could not be logged, as when this
method is used on a roster. LogMessage is not intended for use
with an object created by the createQuery() or startQuery() (deprecated)
methods of the VWRoster class.public java.lang.String toString()
toString
in class java.lang.Object
public void doAbort() throws VWException
VWException
- The method throws an exception if the
unlock operation for the workflow object is unsuccessful.public void doDispatch() throws VWException
VWException
- Thrown if the
system encounters an error while attempting to save the
current step or move the step to the next workflow step.public java.lang.String getExceptionMap() throws VWException
VWException
- The method throws an exception if the
exception workflow map for the workflow object could not be retrieved.
This would often be a general system or database problem.public void doSave(boolean unlock) throws VWException
unlock
- A Boolean value. Specify true to save and unlock
the workflow object, which stops the processing associated with
the workflow object. Specify false to save the workflow object,
which keeps the object locked and continues processing it.
VWException
- The method throws an exception if the save
operation fails or the workflow object was not locked by the
current user.public VWParameter[] getParameterDataFields() throws VWException
VWException
public java.lang.String getWorkFlowNumber() throws VWException
VWException
- An exception is thrown under the following conditions:
public java.lang.String getStepName() throws VWException
VWException
- Thrown when the step name cannot be found.public int getServerLocation() throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |