|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWSecurityList
public final class VWSecurityList
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
.
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 |
---|
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 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.
VWException
VWSession.fetchUsers(int, boolean)
,
VWSession.fetchUserGroups(int)
,
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
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |