|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWParticipantList
public final class VWParticipantList
Use the VWParticipantList class to query a list of participants (VWParticipant objects).
Create a VWParticipantList object with
VWSession.findUsersByDomain(String, String, int, int, int)
,
VWSession.findGroupsByDomain(String, String, int, int, int)
,
VWSession.fetchUsersPx(int, boolean)
, or
VWSession.fetchUserGroupsPx(int)
.
Use the VWParticipantList next()
and hasNext()
methods to fetch
either user or group participants, or both user and group
participants.
The next() hasNext() methods function similarly to the next() and
hasNext() methods in the Iterator interface of the Java 2
language. A retrieval series completes when the next() method
returns a null or the hasNext() method returns false
.
VWParticipant
,
Serialized FormField Summary | |
---|---|
static int |
LIST_GROUP
Value of 2; indicates the listing type is "Group". |
static int |
LIST_USER
Value of 1; indicates the listing type is "User". |
static int |
LIST_USER_AND_GROUP
Value of 3; indicates the listing type is "User and Group". |
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. |
boolean |
hasNext()
Indicates whether another element can be fetched from this VWParticipantList instance. |
java.lang.Object |
next()
Retrieves the subsequent element for the current VWParticipantList instance. |
void |
resetFetch()
Resets the last element fetched for this VWParticipantList object to the beginning of the query series |
java.lang.String |
toString()
Gets the current in-memory participant list. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int LIST_USER
public static final int LIST_GROUP
public static final int LIST_USER_AND_GROUP
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 void resetFetch()
public java.lang.Object next() throws VWException
After a set of items in the current retrieval buffer is exhausted, additional items are retrieved into a buffer from the Process Engine. Buffer block size is specified in units of the number of records, and the effective buffer block is the lesser of the number specified with the VWParticipantList instance creating call and the number imposed by the Process Engine's current server limit. You can modify the buffer size (and retrieval performance) by changing the input buffer size in the VWParticipantList instance creating call.
Note: The returned object should be cast to a VWParticipant type.
VWException
VWSession.fetchUsersPx(int, boolean)
,
VWSession.fetchUserGroupsPx(int)
,
VWSession.findUsersByDomain(String, String, int, int, int)
,
VWSession.findGroupsByDomain(String, String, int, int, int)
,
VWParticipant
,
hasNext()
public boolean hasNext() throws VWException
true
if there are more elements that
can be fetched.
VWException
next()
public java.lang.String toString()
toString
in class java.lang.Object
next()
,
VWParticipant
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |