ca.bc.gov.webade.user
Class DefaultGovernmentUserInfo

java.lang.Object
  extended byca.bc.gov.webade.user.AbstractWebADEUserInfo
      extended byca.bc.gov.webade.user.DefaultGovernmentUserInfo
All Implemented Interfaces:
GovernmentUserInfo, java.io.Serializable, WebADEUserInfo

public class DefaultGovernmentUserInfo
extends AbstractWebADEUserInfo
implements GovernmentUserInfo, java.io.Serializable

Author:
jross
See Also:
Serialized Form

Field Summary
 
Fields inherited from interface ca.bc.gov.webade.user.GovernmentUserInfo
ACCOUNT_TYPE, CITY, COMPANY, DESCRIPTION, EMPLOYEE_ID, GOVERNMENT_DEPARTMENT, OFFICE, ORGANIZATION_CODE, TITLE
 
Fields inherited from interface ca.bc.gov.webade.user.WebADEUserInfo
CONTACT_ADDRESS_CITY, CONTACT_ADDRESS_COUNTRY, CONTACT_ADDRESS_LINE_1, CONTACT_ADDRESS_LINE_2, CONTACT_ADDRESS_POSTAL_CODE, CONTACT_ADDRESS_PROVINCE, CONTACT_ADDRESS_UNSTRUCTURED, DEPARTMENT, DISPLAY_NAME, EMAIL_ADDRESS, EXPIRY_DATE, FIRST_NAME, IS_VISIBLE, LAST_NAME, MIDDLE_INITIAL, PHONE_NUMBER, PREFERRED_NAME, USER_CREDENTIALS
 
Constructor Summary
DefaultGovernmentUserInfo()
          Default Constructor.
DefaultGovernmentUserInfo(DefaultGovernmentUserInfo user)
          Copy constructor.
 
Method Summary
 java.lang.Object clone()
          Clones the WebADEUserInfo object.
 java.lang.String getAccountType()
          Deprecated. Acount Type is no longer supported by the BCeID web service.
 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 getCity()
           
 java.lang.String getCompany()
           
 java.lang.String getDescription()
           
 java.lang.String getEmployeeId()
           
 java.lang.String getGovernmentDepartment()
           
 java.lang.String getOffice()
           
 java.lang.String getOrganizationCode()
           
 java.lang.String getTitle()
           
 boolean hasAttribute(java.lang.String attributeName)
          Returns whether this object instance supports the attribute with the given name.
 boolean isEmployee()
           
 void setAccountType(java.lang.String accountType)
          Deprecated. Acount Type is no longer supported by the BCeID web service.
 void setCity(java.lang.String city)
          Sets this user's city attribute to the given value.
 void setCompany(java.lang.String company)
          Sets this user's company attribute to the given value.
 void setDescription(java.lang.String description)
          Sets this user's description attribute to the given value.
 void setEmployeeId(java.lang.String employeeId)
          Sets this user's employeeId attribute to the given value.
 void setGovernmentDepartment(java.lang.String governmentDepartment)
          Sets this user's governmentDepartment attribute to the given value.
 void setOffice(java.lang.String office)
          Sets this user's office attribute to the given value.
 void setOrganizationCode(java.lang.String organizationCode)
          Sets this user's organizationCode attribute to the given value.
 void setTitle(java.lang.String title)
          Sets this user's title attribute to the given value.
 java.lang.String toString()
           
 
Methods inherited from class ca.bc.gov.webade.user.AbstractWebADEUserInfo
equals, getContactAddressCity, getContactAddressCountry, getContactAddressLine1, getContactAddressLine2, getContactAddressPostalCode, getContactAddressProvince, getContactAddressUnstructured, getDepartment, getDisplayName, getEmailAddress, getExpiryDate, getFirstName, getLastName, getMiddleInitial, getPhoneNumber, getPreferredName, getUserCredentials, hashCode, isReadOnly, isVisible, setContactAddressCity, setContactAddressCountry, setContactAddressLine1, setContactAddressLine2, setContactAddressPostalCode, setContactAddressProvince, setContactAddressUnstructured, setDepartment, setDisplayName, setEmailAddress, setExpiryDate, setFirstName, setLastName, setMiddleInitial, setPhoneNumber, setPreferredName, setReadOnly, setUserCredentials, setVisible
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ca.bc.gov.webade.user.WebADEUserInfo
getContactAddressCity, getContactAddressCountry, getContactAddressLine1, getContactAddressLine2, getContactAddressPostalCode, getContactAddressProvince, getContactAddressUnstructured, getDepartment, getDisplayName, getEmailAddress, getExpiryDate, getFirstName, getLastName, getMiddleInitial, getPhoneNumber, getPreferredName, getUserCredentials, isReadOnly, isVisible, setReadOnly
 

Constructor Detail

DefaultGovernmentUserInfo

public DefaultGovernmentUserInfo()
Default Constructor.


DefaultGovernmentUserInfo

public DefaultGovernmentUserInfo(DefaultGovernmentUserInfo user)
Copy constructor. Copies all user details from the given object to this instance.

Parameters:
user - The user object to copy.
Method Detail

getAccountType

public final java.lang.String getAccountType()
Deprecated. Acount Type is no longer supported by the BCeID web service.

