|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWFieldsObject | +--filenet.vw.api.VWNewWorkObject
Use this class to create a work object. A work class associated with a specified roster instantiates the new Work Object. The VWSession.createWorkObject() method creates an instance of this class.
You can modify data field values and save the new Work Object to a roster. The doSave() and doSaveMany() methods inject, respectively, a single work object or an array of Work Objects to a server. See the VWInjectSessionInfo class for procedures on obtaining inject session information.
VWRoster
,
VWInjectSessionInfo
,
VWSession.createLiveWorkObject(String[], Object[], String, int)
,
VWCreateLiveWOResult
, Serialized FormMethod Summary | |
VWDataField[] |
getDataFields()
Deprecated. Lists the data fields supported by the new work object. |
java.lang.String[] |
getFieldNames()
Deprecated. Lists data field names for this work object. |
java.lang.Object |
getFieldValue(java.lang.String fieldName)
Deprecated. Gets the value of the specified data field. |
int |
getServerLocation()
Gets the current server location of the work object. |
java.lang.String |
getStepName()
Gets the step name. |
java.lang.String |
getWorkFlowNumber()
Gets the string version of the WorkFlow number. |
boolean |
hasFieldName(java.lang.String fieldName)
Deprecated. Indicates whether or not the specified data field exists. |
void |
save()
Deprecated. Saves a new work object to the server. |
static VWException[] |
SaveMany(VWNewWorkObject[] workObjects,
VWRoster serverToUse,
java.lang.String sessionName,
java.lang.String sessionStatusLabel)
Deprecated. Saves an array of new work objects. |
void |
setFieldValue(java.lang.String fieldName,
java.lang.Object fieldValue)
Deprecated. Sets a value in the specified data field. |
java.lang.String |
toString()
Deprecated. Returns the string version of the new work object name. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
public static VWException[] SaveMany(VWNewWorkObject[] workObjects, VWRoster serverToUse, java.lang.String sessionName, java.lang.String sessionStatusLabel) throws VWException
When specifying the server for recovery, avoid the problem of the default server being different from the server on which other work objects in the array reside. The default server becomes the server of the first work object in the array, unless you specify the server.
Optional session name and status label parameters specify useful information for session query and recovery.
workObjects
- An array of work objects to save.
The array can include objects from various work classes.
serverToUse
- A roster object specifying the
server on which the inject session operation occurs. The
default is null, which indicates that the server being used
is the server specified in the first work object in the array.
sessionName
- The name of the
inject session. The default value is null.
sessionStatusLabel
- A string containing the transaction
label. The value for this setting is optional: however, null
specifies no label.
An entry specifies a label. The VWInjectSessionInfo.getInjectSessionInfo() method returns the label if the save transaction succeeds; otherwise, the method returns the label from the last successful transaction.
VWException
- The method throws an exception if the
work object injection failed. The system injects either all
or none of the work objects using this method.public void save() throws VWException
VWException
- The method throws an exception if it
cannot saves a new work object to the server.public java.lang.String[] getFieldNames()
public java.lang.Object getFieldValue(java.lang.String fieldName) throws VWException
fieldName
- The name for
which data will be retrieved.VWException
- The method throws an exception if the
data field specified in the fieldName parameter does not exist.public void setFieldValue(java.lang.String fieldName, java.lang.Object fieldValue) throws VWException
fieldName
- The name of the data field to
update.fieldValue
- An integer value used to update the data field.VWException
- The method returns an exception if
the field name specified in the fieldName parameter does not
exist.public boolean hasFieldName(java.lang.String fieldName) throws VWException
fieldName
- The data field name being checked.true
if data
field specified in the fieldName parameter exists; otherwise
the method returns false
.VWException
- The method throws an exception if the
field name parameter value is null.public java.lang.String toString()
toString
in class java.lang.Object
public VWDataField[] getDataFields() throws VWException
VWDataField
public java.lang.String getWorkFlowNumber() throws VWException
VWException
- public java.lang.String getStepName() throws VWException
VWException
- Thrown if the method is unable to get a string
containing the step name.public int getServerLocation() throws VWException
VWException
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |