View Javadoc

1   package net.sf.josceleton.connection.api.service.user;
2   
3   import net.sf.josceleton.core.api.async.Async;
4   
5   /**
6    * Provides access to available users and their state, specific to a single connection.
7    * 
8    * It offers two ways of getting user information:
9    * <ul>
10   *   <li><b>Getter</b>: MINOR @DOC getCurrentUserCollection().getWaiting/getProcessingUsers():ImmutableIterable</li>
11   *   <li><b>Async</b>: one callback method for each {@link UserState} (<code>WAITING</code>, <code>PROCESSING</code>, 
12   *   					<code>DEAD</code>), all receiving an {@link User} argument associated with the message.</li>
13   * </ul>
14   * 
15   * @since 0.3
16   * @see Connection#getUserService()
17   */
18  public interface UserService extends Async<UserServiceListener>, AvailableUsersCollection {
19  	
20  	// merge interface only
21  	
22  }