com.bea.wli.profile.api
Interface UserProfile


public interface UserProfile

Since:
9.2

Method Summary
 void deleteUserProfile(String userid)
          Removes this user information from the WLI database
 String[] getAllUserIds()
          Returns all the user names with in the WLS server
 String getUserCalendarId(String userid)
          Retrieve the calendar id for this user
 String getUserEmail(String userid)
          Retrieve the email address for this user.
 void sync()
          Removes all user profiles from users that do not exist in WLS
 void unsetUserCalendar(String userid)
          Unsets the calendar for this user.
 void updateUserCalendar(String userid, String calendarId)
          Sets the calendar for this user.
 void updateUserEmail(String userid, String email)
          Sets the email address for this user.
 boolean userExistsWLS(String userId)
           
 

Method Detail

updateUserEmail

void updateUserEmail(String userid,
                     String email)
                     throws ProfileException,
                            RemoteException
Sets the email address for this user. A user record is created if it does not exist in the WLI database. Exception is thrown if the user is not a valid WLS user.

Parameters:
userid -
email -
Throws:
ProfileException
RemoteException

getUserEmail

String getUserEmail(String userid)
                    throws ProfileException,
                           RemoteException
Retrieve the email address for this user.

Parameters:
userid -
Returns:
The email address of the user or null if there is no email address is found.
Throws:
ProfileException
RemoteException

updateUserCalendar

void updateUserCalendar(String userid,
                        String calendarId)
                        throws ProfileException,
                               RemoteException
Sets the calendar for this user. A user record is created if it does not exist in the WLI database. Exception is thrown if the calendar does not exist or the user is not a valid WLS user.

Parameters:
userid -
calendarId -
Throws:
ProfileException
RemoteException

unsetUserCalendar

void unsetUserCalendar(String userid)
                       throws ProfileException,
                              RemoteException
Unsets the calendar for this user.

Parameters:
userid -
Throws:
ProfileException
RemoteException

getUserCalendarId

String getUserCalendarId(String userid)
                         throws ProfileException,
                                RemoteException
Retrieve the calendar id for this user

Parameters:
userid -
Returns:
The calendar id for the user or null if there is no calendar.
Throws:
ProfileException
RemoteException

deleteUserProfile

void deleteUserProfile(String userid)
                       throws ProfileException,
                              RemoteException
Removes this user information from the WLI database

Parameters:
userid -
Throws:
ProfileException
RemoteException

sync

void sync()
          throws ProfileException,
                 RemoteException
Removes all user profiles from users that do not exist in WLS

Throws:
ProfileException
RemoteException

userExistsWLS

boolean userExistsWLS(String userId)
                      throws ProfileException,
                             RemoteException
Parameters:
userId -
Returns:
Throws:
ProfileException
RemoteException

getAllUserIds

String[] getAllUserIds()
                       throws RemoteException
Returns all the user names with in the WLS server

Returns:
All user names
Throws:
RemoteException