Process Class Relationships

filenet.vw.api
Class VWSecurityList

java.lang.Object
  |
  +--filenet.vw.api.VWSecurityList

public final class VWSecurityList
extends java.lang.Object

Use this class to query for a security list.

Once the VWSession.fetchUser() or the Session.fetchGroupNames() 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 implements Iterator methods next() and hasNext() to handle the new collection model in Java 2. A query ends when the next() method returns null values. Call the hasNext() method if you wish to determine whether more elements are available.


Method Summary
 boolean hasNext()
          Determines whether the iteration has more elements.
 java.lang.Object next()
          Retrieves the user and group names.
 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 user and group names. Call the method repeatedly until no more objects can be fetched.

Before using this method, create the VWSecurityList object using the VWSession.fetchUsers() or the VWSession.fetchUserGroups() method. These method sets the buffer size for retrieval from the server in the VWSecurityList object. Set the buffer size to greater than 1 (one).

Returns:
An object that represent an items of the type specified in the VWSession.fetchUsers() or VWSession.fetchUserGroups() methodCast the object to String. If no more elements exists, the method returns null.
Throws:
VWException - Thrown if it cannot retrieve the user and group names.
Since:
VWWS3.10

hasNext

public boolean hasNext()
                throws VWException
Determines whether the iteration has more elements.
Returns:
A boolean value. The method returns true if more queue elements exist. The method returns false if no more queue elements exist.
Throws:
VWException -  

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

Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.