ca.bc.gov.webade.user
Interface WebADEUserInfo

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

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 CONTACT_ADDRESS_CITY
          The reserved attribute name for the contact address city attribute.
static java.lang.String CONTACT_ADDRESS_COUNTRY
          The reserved attribute name for the contact address country attribute.
static java.lang.String CONTACT_ADDRESS_LINE_1
          The reserved attribute name for the contact address line 1 attribute.
static java.lang.String CONTACT_ADDRESS_LINE_2
          The reserved attribute name for the contact address line 2 attribute.
static java.lang.String CONTACT_ADDRESS_POSTAL_CODE
          The reserved attribute name for the contact address postal code attribute.
static java.lang.String CONTACT_ADDRESS_PROVINCE
          The reserved attribute name for the contact address province attribute.
static java.lang.String CONTACT_ADDRESS_UNSTRUCTURED
          The reserved attribute name for the contact address unstructured attribute (for foreign address).
static java.lang.String DEPARTMENT
          The reserved attribute name for the department attribute.
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
          Deprecated. Expiry Date is no longer supported by the BCeID web service.
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 PREFERRED_NAME
          The reserved attribute name for the preferred name 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 getContactAddressCity()
           
 java.lang.String getContactAddressCountry()
           
 java.lang.String getContactAddressLine1()
           
 java.lang.String getContactAddressLine2()
           
 java.lang.String getContactAddressPostalCode()
           
 java.lang.String getContactAddressProvince()
           
 java.lang.String getContactAddressUnstructured()
           
 java.lang.String getDepartment()
           
 java.lang.String getDisplayName()
           
 java.lang.String getEmailAddress()
           
 java.util.Date getExpiryDate()
          Deprecated. Expiry Date is no longer supported by the BCeID web service.
 java.lang.String getFirstName()
           
 java.lang.String getLastName()
           
 java.lang.String getMiddleInitial()
           
 java.lang.String getPhoneNumber()
           
 java.lang.String getPreferredName()
           
 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

PREFERRED_NAME

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

See Also:
Constant Field Values

DEPARTMENT

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

See Also:
Constant Field Values

CONTACT_ADDRESS_LINE_1

public static final java.lang.String CONTACT_ADDRESS_LINE_1
The reserved attribute name for the contact address line 1 attribute. Used by the getAttributeValue, getAttributeNames, and hasAttribute methods.

See Also:
Constant Field Values

CONTACT_ADDRESS_LINE_2

public static final java.lang.String CONTACT_ADDRESS_LINE_2
The reserved attribute name for the contact address line 2 attribute. Used by the getAttributeValue, getAttributeNames, and hasAttribute methods.

See Also:
Constant Field Values

CONTACT_ADDRESS_CITY

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

See Also:
Constant Field Values

CONTACT_ADDRESS_PROVINCE

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

See Also:
Constant Field Values

CONTACT_ADDRESS_COUNTRY

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

See Also:
Constant Field Values

CONTACT_ADDRESS_POSTAL_CODE

public static final java.lang.String CONTACT_ADDRESS_POSTAL_CODE
The reserved attribute name for the contact address postal code attribute. Used by the getAttributeValue, getAttributeNames, and hasAttribute methods.

See Also:
Constant Field Values

CONTACT_ADDRESS_UNSTRUCTURED

public static final java.lang.String CONTACT_ADDRESS_UNSTRUCTURED
The reserved attribute name for the contact address unstructured attribute (for foreign address). Used by the getAttributeValue, getAttributeNames, and hasAttribute methods.

See Also:
Constant Field Values

EXPIRY_DATE

public static final java.lang.String EXPIRY_DATE
Deprecated. Expiry Date is no longer supported by the BCeID web service.

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.

getContactAddressLine1

public java.lang.String getContactAddressLine1()
Returns:
Returns the contactAddressLine1.

getContactAddressLine2

public java.lang.String getContactAddressLine2()
Returns:
Returns the contactAddressLine2.

getContactAddressCity

public java.lang.String getContactAddressCity()
Returns:
Returns the contactAddressCity.

getContactAddressProvince

public java.lang.String getContactAddressProvince()
Returns:
Returns the contactAddressProvince.

getContactAddressCountry

public java.lang.String getContactAddressCountry()
Returns:
Returns the contactAddressCountry.

getContactAddressPostalCode

public java.lang.String getContactAddressPostalCode()
Returns:
Returns the contactAddressPostalCode.

getContactAddressUnstructured

public java.lang.String getContactAddressUnstructured()
Returns:
Returns the contactAddressUnstructured for foreign addresses (outside Canada and USA).

getPreferredName

public java.lang.String getPreferredName()
Returns:
Returns the preferredName.

getDepartment

public java.lang.String getDepartment()
Returns:
Returns the department.

getExpiryDate

public java.util.Date getExpiryDate()
Deprecated. Expiry Date is no longer supported by the BCeID web service.

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.