|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWQueueQuery
filenet.vw.api.VWWorkBasket
public class VWWorkBasket
Use this class to retrieve information about a workbasket, its columns, filters, or query results.
Nested Class Summary | |
---|---|
static class |
VWWorkBasket.Column
Represents a read-only, runtime column for the workbasket. |
static class |
VWWorkBasket.Filter
Represents a read-only, runtime filter for the workbasket. |
static class |
VWWorkBasket.QueryResults
Represents the query result as returned by the fetchNextBatch
method. |
Field Summary | |
---|---|
static int |
QUERY_GET_NO_SYSTEM_FIELDS
Deprecated. see VWRoster, VWQueue |
static int |
QUERY_GET_NO_TRANSLATED_SYSTEM_FIELDS
Deprecated. see VWRoster, VWQueue |
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. See the queryFlags parameter of VWRoster.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int) and VWQueue.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int) . |
static int |
QUERY_LOCK_OBJECTS
Deprecated. see VWQueue |
static int |
QUERY_MAX_VALUES_INCLUSIVE
Deprecated. see VWLog, VWRoster, VWQueue |
static int |
QUERY_MIN_VALUES_INCLUSIVE
Deprecated. see VWLog, VWRoster, VWQueue |
static int |
QUERY_NO_OPTIONS
Deprecated. see VWLog, VWRoster, VWQueue |
static int |
QUERY_READ_BOUND
Deprecated. see VWQueue |
static int |
QUERY_READ_LOCKED
Deprecated. see VWQueue |
static int |
QUERY_READ_UNWRITABLE
Deprecated. see VWRoster, VWQueue |
static int |
QUERY_RESOLVE_NAMES
Deprecated. see VWRoster, VWQueue |
static int |
QUERY_TRANSLATE_QUERY_FILTER
Deprecated. see VWRoster, VWQueue |
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. |
VWWorkBasket.QueryResults |
fetchNextBatch(int query_flags,
int buffer_size,
java.lang.String sort_column,
java.lang.String[] filter_names,
java.lang.Object[] substitution_vars,
java.lang.String lastWorkRecStr,
int fetch_type)
Gets the next batch of query results based on the specified criteria. |
VWAttributeInfo |
getAttributeInfo()
Gets the workbasket attributes as paired labels (hashtable keys) and values in String format. |
java.lang.String |
getAuthoredName()
Gets the original workbasket name. |
int |
getBufferSize()
Gets the maximum number of elements set by the user to return in a fetch. |
VWWorkBasket.Column[] |
getColumns()
Gets the columns defined for the workbasket. |
java.lang.String |
getDescription()
Gets the work basket description. |
VWWorkBasket.Filter[] |
getFilters()
Gets the filters defined for the workbasket. |
int |
getId()
Gets the object ID of the workbasket. |
java.lang.String |
getName()
Gets the current workbasket name. |
VWQueue |
getQueue()
Gets the queue with which the workbasket is associated. |
java.lang.String |
getQueueName()
Gets the name of the queue with which the workbasket is associated. |
int |
getRevision()
Gets the revision number of the workbasket. |
void |
setBufferSize(int newSize)
Sets the maximum number of elements to return in a fetch (defaults to 50). |
java.lang.String |
toString()
Gets a String representation of the workbasket information. |
Methods inherited from class filenet.vw.api.VWQueueQuery |
---|
fetchCount, fetchInstructionElements, fetchQueueElements, fetchWorkObjects, getElementType, hasNext, isDone, next, resetFetch |
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_LOCKED
VWRoster.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
and VWQueue.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
.
public static final int QUERY_READ_BOUND
VWRoster.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
and VWQueue.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
.
public static final int QUERY_READ_UNWRITABLE
VWRoster.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
and VWQueue.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
.
public static final int QUERY_LOCK_OBJECTS
VWRoster.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
and VWQueue.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
.
public static final int QUERY_MIN_VALUES_INCLUSIVE
VWRoster.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
and VWQueue.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
.
public static final int QUERY_MAX_VALUES_INCLUSIVE
VWRoster.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
and VWQueue.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
.
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
VWRoster.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
and VWQueue.createQuery(java.lang.String, java.lang.Object[], java.lang.Object[], int, java.lang.String, java.lang.Object[], int)
.
public static final int QUERY_GET_NO_SYSTEM_FIELDS
System fields and translated system fields are used in the helper methods for each object. Note that VWWorkObject objects have system fields that are not present in VWStepElement objects.
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 system fields to function properly.
public static final int QUERY_GET_NO_TRANSLATED_SYSTEM_FIELDS
Use for performance enhancement when methods on a retrieved object are not needed and only the returned data itself is needed.
System fields and translated system fields are used in the helper methods for each object. Note that VWWorkObject objects have system fields that are not present in VWStepElement objects. A VWStepElement object contains only parameter data if this flag is used. However, a VWWorkObject object will contain system fields even if this flag is used.
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 system fields to function properly.
public static final int QUERY_RESOLVE_NAMES
public static final int QUERY_TRANSLATE_QUERY_FILTER
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.lang.String getName() throws VWException
VWException
public java.lang.String getAuthoredName() throws VWException
VWException
public java.lang.String getDescription() throws VWException
VWException
public java.lang.String getQueueName()
public int getId()
public int getRevision() throws VWException
VWException
public VWAttributeInfo getAttributeInfo() throws VWException
VWException
public VWQueue getQueue()
getQueue
in class VWQueueQuery
VWException
VWQueue
public VWWorkBasket.Column[] getColumns()
public VWWorkBasket.Filter[] getFilters()
public VWWorkBasket.QueryResults fetchNextBatch(int query_flags, int buffer_size, java.lang.String sort_column, java.lang.String[] filter_names, java.lang.Object[] substitution_vars, java.lang.String lastWorkRecStr, int fetch_type) throws VWException
queryFlags
- An integer value that specifies the query options.
Use the | and + operators to combine the flags. See the QUERY_* properties on
VWQuery
for descriptions of the possible query flags.
buffer_size
- An integer value indicating the maximum number of elements
to return. The default is 50.sort_column
- A String containing the name of the column to sort by.filter_names
- A String array of the names of the filters to use for the query.substition_vars
- An array of objects containing the
values to substitute for the placeholder variables specified in the
SQL WHERE clause(s) for the filter(s).
A VWWorkObjectNumber
object can be used here in place of F_WobNum and
F_WorkFlowNumber. Queries to DB2 databases must use VWWorkObjectNumber instead
of F_WobNum or F_WorkFlowNumber.
If there are no placeholder variables in the specified filters, the values for the substitutionVars parameter will be ignored (and can be null). The array elements in this parameter are substituted, in corresponding order, for the placeholder variables in a filter.
Note: When using special SQL characters (such as, %), these characters need to be contained within the substitution string, and the entire substitution string must be quoted.
For example, if a filter contains three placeholder variables specified as ":A", there must be three corresponding substitution variables.
For example:
{new Integer(1000),"Smith"}
This substitutionVars parameter would have a corresponding filter with the following:
integerA < 1000 AND stringB = "Smith"
Note: Time columns in the database can be exposed as either 32-bit (can only support dates earlier than 2038) or 64-bit (can support dates beyond 2038). If a user has a filter on a 32-bit time field, the value bound to the bind variable in the query using that filter must be a value that can fit in 32-bits, otherwise the query will not return the expected result. For example:
"my32bitColumn < :a"
will not work correctly if bound to the date value "11/11/2099"; however, binding it to the value "11/11/2037" will return the expected result.
As a further example, assume the object being queried contains a row with two exposed fields, atime64 (64-bit) and atime32 (32-bit), and both fields have the date/time value "11/11/2008 12:12:12".
Using the filter:
String filter = "atime64 < :a AND atime32 < :b";
the following substitution variables will return the fetched row after applying the filter and substitutionVars in the query:
Object[] subsVars = {sdf.parse("2040-01-01 12:00:00"), sdf.parse("2020-01-01 12:00:00")}; // works
However, the following query will not be able to fetch the row, because it binds a value that will not fit in a 32-bit column:
Object[] subsVars = {sdf.parse("2040-01-01 12:00:00"), sdf.parse("2040-01-01 12:00:00")}; // does not work.
lastWorkRecStr
- A base64-encoded String containing the last record of the query
results. If this value is null, the query starts from the beginning.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:
VWException
public java.lang.String toString()
toString
in class VWQueueQuery
public int getBufferSize()
public void setBufferSize(int newSize) throws VWException
newSize
- This must be greater than zero.
VWException
- Thrown if buffer size is less than 0.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |