oracle.discussions.ws
Interface UserService

public interface UserService

Webservice interface providing Oracle Discussions user access operations. Provides the following methods to retrieve a OCS user based on the user's attributes.

• Get user by Nickname
• Get user by EmailAddress
• 
  Axis specific Sample code illustrating the invocation/usage of UserService.Relevant changes are to be done, if a non-axis web services client is used.

 //Initialize the webservice locator.The locator contains information about webservices endpoint. 
 UserServiceServiceLocator mdssl = new UserServiceServiceLocator();
 //Retrieve a reference to the remote webservices interface.
 UserService mdsl = mdssl.getUserService();
 //Notify the axis server that client is interested in maintaining session.
 ((UserServiceSoapBindingStub)mdsl).setMaintainSession(true);
 //Set the cookie, retrieved during login service invocation.
 ((javax.xml.rpc.Stub)mdsl)._setProperty(HTTPConstants.HEADER_COOKIE,cookie);
 //Invoke the webservices method.
 User user = mdsl.getUserByNickname("td_superuser");
 {
 //Process the user bean
 ........
 }
 

Method Summary

User	getUserByEmail(java.lang.String userEmailAddress) Returns the user based on the user's email address.
User	getUserByNickname(java.lang.String userNickname) Returns the user based on the user's nickname.

Method Detail

getUserByNickname

public User getUserByNickname(java.lang.String userNickname)
                       throws TdWSException

Returns the user based on the user's nickname. An exception is raised if an invalid user nickname is provided.

Parameters:

userNickname - - User's nickname on which the user is to be retrieved.

Returns:

User - The user bean representing the user retrieved.

Throws:

TdWSException - - Thrown on any error in retrieving the user or if the user nickname is not found in the OID.

getUserByEmail

public User getUserByEmail(java.lang.String userEmailAddress)
                    throws TdWSException

Returns the user based on the user's email address. An exception is raised if an invalid user email address is provided.

Returns:

User - The user bean representing the user retrieved.

Throws:

TdWSException - - Thrown on any error in retrieving the user or if the user email is invalid.