Specified by:
getAccountType in interface GovernmentUserInfo
Returns:
The user's BC Gov Account type.
See Also:
GovernmentUserInfo.getAccountType()

getEmployeeId

public final java.lang.String getEmployeeId()
Specified by:
getEmployeeId in interface GovernmentUserInfo
Returns:
The user's employee Id.
See Also:
GovernmentUserInfo.getEmployeeId()

isEmployee

public boolean isEmployee()
Specified by:
isEmployee in interface GovernmentUserInfo
Returns:
True if the user is a government employee.
See Also:
GovernmentUserInfo.isEmployee()

getCity

public java.lang.String getCity()
Specified by:
getCity in interface GovernmentUserInfo
Returns:
The user's city.
See Also:
GovernmentUserInfo.getCity()

getTitle

public java.lang.String getTitle()
Specified by:
getTitle in interface GovernmentUserInfo
Returns:
The user's title.
See Also:
GovernmentUserInfo.getTitle()

getCompany

public java.lang.String getCompany()
Specified by:
getCompany in interface GovernmentUserInfo
Returns:
The user's company.
See Also:
GovernmentUserInfo.getCompany()

getOrganizationCode

public java.lang.String getOrganizationCode()
Specified by:
getOrganizationCode in interface GovernmentUserInfo
Returns:
The user's organization code.
See Also:
GovernmentUserInfo.getOrganizationCode()

getGovernmentDepartment

public java.lang.String getGovernmentDepartment()
Specified by:
getGovernmentDepartment in interface GovernmentUserInfo
Returns:
The user's government department.
See Also:
GovernmentUserInfo.getGovernmentDepartment()

getOffice

public java.lang.String getOffice()
Specified by:
getOffice in interface GovernmentUserInfo
Returns:
The user's office.
See Also:
GovernmentUserInfo.getCity()

getDescription

public java.lang.String getDescription()
Specified by:
getDescription in interface GovernmentUserInfo
Returns:
The user's description.
See Also:
GovernmentUserInfo.getDescription()

getAttributeNames

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

Specified by:
getAttributeNames in interface WebADEUserInfo
Overrides:
getAttributeNames in class AbstractWebADEUserInfo
See Also:
AbstractWebADEUserInfo.getAttributeNames()

getAttributeValue

public java.lang.Object getAttributeValue(java.lang.String attributeName)
Description copied from interface: WebADEUserInfo
Returns the value for the attribute with the given name.

Specified by:
getAttributeValue in interface WebADEUserInfo
Overrides:
getAttributeValue in class AbstractWebADEUserInfo
See Also:
AbstractWebADEUserInfo.getAttributeValue(java.lang.String)

hasAttribute

public boolean hasAttribute(java.lang.String attributeName)
Description copied from interface: WebADEUserInfo
Returns whether this object instance supports the attribute with the given name.

Specified by:
hasAttribute in interface WebADEUserInfo
Overrides:
hasAttribute in class AbstractWebADEUserInfo
See Also:
AbstractWebADEUserInfo.hasAttribute(java.lang.String)

setAccountType

public final void setAccountType(java.lang.String accountType)
Deprecated. Acount Type is no longer supported by the BCeID web service.

Sets this user's accountType attribute to the given value. If this user object is read-only, a runtime exception is thrown.

Parameters:
accountType - The accountType to set.

setEmployeeId

public final void setEmployeeId(java.lang.String employeeId)
Sets this user's employeeId attribute to the given value. If this user object is read-only, a runtime exception is thrown.

Parameters:
employeeId - The employeeId to set.

setCity

public void setCity(java.lang.String city)
Sets this user's city attribute to the given value. If this user object is read-only, a runtime exception is thrown.

Parameters:
city - The city to set.

setTitle

public void setTitle(java.lang.String title)
Sets this user's title attribute to the given value. If this user object is read-only, a runtime exception is thrown.

Parameters:
title - The title to set.

setCompany

public void setCompany(java.lang.String company)
Sets this user's company attribute to the given value. If this user object is read-only, a runtime exception is thrown.

Parameters:
company - The company to set.

setOrganizationCode

public void setOrganizationCode(java.lang.String organizationCode)
Sets this user's organizationCode attribute to the given value. If this user object is read-only, a runtime exception is thrown.

Parameters:
organizationCode - The organizationCode to set.

setGovernmentDepartment

public void setGovernmentDepartment(java.lang.String governmentDepartment)
Sets this user's governmentDepartment attribute to the given value. If this user object is read-only, a runtime exception is thrown.

Parameters:
governmentDepartment - The governmentDepartment to set.

setOffice

public void setOffice(java.lang.String office)
Sets this user's office attribute to the given value. If this user object is read-only, a runtime exception is thrown.

Parameters:
office - The office to set.

setDescription

public void setDescription(java.lang.String description)
Sets this user's description attribute to the given value. If this user object is read-only, a runtime exception is thrown.

Parameters:
description - The description to set.

clone

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

Specified by:
clone in interface WebADEUserInfo
Specified by:
clone in class AbstractWebADEUserInfo

toString

public java.lang.String toString()
Overrides:
toString in class AbstractWebADEUserInfo