Process API

filenet.vw.api
Class VWSecurityList

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

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

Use the VWSecurityList class to query a list of user objects.

Create a VWSecurityList object with VWSession.findUsers(String, int, int, int), VWSession.findGroups(String, int, int, int), VWSession.fetchUsers(int, boolean), or VWSession.fetchUserGroups(int).

Use the VWSecurityList next() and hasNext() methods to fetch either user or group names, or both user and group names.

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:
Serialized Form

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 VWSecurityList instance.
 java.lang.Object next()
          Retrieves the subsequent element for the current VWSecurityList instance.
 void resetFetch()
          Resets the last element fetched for this VWSecurityList object to the beginning of the query series
 java.lang.String toString()
          Gets the in-memory security list.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

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 VWSecurityList 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 VWSecurityList instance. Invoke this method repeatedly to retrieve a series of objects that should be cast to a String type. Returns null when no more objects can be returned.

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 VWSecurityList 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 VWSecurityList instance creating call.

Returns:
An object that represents an item of the fetch type specified by the creating call or null (indicating there are no more objects in the series).
Note
The returned object should be cast to a String type.
Throws:
VWException
Since:
VWWS3.10
See Also:
VWSession.fetchUsers(int, boolean), VWSession.fetchUserGroups(int), hasNext()

hasNext

public boolean hasNext()
                throws VWException
Indicates whether another element can be fetched from this VWSecurityList 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 in-memory security list. The number of elements held in memory is determined by the buffer size, and the in-memory list will be empty until the next() method has been called.

Overrides:
toString in class java.lang.Object
Returns:
A string containing user/group names as a comma delimited string. If no more security items remain in the in-memory buffer, the method returns null.
Since:
VWWS3.10

Process API

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