Oracle© Collaboration Suite Workspaces Web Services API Reference
10g Release 1 (10.1.2.2)

Part No. B28209-01


oracle.workspaces.ws
Interface UsersService


public interface UsersService

UsersService provides methods to operate on properties of users of workspaces.

The major operations supported include: retrieval of user properties, retrieval of all users in a group, retrieval of user preferences and updation of user preferences

The Axis specific code snippet given below, illustrates how users within a group can be retrieved.

   // Invoke an instance of user service locator and get a handle to user service.
   UsersServiceServiceLocator ussl = new UsersServiceServiceLocator();
   UsersService uService = ussl.getUsersService();
   // Invoke method to list all users in a OID group given the group name.
   String[] attrRequest = {"invalid"};
   oracle.workspaces.ws.beans.User[] users = uService.getMembersByGroupName("testgroup1", attrRequest);
 

Method Summary
 User[] getMembersByGroupDN(java.lang.String groupDN, java.lang.String[] attrRequest)
          Lists all the users in the group specified.
 User[] getMembersByGroupName(java.lang.String groupCN, java.lang.String[] attrRequest)
          Lists all the users in the group specified.
 UserPreferences getMyPreferences()
          Returns the preferences of the current user.
 UserPresenceStatus[] getPresenceStatus(java.lang.String[] userNicknames)
          Retrieves the presence status, given the users' nicknames.
 User getUserFromNickName(java.lang.String userNickname, java.lang.String[] attrRequest)
          Retrieves the user, given his nickname.
 void updateMyPreferences(UserPreferences userPreferences)
          Update the preferences for the current user.

 

Method Detail

getUserFromNickName

public User getUserFromNickName(java.lang.String userNickname,
                                java.lang.String[] attrRequest)
                         throws CwWSException
Retrieves the user, given his nickname.
Parameters:
userNickname -
attrRequest - - Can request optional user presence information like CLIENT_LAUNCH_URI - Uri to launch the RTC client for the user. STATUS_IMAGE_URL - Image indicating the status of the user. STATUS_URL - Url which gives the status of the user.
Returns:
- user bean representing the user retrieved.
Throws:
CwWSException

getMembersByGroupDN

public User[] getMembersByGroupDN(java.lang.String groupDN,
                                  java.lang.String[] attrRequest)
                           throws CwWSException
Lists all the users in the group specified.
Parameters:
groupDN - - Distinguished name of the group in which the users are present.
attrRequest - - Can request optional user presence information like CLIENT_LAUNCH_URI - Uri to launch the RTC client for the user. STATUS_IMAGE_URL - Image indicating the status of the user. STATUS_URL - Url which gives the status of the user.
Returns:
- User[] representing the user objects in the group.
Throws:
CwWSException

getMembersByGroupName

public User[] getMembersByGroupName(java.lang.String groupCN,
                                    java.lang.String[] attrRequest)
                             throws CwWSException
Lists all the users in the group specified.
Parameters:
groupCN - - CN of the group in which the users are present.
attrRequest - - Can request optional user presence information like CLIENT_LAUNCH_URI - Uri to launch the RTC client for the user. STATUS_IMAGE_URL - Image indicating the status of the user. STATUS_URL - Url which gives the status of the user.
Returns:
- User[] representing the user objects in the group.
Throws:
CwWSException

getMyPreferences

public UserPreferences getMyPreferences()
                                 throws CwWSException
Returns the preferences of the current user.
Returns:
- UserPreferences representing the preferences of the current logged in user.
Throws:
CwWSException

updateMyPreferences

public void updateMyPreferences(UserPreferences userPreferences)
                         throws CwWSException
Update the preferences for the current user.
Parameters:
userPreferences - - UserPreferences representing the preferences to be updated for the current logged in user. NOTE: Locale and TimeZone are read-only properties. Cannot be set using this call. Also, use the charset and language attributes while setting and not their display names. The display names are read-only.
Throws:
CwWSException

getPresenceStatus

public UserPresenceStatus[] getPresenceStatus(java.lang.String[] userNicknames)
                                       throws CwWSException
Retrieves the presence status, given the users' nicknames.
Parameters:
userNicknames - - Nicknames of the users whose presence status need to be retrieved.
Returns:
- UserPresenceStatus bean array representing the presence status of the given users.
Throws:
CwWSException

Copyright © 2001, 2006, Oracle. All rights reserved.