Process Class Relationships

filenet.vw.api
Class VWSecurityList

java.lang.Object
  |
  +--filenet.vw.api.VWSecurityList
All Implemented Interfaces:
java.io.Serializable

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

Use this class to query for a security list.

Once the VWSession.fetchUsers(int, boolean) or the VWSession.fetchUserGroups(int) methods create a VWSecurityList object, the next() method of this interface fetches the user names, group names, or both user and group names (depending on which methods you call and how you set the parameters).

VWSecurityList contains methods next() and hasNext() which function similarly to the next() and hasNext() methods in the Iterator interface in Java 2 to retrieve all the names in the current instance of this class. A retrieval series completes when the next() method returns a null value.

See Also:
Serialized Form

Method Summary
 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. Invoke this method repeatedly to retrieve a series of objects that should be cast to a String type.
 void resetFetch()
          Resets the last element fetched for this SecurityListQuery object.
 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

resetFetch

public void resetFetch()
Resets the last element fetched for this SecurityListQuery object. The new fetch results include previously fetched elements.
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 will be retrieved from the Process server and buffered. The effective buffer block size is the lesser of the number specified with a creating [VWSession.fetchUsers(int, boolean) or VWSession.fetchUserGroups(int)] call and the number imposed by the Process server limit. You can modify retrieval performance by changing the input buffer size in the creating method [VWSession.fetchUsers(int, boolean) or VWSession.fetchUserGroups(int)].

Returns:
An object that represents an item of the fetch type specified by the creating VWSession.fetchUsers(int, boolean) or VWSession.fetchUserGroups(int) 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 items in the security list exist, the method returns null.
Since:
VWWS3.10


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.