| org.gridsphere.services.core.user.User
All known Subclasses: org.gridsphere.services.core.user.impl.UserImpl,
User | public interface User (Code) | | The User interface is an abstract view on the user-specific data.
Apart from a set of pre-defined, fixed set of attributes,
the interface gives access to user profile data.
|
Method Summary | |
public Object | getAttribute(String name) Returns the value of the attribute with the given name,
or null if no attribute with the given name exists. | public Enumeration | getAttributeNames() Returns an enumeration of names of all attributes available to this
request. | public String | getEmailAddress() Returns the given e-mail of the user or null if none
is available. | public String | getFirstName() Returns the family (aka last) name of the user. | public String | getFullName() Returns the full name of the user, or null if the full name is not
available. | public String | getID() Returns the internal unique user id. | public Long | getLastLoginTime() Returns the point of time that this user was last logged in, or
null if this information is not available. | public String | getLastName() Returns the last name of the user. | public Integer | getNumLogins() | public String | getOrganization() | public String | getUserID() Returns the user id of the user, or null if the user id
is not available. | public String | getUserName() This is an alias for the getUserID method, which for all intensive
purposes represents the name required for this user to login. | public void | setAttribute(String name, String value) | public void | setEmailAddress(String emailAddress) Sets the given e-mail of the user. | public void | setFirstName(String firstName) Sets the first name of the user. | public void | setFullName(String fullName) Sets the full name of the user, or null if the full name is not available. | public void | setID(String id) Sets the internal unique user id. | public void | setLastLoginTime(Long lastLoginTime) Sets the point of time that this user was last logged in, or null if this
information is not available. | public void | setLastName(String lastName) Sets the last name of the user. | public void | setNumLogins(Integer numLogins) | public void | setOrganization(String organization) | public void | setUserID(String userID) Sets the user id of the user, or null if the user id is not available. | public void | setUserName(String userName) This is an alias for the setUserID method, which for all intensive
purposes represents the name required for this user to login. | public String | toString() |
LOCALE | final public static String LOCALE(Code) | | Users locale preference stored as an attribute with this key
|
getAttribute | public Object getAttribute(String name)(Code) | | Returns the value of the attribute with the given name,
or null if no attribute with the given name exists.
Parameters: name - the attribute name the attribute value |
getAttributeNames | public Enumeration getAttributeNames()(Code) | | Returns an enumeration of names of all attributes available to this
request. This method returns an empty enumeration if the request has
no attributes available to it.
an enumeration of attribute names |
getEmailAddress | public String getEmailAddress()(Code) | | Returns the given e-mail of the user or null if none
is available.
the email address |
getFirstName | public String getFirstName()(Code) | | Returns the family (aka last) name of the user.
the family name |
getFullName | public String getFullName()(Code) | | Returns the full name of the user, or null if the full name is not
available. The full name contains given names, family names and possibly
a title or suffix. Therefore, the full name may be different from the
concatenation of given and family name.
the full name |
getID | public String getID()(Code) | | Returns the internal unique user id.
the internal unique user id |
getLastLoginTime | public Long getLastLoginTime()(Code) | | Returns the point of time that this user was last logged in, or
null if this information is not available.
The time is returned in number of milliseconds since January 1, 1970 GMT.
the last login time |
getLastName | public String getLastName()(Code) | | Returns the last name of the user.
the last name |
getNumLogins | public Integer getNumLogins()(Code) | | Returns the number of login occurences for this user
the number of login occurences |
getOrganization | public String getOrganization()(Code) | | Returns the organization affiliation association of the user
the organization name |
getUserID | public String getUserID()(Code) | | Returns the user id of the user, or null if the user id
is not available. The userid is the user's login name
the user id See Also: User.getUserName |
getUserName | public String getUserName()(Code) | | This is an alias for the getUserID method, which for all intensive
purposes represents the name required for this user to login.
String the user id See Also: User.getUserID |
setAttribute | public void setAttribute(String name, String value)(Code) | | Sets the value of the attribute with the given name,
Parameters: name - the attribute name Parameters: value - the attribute value |
setEmailAddress | public void setEmailAddress(String emailAddress)(Code) | | Sets the given e-mail of the user.
Parameters: emailAddress - the email address |
setFirstName | public void setFirstName(String firstName)(Code) | | Sets the first name of the user.
Parameters: firstName - the first name |
setFullName | public void setFullName(String fullName)(Code) | | Sets the full name of the user, or null if the full name is not available.
The full name contains given names, family names and possibly a title or suffix.
Therefore, the full name may be different from the concatenation of given and family name.
Parameters: fullName - the full name |
setID | public void setID(String id)(Code) | | Sets the internal unique user id.
Parameters: id - the internal unique id |
setLastLoginTime | public void setLastLoginTime(Long lastLoginTime)(Code) | | Sets the point of time that this user was last logged in, or null if this
information is not available. The time is returned in number of milliseconds
since January 1, 1970 GMT.
Parameters: lastLoginTime - the last login time |
setLastName | public void setLastName(String lastName)(Code) | | Sets the last name of the user.
Parameters: lastName - the last name |
setNumLogins | public void setNumLogins(Integer numLogins)(Code) | | Sets the number of logins occurences for this user
Parameters: numLogins - the last login time |
setOrganization | public void setOrganization(String organization)(Code) | | Sets the organization the user belongs to
Parameters: organization - the organization name |
setUserID | public void setUserID(String userID)(Code) | | Sets the user id of the user, or null if the user id is not available.
Parameters: userID - the user id |
setUserName | public void setUserName(String userName)(Code) | | This is an alias for the setUserID method, which for all intensive
purposes represents the name required for this user to login.
Parameters: userName - the user name |
toString | public String toString()(Code) | | Returns a String representation of the User
User information represented as a String |
|
|