ca.bc.gov.webade.user
Interface WebADEUserInfo

All Known Subinterfaces:
BusinessPartnerUserInfo, GovernmentUserInfo, IndividualUserInfo
All Known Implementing Classes:
AbstractWebADEUserInfo, DefaultBusinessPartnerUserInfo, DefaultGovernmentUserInfo, DefaultIndividualUserInfo

public interface WebADEUserInfo

This interface defines the basic attributes and operations WebADE maintains about any user accessible via the configured user-info providers of the WebADE application.

Author:
jross

Field Summary
static java.lang.String DISPLAY_NAME
          The reserved attribute name for the display name attribute.
static java.lang.String EMAIL_ADDRESS
          The reserved attribute name for the email address attribute.
static java.lang.String EXPIRY_DATE
          The reserved attribute name for the expiry date attribute.
static java.lang.String FIRST_NAME
          The reserved attribute name for the first name attribute.
static java.lang.String IS_VISIBLE
          The reserved attribute name for the is-visible attribute.
static java.lang.String LAST_NAME
          The reserved attribute name for the last name attribute.
static java.lang.String MIDDLE_INITIAL
          The reserved attribute name for the middle initial attribute.
static java.lang.String PHONE_NUMBER
          The reserved attribute name for the phone number attribute.
static java.lang.String USER_CREDENTIALS
          The reserved attribute name for the user credentials attribute.
 
Method Summary
 java.lang.Object clone()
          Clones the WebADEUserInfo object.
 java.lang.String[] getAttributeNames()
          Returns the set of attribute names for user attributes supported by this object instance.
 java.lang.Object getAttributeValue(java.lang.String attributeName)
          Returns the value for the attribute with the given name.
 java.lang.String getDisplayName()
           
 java.lang.String getEmailAddress()
           
 java.util.Date getExpiryDate()
           
 java.lang.String getFirstName()
           
 java.lang.String getLastName()
           
 java.lang.String getMiddleInitial()
           
 java.lang.String getPhoneNumber()
           
 UserCredentials getUserCredentials()
           
 boolean hasAttribute(java.lang.String attributeName)
          Returns whether this object instance supports the attribute with the given name.
 boolean isReadOnly()
           
 boolean isVisible()
           
 void setReadOnly()
          Sets the attributes of this object are non-editable.
 

Field Detail

USER_CREDENTIALS

public static final java.lang.String USER_CREDENTIALS
The reserved attribute name for the user credentials attribute. Used by the getAttributeValue, getAttributeNames, and hasAttribute methods.

See Also:
Constant Field Values

DISPLAY_NAME

public static final java.lang.String DISPLAY_NAME
The reserved attribute name for the display name attribute. Used by the getAttributeValue, getAttributeNames, and hasAttribute methods.

See Also:
Constant Field Values

LAST_NAME

public static final java.lang.String LAST_NAME
The reserved attribute name for the last name attribute. Used by the getAttributeValue, getAttributeNames, and hasAttribute methods.

See Also:
Constant Field Values

FIRST_NAME

public static final java.lang.String FIRST_NAME
The reserved attribute name for the first name attribute. Used by the getAttributeValue, getAttributeNames, and hasAttribute methods.

See Also:
Constant Field Values

MIDDLE_INITIAL

public static final java.lang.String MIDDLE_INITIAL
The reserved attribute name for the middle initial attribute. Used by the getAttributeValue, getAttributeNames, and hasAttribute methods.

See Also:
Constant Field Values

EMAIL_ADDRESS

public static final java.lang.String EMAIL_ADDRESS
The reserved attribute name for the email address attribute. Used by the getAttributeValue, getAttributeNames, and hasAttribute methods.

See Also:
Constant Field Values

PHONE_NUMBER

public static final java.lang.String PHONE_NUMBER
The reserved attribute name for the phone number attribute. Used by the getAttributeValue, getAttributeNames, and hasAttribute methods.

See Also:
Constant Field Values

EXPIRY_DATE

public static final java.lang.String EXPIRY_DATE
The reserved attribute name for the expiry date attribute. Used by the getAttributeValue, getAttributeNames, and hasAttribute methods.

See Also:
Constant Field Values

IS_VISIBLE

public static final java.lang.String IS_VISIBLE
The reserved attribute name for the is-visible attribute. Used by the getAttributeValue, getAttributeNames, and hasAttribute methods.

See Also:
Constant Field Values
Method Detail

getUserCredentials

public UserCredentials getUserCredentials()
Returns:
Returns the user's credentials.

getDisplayName

public java.lang.String getDisplayName()
Returns:
Returns the user's display name.

getLastName

public java.lang.String getLastName()
Returns:
Returns the lastName.

getFirstName

public java.lang.String getFirstName()
Returns:
Returns the firstName.

getMiddleInitial

public java.lang.String getMiddleInitial()
Returns:
Returns the middleInitial.

getEmailAddress

public java.lang.String getEmailAddress()
Returns:
Returns the emailAddress.

getPhoneNumber

public java.lang.String getPhoneNumber()
Returns:
Returns the phoneNumber.

getExpiryDate

public java.util.Date getExpiryDate()
Returns:
Returns the expiryDate or null if none is set.

isVisible

public boolean isVisible()
Returns:
Returns true if this user object's information is visible to the requesting user.

getAttributeValue

public java.lang.Object getAttributeValue(java.lang.String attributeName)
Returns the value for the attribute with the given name.

Parameters:
attributeName - The name constant assigned to the user attribute.
Returns:
The attribute value, or null if the attribute is not found.

getAttributeNames

public java.lang.String[] getAttributeNames()
Returns the set of attribute names for user attributes supported by this object instance.

Returns:
The array of attribute name constants.

hasAttribute

public boolean hasAttribute(java.lang.String attributeName)
Returns whether this object instance supports the attribute with the given name.

Parameters:
attributeName - The name constant assigned to the target user attribute.
Returns:
True if the attribute name is supported, otherwise false.

setReadOnly

public void setReadOnly()
Sets the attributes of this object are non-editable. Used to prevent an application from editing the attributes of the session user object.


isReadOnly

public boolean isReadOnly()
Returns:
True is the attributes of this object are non-editable.

clone

public java.lang.Object clone()
Clones the WebADEUserInfo object. The cloned object will have the isReadOnly() flag set to false, making it editable.