Process Class Relationships

filenet.vw.api
Class VWRosterElement

java.lang.Object
  |
  +--filenet.vw.api.VWFieldsObject
        |
        +--filenet.vw.api.VWWorkElement
              |
              +--filenet.vw.api.VWRosterElement
All Implemented Interfaces:
IVWtoXML, java.io.Serializable

public final class VWRosterElement
extends filenet.vw.api.VWWorkElement
implements IVWtoXML

Use this class to access a roster element and fetch a work object or an instruction element.

A roster element represents an individual work object in a roster. An instance of this class accesses system-defined, indexed, and exposed fields without the expense of retrieving an entire work object.

Call the VWRoster.createQuery() method specify a fetch type of roster element. Subsequent calls of VWRosterQuery.next() create instances of the VWRosterElement class.

See Also:
VWRosterQuery, VWWorkObject, VWInstructionElement, Serialized Form

Method Summary
 VWInstructionElement fetchInstructionElement(boolean lock, boolean overrideLock)
          Fetches the instruction element that corresponds to the roster element.
 VWWorkObject fetchWorkObject(boolean lock, boolean overrideLock)
          Fetches the work object that corresponds to this roster element.
 VWDataField[] getDataFields()
          Lists exposed data fields this roster element supports.
 java.lang.String[] getFieldNames()
          Lists the system-defined field names and user-defined exposed field names supported by the roster element.
 java.lang.Object getFieldValue(java.lang.String fieldName)
          Gets the value of a field in the roster element.
 java.util.Date getLaunchDate()
          Gets the launch date of the workflow process that contains the work object.
 java.lang.String getOriginator()
          Gets the name of the user who initiated the workflow process that contains this work object.
 VWProcess getProcess()
          Deprecated. Replaced by VWStepElement.fetchProcess() or VWWorkObject.fetchProcess(), depending on the type of process
 java.lang.String getRosterName()
          Returns the name of the roster.
 int getServerLocation()
          Gets the current server location of the work object.
 java.lang.String getStepName()
          Gets the step name.
 java.lang.String getTag()
          Gets the tag of the work object (as a string).
 java.lang.String getWorkflowNumber()
          Gets the string version of the WorkFlow number.
 java.lang.String getWorkFlowNumber()
          Deprecated. Replaced by getWorkflowNumber()
 java.lang.String getWorkObjectName()
          Gets the work object name.
 java.lang.String getWorkObjectNumber()
          Gets the work object number (as a string).
 boolean hasFieldName(java.lang.String fieldName)
          Determines whether the specified field exists.
 boolean isSystemField(java.lang.String fieldName)
          Determines whether the field is a system field.
 java.lang.String toString()
          Gets a string version of a work object name.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML string that represents this VWRosterElement object to the buffer specified by the input parameter.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

fetchInstructionElement

public VWInstructionElement fetchInstructionElement(boolean lock,
                                                    boolean overrideLock)
                                             throws VWException
Fetches the instruction element that corresponds to the roster element.
Parameters:
lock - A Boolean value. Specify true to lock the work object. Specify false to leave the lock active.
overrideLock - A Boolean value. Specify true to override an existing lock on the work object.
Returns:
A VWInstructionElement object that represents an instruction element for the roster.
Throws:
VWException - Thrown if it cannot fetch the instruction element that corresponds to the roster element.

fetchWorkObject

public VWWorkObject fetchWorkObject(boolean lock,
                                    boolean overrideLock)
                             throws VWException
Fetches the work object that corresponds to this roster element.
Parameters:
lock - A Boolean value. Specify true to lock the work object. Specify false to leave the lock active.
overrideLock - A Boolean value. Specify true to override an existing lock on the work object.
Returns:
A VWWorkObject object that represents an element in the roster.
Throws:
VWException - Thrown if it cannot fetch the work object that corresponds to this roster element.

getFieldNames

public java.lang.String[] getFieldNames()
Lists the system-defined field names and user-defined exposed field names supported by the roster element.
Returns:
A string containing an array of the field names in the roster element.

getFieldValue

public java.lang.Object getFieldValue(java.lang.String fieldName)
                               throws VWException
Gets the value of a field in the roster element.
Parameters:
fieldName - The name of the field containing the value being retrieved.
Returns:
The value of the specified field. Objects and arrays of objects must be one of the following Java types: Integer, String, Double, Data, or Boolean. The field can have a null value.
Throws:
VWException - The method throws an exception if the field name specified in the fieldName parameter does not exist.

isSystemField

public boolean isSystemField(java.lang.String fieldName)
                      throws VWException
Determines whether the field is a system field.
Parameters:
fieldName - The name to be checked.
Returns:
A Boolean value. The method returns true if the field specified in the fieldName parameter is a system field; otherwise, the method returns false.
Throws:
VWException - Thrown if it cannot determine whether the field is a system field.

hasFieldName

public boolean hasFieldName(java.lang.String fieldName)
                     throws VWException
Determines whether the specified field exists.
Parameters:
fieldName - The name of the field being checked.
Returns:
A Boolean value. The method returns true if the field specified in the fieldName parameter exists; otherwise, the method returns false.
Throws:
VWException - The method throws an exception if the field name specified in the fieldName parameter is null.

getWorkObjectName

public java.lang.String getWorkObjectName()
                                   throws VWException
Gets the work object name.
Returns:
The work object name. The string contains the name user entered in the work object ID field on the work class properties page in Composer.
Throws:
VWException - Thrown if it cannot get the work object name.

getWorkObjectNumber

public java.lang.String getWorkObjectNumber()
                                     throws VWException
Gets the work object number (as a string). You can use the string for an index value.
Returns:
The work object number, which corresponds to the F_WobNum queue field.
Throws:
VWException - Thrown if it cannot get the work object number.

getTag

public java.lang.String getTag()
                        throws VWException
Gets the tag of the work object (as a string).
Returns:
The tag. The work object name is normalized and saved as a tag in the database. The normalization process makes sorting work object names that include integers consistently reproducible.
Throws:
VWException - Thrown if it cannot get the tag of the work object.

getServerLocation

public int getServerLocation()
                      throws VWException
Gets the current server location of the work object.
Overrides:
getServerLocation in class filenet.vw.api.VWFieldsObject
Returns:
A integer value indicating the number of the server on which the work object resides.
Throws:
VWException - Thrown if it cannot get the current server location of the work object.

toString

public java.lang.String toString()
Gets a string version of a work object name.
Overrides:
toString in class java.lang.Object
Returns:
The name of the work object.

getProcess

public VWProcess getProcess()
                     throws VWException
Deprecated. Replaced by VWStepElement.fetchProcess() or VWWorkObject.fetchProcess(), depending on the type of process

Gets the workflow process associated with the roster element. Once you have the process object, you can retrieve a work object from the process and fetch the associated VWAttachments and VWStepElement.
Returns:
A VWProcess object that represents the roster element.
Throws:
VWException - Thrown if it cannot get the workflow process associated with the roster element.
Since:
VWWS3.10

getDataFields

public VWDataField[] getDataFields()
                            throws VWException
Lists exposed data fields this roster element supports. These fields are not modifiable from the roster element.
Returns:
A array of VWDataField objects that represent the exposed data fields supported by the roster element.
Throws:
VWException - Thrown if it cannot list exposed data fields supported by the roster element.
Since:
VWWS3.10
See Also:
VWDataField

getRosterName

public java.lang.String getRosterName()
                               throws VWException
Returns the name of the roster.
Returns:
The associated roster name for the work object.
Throws:
VWException - Thrown if it cannot return the name of the roster.
Since:
VWWS3.10

getLaunchDate

public java.util.Date getLaunchDate()
                             throws VWException
Gets the launch date of the workflow process that contains the work object.
Returns:
A date value that indicates the launch date of the workflow process that contains the work object. If the field does not exist, the method returns null.
Throws:
VWException - Thrown if it cannot get the launch date of the workflow process that contains the work object.
Since:
VWWS3.10

getOriginator

public java.lang.String getOriginator()
                               throws VWException
Gets the name of the user who initiated the workflow process that contains this work object.
Returns:
The name of the user who launched the workflow process that contains the work object. If the field does not exist, the method returns null.
Throws:
VWException - Thrown if it cannot get the name of the user who launched the workflow process that contains the work object.
Since:
VWWS3.10

getWorkFlowNumber

public java.lang.String getWorkFlowNumber()
                                   throws VWException
Deprecated. Replaced by getWorkflowNumber()

Gets the string version of the WorkFlow number. You can use the returned F_WorkFlowNumber as an index key component.
Overrides:
getWorkFlowNumber in class filenet.vw.api.VWFieldsObject
Returns:
The workflow object number as a string, which corresponds to the F_WorkFlowNumber. If the field does not exist, the method returns null.
Throws:
VWException - Thrown if it cannot get the string version of the WorkFlow number.

getWorkflowNumber

public java.lang.String getWorkflowNumber()
                                   throws VWException
Gets the string version of the WorkFlow number. You can use the returned F_WorkFlowNumber as an index key component.
Returns:
The workflow object number as a string, which corresponds to the F_WorkFlowNumber. If the field does not exist, the method returns null.
Throws:
VWException - Thrown if it cannot get the string version of the WorkFlow number.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML string that represents this VWRosterElement object to the buffer specified by the input parameter.
Specified by:
toXML in interface IVWtoXML
Parameters:
theBuffer - A string buffer that this method will append with XML content.
Throws:
VWException -  
See Also:
VWXMLUtil

getStepName

public java.lang.String getStepName()
                             throws VWException
Gets the step name.
Returns:
A String containing the step name. A null value means that the field does not exist.
Throws:
VWException - Thrown if the method is unable to get a string containing the step name.

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.