02/28/2005
 

com.epicentric.users
Class MultiUserSet

java.lang.Object
  |
  +--com.epicentric.users.MultiUserSet
All Implemented Interfaces:
UserSet

Deprecated. as of Version 4.0, to be removed in 8.0 or later; instead, see the new com.epicentric.user package.

public class MultiUserSet
extends Object
implements UserSet


Constructor Summary
MultiUserSet()
          Deprecated.  
 
Method Summary
 boolean add(UserSet set)
          Deprecated. Adds a UserSet to the queue of sets that this MultiUserSet will iterate over.
 void close()
          Deprecated. Closes all UserSets remaining in the queue.
protected  void finalize()
          Deprecated. Makes sure all database resources are returned when this object is garbage collected.
 int getNumUserSets()
          Deprecated. Returns the number of UserSets remaining in the queue.
 User getUser()
          Deprecated. Returns the next User from the queue or null if no more users are in the queue.
 boolean next()
          Deprecated. Move the cursor forward one step in the queue of users.
 boolean next(int numUsers)
          Deprecated. Move the cursor forward the given number of users.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MultiUserSet

public MultiUserSet()
Deprecated. 
Method Detail

add

public boolean add(UserSet set)
Deprecated. 
Adds a UserSet to the queue of sets that this MultiUserSet will iterate over. Returns true if the UserSet was added successfully, false if the UserSet was not added for some reason (e.g., the UserSet was null, etc.).

next

public boolean next()
Deprecated. 
Move the cursor forward one step in the queue of users. If this causes a UserSet to be emptied, that set will be closed and removed from the queue. Returns true if there are more users in the queue, false if no users remain in the queue.
Specified by:
next in interface UserSet

next

public boolean next(int numUsers)
Deprecated. 
Move the cursor forward the given number of users. Returns false if it passes the end of the set of users in the current UserSet and no additional UserSets remain in the queue. This is a convenience method for skipping over users: next(1) is equivalent to next(). A zero or negative numUsers will do nothing.
Specified by:
next in interface UserSet

getUser

public User getUser()
Deprecated. 
Returns the next User from the queue or null if no more users are in the queue. If a UserSet returns no users, it is closed and removed from the queue.
Specified by:
getUser in interface UserSet
Following copied from interface: com.epicentric.users.UserSet
Returns:
The user at the current position in the user set or null if the current position is empty

getNumUserSets

public int getNumUserSets()
Deprecated. 
Returns the number of UserSets remaining in the queue.

close

public void close()
Deprecated. 
Closes all UserSets remaining in the queue.
Specified by:
close in interface UserSet

finalize

protected void finalize()
Deprecated. 
Makes sure all database resources are returned when this object is garbage collected.
Overrides:
finalize in class Object

02/28/2005
 

Copyright and Trademark Notices