|
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.VWPersistentCollection | +--filenet.vw.api.VWRoster
Use this class to access the contents of a roster or manage
running workflows. Create an instance of this class with
VWSession.getRoster(). Create a query object for
an instance of this class with
VWRoster.createQuery
.
VWNewWorkObject
,
VWSession
Field Summary | |
static int |
QUERY_GET_NO_SYSTEM_FIELDS
Value of 1024. Include this value in the queryFlags parameter of the createQuery() method to return objects without system fields. |
static int |
QUERY_GET_NO_TRANSLATED_SYSTEM_FIELDS
Value of 2048. Include this value in the queryFlags parameter of the createQuery() method to return objects without translated fields. |
static int |
QUERY_GET_SYSTEM_FIELDS
Deprecated. Not replaced. This is the default. |
static int |
QUERY_GET_TRANSLATED_SYSTEM_FIELDS
Deprecated. Not replaced. This is the default. |
static int |
QUERY_MAX_VALUES_INCLUSIVE
Value of 64. Pass this value in the queryFlags parameter of the createQuery method to specify the inclusion of maximum search values. |
static int |
QUERY_MIN_VALUES_INCLUSIVE
Value of 32. Pass this value in the queryFlags parameter of the createQuery method to specify the inclusion of minimum search values. |
static int |
QUERY_NO_OPTIONS
Value of 0. Pass this value in the queryFlags parameter of the createQuery method to specify no search option. |
static int |
QUERY_READ_UNWRITABLE
Value of 4. Pass this value in the queryFlags parameter of the createQuery method to specify the return of Read-only work items. |
Method Summary | |
VWRosterQuery |
createQuery(java.lang.String indexName,
java.lang.Object[] minValues,
java.lang.Object[] maxValues,
int queryFlags,
java.lang.String filter,
java.lang.Object[] substitutionVars,
int fetchType)
Performs a filtered fetch of roster items. The filters specify search conditions flexibly and include setting a range for the search index. |
VWNewWorkObject |
createWorkObject()
Deprecated. Replaced by VWSession.createNewWorkObject(String) |
int |
fetchCount()
Gets an integer that indicates the number of work items in the roster. |
VWRosterDefinition |
fetchRosterDefinition()
Fetches the definition for this roster. |
VWRosterStats |
fetchStatistics(java.util.Date startTime,
java.util.Date endTime,
int timeUnits)
Fetches statistical information for the roster, given a start and stop time. |
int |
getBufferSize()
Gets an integer value indicating the maximum number of elements to return in a fetch. The default number is 50. |
int |
getCount()
Deprecated. Replaced by fetchCount() |
VWInjectSessionInfo |
getInjectSessionInfo(java.lang.String sessionName,
boolean nextName)
Deprecated. Replaced by VWSession.createLiveWorkObject(String[], Object[], String, int)
and VWCreateLiveWOResult . |
VWSession |
getServiceSession()
Identifies the session that originated the search object. |
void |
setBufferSize(int newSize)
Sets the integer value for the maximum number of elements to return in a fetch. The default value is 50. |
VWRosterQuery |
startQuery(java.lang.String indexName,
java.lang.Object[] minValues,
java.lang.Object[] maxValues,
int queryFlags,
java.lang.String filter,
java.lang.Object[] substitutionVars)
Deprecated. Replaced by createQuery(String, Object[], Object[], int, String, Object[], int) |
java.lang.String |
toString()
Gets the roster name. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int QUERY_NO_OPTIONS
After passing this value, the returned work items are unlocked, unbound, and writable. If you use this flag in conjunction with another flag, the value of the other flag becomes the value input to the parameter [for example, 0(this value) + n(another flag value) = n(the other flag value)].
public static final int QUERY_READ_UNWRITABLE
Setting this flag causes the application to read unwritable work items; not setting it causes the return of only writable work items.
public static final int QUERY_MIN_VALUES_INCLUSIVE
public static final int QUERY_MAX_VALUES_INCLUSIVE
public static final int QUERY_GET_SYSTEM_FIELDS
Use the system fields for additional queries on objects. A method that requires translation returns a default value (null, 0, or false). Helper methods require the QUERY_GET_TRANSLATED_SYSTEM_FIELDS to function properly.
public static final int QUERY_GET_TRANSLATED_SYSTEM_FIELDS
public static final int QUERY_GET_NO_SYSTEM_FIELDS
System fields and translated system fields are used in the helper methods for each element. System fields and translated system field data will not be returned on the objects queried. A method that requires translation returns a default value (null, 0, or false) for this flag. This is because related Helper methods require the system fields and translated fields to function properly.
public static final int QUERY_GET_NO_TRANSLATED_SYSTEM_FIELDS
Translated system fields are used in the helper methods for each element. System fields and translated system field data will not be returned on the objects queried. A method that requires translation returns a default value (null, 0, or false) for this flag. This is because related Helper methods require the system fields and translated fields to function properly.
Method Detail |
public VWNewWorkObject createWorkObject() throws VWException
VWSession.createNewWorkObject(String)
VWException
- Thrown if the method cannot
create the specified work item and save it to a
workflow roster.public int getCount() throws VWException
fetchCount()
VWException
- Thrown if the roster size cannot be
determined.public int fetchCount() throws VWException
VWException
- Thrown if the roster size cannot be
determined.public VWRosterQuery startQuery(java.lang.String indexName, java.lang.Object[] minValues, java.lang.Object[] maxValues, int queryFlags, java.lang.String filter, java.lang.Object[] substitutionVars) throws VWException
createQuery(String, Object[], Object[], int, String, Object[], int)
Specifying search conditions in this method causes the retrieval of roster items based on a filter condition and a range in a search index. Use the following to limit your search:
A roster item must match all fetch criteria specified in the parameters to return.
indexName
- The name of the database
search index for the roster. Specify either the name assigned
to the index at the Configuration Console (this may be a
user-defined search field, a system search field, or both) or a
system search field name.
The standard system search fields for rosters are listed below:
minValues
- An array of objects containing the minimum
values with which to compare the index fields.
The type of the array elements must correspond to the field types in the search index. If the number of minValues array elements is smaller than the number of search fields, the application assumes the fields at the end of the search index have no value. The array element must be of a Java type that corresponds to a Process type (integer, float, boolean, or string). For example, java.lang.Integer corresponds to integer.
For example, the index named 'myIndex' is an integer, followed by a string, followed by a boolean, followed by a float, followed by a time-type value:
myIndex = integerA + stringB + booleanC + floatD + timeE
Set sample minimum values, against which to compare the index, as follows:
Object[] minValues = {new Integer(1000), "aardvark",
new Boolean(true), new Float(0012345678.369), new Time([date&time value])}
maxValues
- An array of maximum values with which to compare
the index fields.
The type of the array elements must correspond to the field types in the search index. If the number of maxValues array elements is smaller than the number of search fields, the application assumes that the fields at the end of the search index have no value. The array element must be of a Java type that corresponds to a Process type (integer, float, boolean, or string). For example, java.lang.Integer corresponds to integer.
queryFlags
- An integer value that specifies the search options
Setting this parameter refines the search for the work items
specified by the search index. Use | and + operators to combine
the options. See the Field Detail section for description of
these query flags:
filter
- A string containing a SQL statement used to
specify filter conditions (used with values input to the
substitutionVars parameter).
Use this parameter with the parameter settings for minValues, maxValues, and queryFlags to refine the your search. Input a SQL where-clause that contains a search field name on the left side of a boolean operator and a substitution placeholder on the right side of the operator.
For example: if filter input is similar to the following SQL statements:
integerA < :A AND stringB =:A
This filter will make the object pass the filter only if it meets two conditions:
In the SQL statement, a colon (:) precedes each placeholder on the right side of the statement.
A search field must be a variable or a roster field, for example: F_Tag=:name. Using this filter requires that you substitute the placeholder to the right of each colon with a value you pass to the corresponding substitutionVars parameter.
substitutionVars
- An array of objects that contain the
values to substitute for the variable names to the right of
the colons in the SQL statement you passed to the filter
parameter.
A substitution variable must begin with colon. If there is no variable in the filter parameter, the values for this parameter can be null. The array elements in this parameter substitute for the corresponding array elements in the filter parameter array. The filter parameter array elements act as place holders and must be substituted. For example, if three names are :A, a user needs three distinct substitution variables.
For example, if you pass the following:
{new Integer(1000),"Smith"}
to the substitutionVars parameter to accompany the example for filter input, the object has to meet the following conditions to return:
integerA < 1000 AND stringB = "Smith"
VWException
- Thrown if the method cannot
fetch roster items.public VWRosterQuery createQuery(java.lang.String indexName, java.lang.Object[] minValues, java.lang.Object[] maxValues, int queryFlags, java.lang.String filter, java.lang.Object[] substitutionVars, int fetchType) throws VWException
This method employs the following kinds of condition descriptors to define the filters:
For this method to successfully return a given roster item, the roster item must pass all the fetch criteria specified by the input parameters.
indexName
- The name of the database search index
for the queue. Enter either the name assigned to the index at the
Configuration Console or a system search field
name. The standard system search fields for queues are listed below:
minValues
- An array of objects containing the minimum
values with which to compare the index fields.
Array element data types must match the corresponding data types in the search index. If the number of minValues array elements is smaller than the number of search fields, the unmatched search fields are ignored. The array element types must be Java data types that correspond to Process Operation Parameter types.
Example the index named 'myIndex' is an integer, followed by a string, followed by a boolean, followed by a float, followed by a time-type value:
myIndex = integerA + stringB + booleanC + floatD + timeE
Set minimum values for comparison to the index as shown in the following sample code snippet:
Object[] minValues = {new Integer(1000), "aardvark",
new Boolean(true), new Float(0012345678.369), new Time( [date/time value] )}
maxValues
- An array of objects containing the maximum
values with which to compare the index fields.
Array element data types must match the corresponding data types in the search index. If the number of maxValues array elements is smaller than the number of search fields, the unmatched search fields are ignored. The array element types must be Java data types that correspond to Process Operation Parameter types.
queryFlags
- An integer value that specifies the search options
Setting this parameter refines the search for the work items specified by the search index. Use | and + operators to combine these options, which are described below:
filter
- A SQL WHERE clause that specifies a filter condition
that is defined with values input to the substitutionVars
parameter.
Use this parameter with the parameter settings for minValues, maxValues, and queryFlags to refine the search. The SQL WHERE clause should contain a search field name on the left side of a boolean operator and a substitution placeholder on the right side of the operator.
Example:
Consider the following SQL WHERE clause:
integerA < :A AND stringB =:B
This filter specifies that the object passes the filter if it meets two conditions:
The following usage tips summarize the use of this parameter:
substitutionVars
- An array of objects that contain the
values to substitute for the variable names to the right of
the colons in the SQL statement you passed to the filter
parameter.
In accordance with SQL expression rules, a substitution variable begins with a colon, and the name itself immediately follows the colon. If there is no such substitution variable in the filter parameter, the values for the substitutionVars parameter will be ignored and can be null. The array elements in this parameter substitute for the corresponding substitution variable elements in the filter parameter array.
The filter parameter array elements contain ordered values that are substituted in order into the corresponding SQL substitution variables, which act as ordered placeholders. For example, if three names are :A (the same), a user needs three distinct substitution variables, and the values are assigned according to the ordered correspondences between the values of the substitutionVars parameter and the occurence of SQL substitution variables in the filter parameter expression.
Example:
Suppose a substitutionVars parameter
is specifed the follows:
{new Integer(1000),"Smith"}
If this substitutionVars parameter accompanies the above example for the filter parameter input, the object has to meet the following conditions to pass the filter:
integerA < 1000 AND stringB = "Smith"
The line above is the result of the ordered substitution of substitutionVars values into the SQL filter expression found in the filter parameter.
fetchType
- An integer value associated with the element type
to be retrieved using the object returned by VWRosterQuery.
Valid element type values must be one of the following:
VWRosterQuery.next()
method in a
manner similar to use of to the next() method of the Iterator
interface in Java 2.VWException
- VWFetchType
public VWSession getServiceSession()
getServiceSession
in class filenet.vw.api.VWPersistentCollection
public VWInjectSessionInfo getInjectSessionInfo(java.lang.String sessionName, boolean nextName) throws VWException
VWSession.createLiveWorkObject(String[], Object[], String, int)
and VWCreateLiveWOResult
.
sessionName
- The user-assigned name
of the inject session, which was passed in the sessionName
parameter of the VWNewWorkObject.saveMany() method.
nextName
- true
to retrieve information
about the next session after the session defined in the
sessionName parameter; false
to get
information for this session only.
Keep the following guidelines in mind:
VWException
- Thrown if the method cannot
get information about an inject session.VWCreateLiveWOResult
,
VWNewWorkObject
,
VWSession.createLiveWorkObject(String[], Object[], String, int)
public VWRosterStats fetchStatistics(java.util.Date startTime, java.util.Date endTime, int timeUnits) throws VWException
startTime
- A date value indicating the time to start
gathering statistics.endTime
- A date value indicating the time to stop
gathering statistics.timeUnits
- An integer value indicating the unit of time
for gathering statistics. Valid integer values for associated
with the time units are as follows:
VWException
- Thrown if the method cannot
fetch statistical information for the roster.VWTimeUnitType.MINUTES
,
VWTimeUnitType.HOURS
,
VWTimeUnitType.DAYS
,
VWTimeUnitType.WEEKS
,
VWTimeUnitType.MONTHS
,
VWTimeUnitType.YEARS
public java.lang.String toString()
toString
in class java.lang.Object
public int getBufferSize()
public void setBufferSize(int newSize) throws VWException
newSize
- An integer value specifying the maximum number
of elements to return in a fetch. The value must be greater
than 0.VWException
- Thrown if the
buffer size specified in the newSize parameter is less than or
equal to 0.public VWRosterDefinition fetchRosterDefinition() throws VWException
VWException
- Thrown if the method cannot
fetch the definition for this roster.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |