Process API

filenet.vw.api
Class VWParticipantList

java.lang.Object
  extended by filenet.vw.api.VWParticipantList
All Implemented Interfaces:
java.io.Serializable

public final class VWParticipantList
extends java.lang.Object
implements java.io.Serializable

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.

See Also:
VWParticipant, Serialized Form

Field 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

LIST_USER

public static final int LIST_USER
Value of 1; indicates the listing type is "User".

See Also:
Constant Field Values

LIST_GROUP

public static final int LIST_GROUP
Value of 2; indicates the listing type is "Group".

See Also:
Constant Field Values

LIST_USER_AND_GROUP

public static final int LIST_USER_AND_GROUP
Value of 3; indicates the listing type is "User and Group".

See Also:
Constant Field Values
Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.


_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.


_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.


resetFetch

public void resetFetch()
Resets the last element fetched for this VWParticipantList object to the beginning of the query series.

Since:
VWWS3.10

next

public java.lang.Object next()
                      throws VWException
Retrieves the subsequent element for the current VWParticipantList instance. Invoke this method repeatedly to retrieve a series of objects that should be cast to a VWParticipant type. Returns null when no more objects remain to be retrieved.

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.

Returns:
An object that represents an item of the fetch type specified by the query creating call. Null indicates there are no unretrieved objects in the series.

Note: The returned object should be cast to a VWParticipant type.

Throws:
VWException
Since:
VWWS3.10
See Also:
VWSession.fetchUsersPx(int, boolean), VWSession.fetchUserGroupsPx(int), VWSession.findUsersByDomain(String, String, int, int, int), VWSession.findGroupsByDomain(String, String, int, int, int), VWParticipant, hasNext()

hasNext

public boolean hasNext()
                throws VWException
Indicates whether another element can be fetched from this VWParticipantList instance.

Returns:
true if there are more elements that can be fetched.
Note
This method requires a buffer size greater than 1 to operate properly.
Throws:
VWException
See Also:
next()

toString

public java.lang.String toString()
Gets the current in-memory participant list. The in-memory list is empty until the next() method has been called. Subsequently, the number of elements held in memory is determined by the buffer size of the creating call for this instance of VWParticipantList.

Overrides:
toString in class java.lang.Object
Returns:
A String containing the short user/group names, delimited by commas. If no more participant items remain in the in-memory buffer, this method returns null.
Since:
VWWS3.10
See Also:
next(), VWParticipant

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.