PersonRecord (IdM LDAP Components 5.0.12-SNAPSHOT API)

java.lang.Object
- uk.ac.bath.bucs.idm.ldap.PersonRecord

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PersonRecord>
```
public class PersonRecord
extends Object
implements Cloneable, Comparable<PersonRecord>, Serializable
```
Bean class to represent all of the information about a single person/account in the LDAP, with a little help from RoleRecord. Where properties are of type FlaggableString[] any values with the flag set will have attribute option x-alternate set in the LDAP.

Note: this class has a natural ordering that is inconsistent with equals.

Author:

Tim Barrett

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PersonRecord.Gender
Genders

static class PersonRecord.Type
Types of record, corresponding to LDAP objectClasses

Nested Classes
Modifier and Type	Class and Description
`static class`	`PersonRecord.Gender` Genders
`static class`	`PersonRecord.Type` Types of record, corresponding to LDAP objectClasses

Constructor Summary

Constructors
Constructor and Description

PersonRecord()

Constructors
Constructor and Description
`PersonRecord()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`int`	`compareTo(PersonRecord pr)` Defines a sort order based on username, falling back to the first surname and forename values, and then the first common name.
`boolean`	`equals(Object o)`
`Map<String,String>`	`getAccessControls()` Gets an immutable view of the map of access controls, which may be empty but will never be `null`.
`Map<String,String>`	`getAccessControlsCopy()` Gets a copy of the map of access controls, which may be empty but will never be `null`.
`Set<String>`	`getAccountState()` Gets an immutable view of the account state values, which may be empty but will never be `null`.
`AdministrativeLock`	`getAdministrativeLock()`
`String`	`getAlternateUsername()`
`Set<String>`	`getAutogenAdditions()` Gets an immutable view of the set of additions to autogenerated things, which may be empty but will never be `null`.
`Set<String>`	`getAutogenExclusions()` Gets an immutable view of the set of exclusions from autogenerated things, which may be empty but will never be `null`.
`List<FlaggableString>`	`getCommonName()` Gets an immutable view of the list of common names, which may be empty but will never be `null`.
`List<String>`	`getCommonNameVisible()` Gets only those values of the common name that are not hidden by being flagged x-alternate, in a freshly-created List.
`String`	`getDescription()`
`String`	`getDesignation()`
`String`	`getDisplayName()`
`String`	`getEmployeeType()`
`org.threeten.bp.LocalDate`	`getEndDate()`
`String`	`getExternalDisplayName()`
`Set<String>`	`getExternalMail()` Gets an immutable view of the set of external mail addresses, which may be empty but will never be `null`.
`String`	`getExternalPhone()`
`List<String>`	`getExtraMailAliases()` Gets an immutable view of the list of extra mail aliases, which may be empty but will never be `null`.
`String`	`getFaxNumber()`
`List<FlaggableString>`	`getForename()` Gets an immutable view of the list of forenames, which may be empty but will never be `null`.
`String`	`getForenameVisible()` Gets only the value of forename that is not hidden by being flagged x-alternate.
`PersonRecord.Gender`	`getGender()` Gets the value of the `gender` attribute.
`Integer`	`getHpcPosixGid()`
`String`	`getHpcPosixHome()`
`List<FlaggableString>`	`getInitials()` Gets an immutable view of the list of initial values, which may be empty but will never be `null`.
`String`	`getInitialsVisible()` Gets only the value of initials that is not hidden by being flagged x-alternate.
`List<FlaggableString>`	`getKnownAs()` Gets an immutable view of the list of knownAs values, which may be empty but will never be `null`.
`String`	`getKnownAsVisible()` Gets only the value of knownAs that is not hidden by being flagged x-alternate.
`String`	`getLabeledURI()`
`org.threeten.bp.LocalDate`	`getLeftDate()`
`String`	`getLibraryCardNumber()`
`String`	`getLocation()`
`String`	`getMail()`
`Set<String>`	`getMailAll()` Gets an immutable view of the set of all routed email addresses, which may be empty but will never be `null`.
`Set<String>`	`getMailRouting()`
`String`	`getManagerUsername()` Gets the username of the manager.
`List<FlaggableString>`	`getMiddleInitials()` Gets an immutable view of the list of middle initial values, which may be empty but will never be `null`.
`String`	`getMiddleInitialsVisible()` Gets only the value of middle initials that is not hidden by being flagged x-alternate.
`String`	`getMobileNumber()`
`String`	`getOrganisation()`
`String`	`getOu()`
`int`	`getOwnCloudQuota()` Gets the value of the `ownCloudQuota` attribute in megabytes.
`List<String>`	`getPayrollNo()` Gets an immutable view of the list of payroll numbers, which may be empty but will never be `null`.
`Integer`	`getPersonId()`
`List<String>`	`getPersonLinks()` Gets an immutable view of the list of personLinks, which may be empty but will never be `null`.
`String`	`getPhoneNumber()`
`String`	`getPosixGecos()`
`Integer`	`getPosixGid()`
`String`	`getPosixHome()`
`String`	`getPosixShell()`
`Integer`	`getPosixUid()`
`PersonRecord.Type`	`getRecordType()` Gets a single-valued record type.
`Set<PersonRecord.Type>`	`getRecordTypes()` Gets an immutable view of the set of record types, which may be empty but will never be `null`.
`RoleRecord`	`getRole(int index)` Gets a reference to the specified role held within the object.
`List<RoleRecord>`	`getRoles()` Gets an immutable view of the list of roles, which may be empty but will never be `null`.
`String`	`getRoomNumber()`
`String`	`getShortOu()`
`String`	`getSupportOuOverride()`
`List<FlaggableString>`	`getSurname()` Gets an immutable view of the list of surnames, which may be empty but will never be `null`.
`String`	`getSurnameVisible()` Gets only the value of surname that is not hidden by being flagged x-alternate.
`String`	`getTitle()`
`String`	`getUsername()`
`int`	`hashCode()`
`boolean`	`isAccountNotIssued()` Gets the value of the `accountNotIssued` attribute.
`boolean`	`isApplicant()`
`boolean`	`isBathPerson()`
`boolean`	`isExDirectory()`
`boolean`	`isExternalPerson()`
`boolean`	`isNonPerson()`
`void`	`setAccessControls(Map<String,String> accessControls)` Sets the map of access control key-value pairs.
`void`	`setAccountNotIssued(boolean accountNotIssued)`
`void`	`setAccountState(Set<String> accountState)` Sets the account state.
`void`	`setAdministrativeLock(AdministrativeLock administrativeLock)`
`void`	`setAlternateUsername(String alternateUsername)`
`void`	`setAutogenAdditions(Set<String> autogenAdditions)` Sets the set of additions to autogenerated things.
`void`	`setAutogenExclusions(Set<String> autogenExclusions)` Sets the set of exclusions from autogenerated things.
`void`	`setCommonName(List<FlaggableString> commonName)` Sets the list of common names.
`void`	`setDescription(String description)`
`void`	`setDesignation(String designation)`
`void`	`setDisplayName(String displayName)`
`void`	`setEmployeeType(String employeeType)`
`void`	`setEndDate(org.threeten.bp.LocalDate endDate)`
`void`	`setExDirectory(boolean exDirectory)`
`void`	`setExternalDisplayName(String externalDisplayName)`
`void`	`setExternalMail(Set<String> externalMail)` Sets the set of external email addresses.
`void`	`setExternalPhone(String externalPhone)`
`void`	`setExtraMailAliases(List<String> extraMailAliases)` Sets the list of extra mail aliases.
`void`	`setFaxNumber(String faxNumber)`
`void`	`setForename(List<FlaggableString> forename)` Sets the list of forenames.
`void`	`setGender(PersonRecord.Gender gender)`
`void`	`setHpcPosixGid(Integer posixGid)`
`void`	`setHpcPosixHome(String posixHome)`
`void`	`setInitials(List<FlaggableString> initials)` Sets the list of initial values.
`void`	`setKnownAs(List<FlaggableString> knownAs)` Sets the list of knownAs values.
`void`	`setLabeledURI(String labeledURI)`
`void`	`setLeftDate(org.threeten.bp.LocalDate leftDate)`
`void`	`setLibraryCardNumber(String libraryCardNumber)`
`void`	`setLocation(String location)`
`void`	`setMail(String mail)`
`void`	`setMailAll(Collection<String> mailAll)` Sets the list of all routed email addresses.
`void`	`setMailRouting(Set<String> mailRouting)`
`void`	`setManagerUsername(String managerUsername)` Sets the username of the manager.
`void`	`setMiddleInitials(List<FlaggableString> middleInitials)` Sets the list of middle initial values.
`void`	`setMobileNumber(String mobileNumber)`
`void`	`setOrganisation(String organisation)`
`void`	`setOu(String ou)`
`void`	`setOwnCloudQuota(int ownCloudQuota)` Sets the value of the `ownCloudQuota` attribute, in megabytes.
`void`	`setPayrollNo(List<String> payrollNo)` Sets the list of payroll numbers.
`void`	`setPersonId(Integer personId)`
`void`	`setPersonLinks(List<String> personLinks)` Sets the list of personLinks.
`void`	`setPhoneNumber(String phoneNumber)`
`void`	`setPosixGecos(String posixGecos)`
`void`	`setPosixGid(Integer posixGid)`
`void`	`setPosixHome(String posixHome)`
`void`	`setPosixShell(String posixShell)`
`void`	`setPosixUid(Integer posixUid)`
`void`	`setRecordType(PersonRecord.Type recordType)` Sets a single record type, replacing all existing values.
`void`	`setRecordTypes(Set<PersonRecord.Type> recordTypes)` Sets the set of record types.
`void`	`setRole(int index, RoleRecord role)` Sets the specified role held within the object.
`void`	`setRoles(List<RoleRecord> roles)` Sets the list of role.
`void`	`setRoomNumber(String roomNumber)`
`void`	`setShortOu(String shortOu)`
`void`	`setSupportOuOverride(String supportOuOverride)`
`void`	`setSurname(List<FlaggableString> surname)` Sets the list of surnames.
`void`	`setTitle(String title)`
`void`	`setUsername(String username)`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PersonRecord
```
public PersonRecord()
```
- Method Detail
  - getRecordType
```
public PersonRecord.Type getRecordType()
```
    Gets a single-valued record type. Where more than one type is set the most important (i.e. not applicant) will be returned.
    
    Returns:
    
    The most important record type, or null if none is set
  - getRecordTypes
```
public Set<PersonRecord.Type> getRecordTypes()
```
    Gets an immutable view of the set of record types, which may be empty but will never be null.
    
    Returns:
    
    an immutable set of record types
  - setRecordType
```
public void setRecordType(PersonRecord.Type recordType)
```
    Sets a single record type, replacing all existing values.
    
    Parameters:
    
    recordType - The record type to set
  - setRecordTypes
```
public void setRecordTypes(Set<PersonRecord.Type> recordTypes)
```
    Sets the set of record types. A copy is taken so there is no ongoing dependency on the Set object provided.
    
    Parameters:
    
    recordTypes - A set of record types, or null
  - isBathPerson
```
public boolean isBathPerson()
```
    Returns:
    
    true if the record has BATH_PERSON type (it may have others too)
  - isExternalPerson
```
public boolean isExternalPerson()
```
    Returns:
    
    true if the record has EXTERNAL_PERSON type (it may have others too)
  - isApplicant
```
public boolean isApplicant()
```
    Returns:
    
    true if the record has APPLICANT type (it may have others too)
  - isNonPerson
```
public boolean isNonPerson()
```
    Returns:
    
    true if the record has NON_PERSON_ACCOUNT type (it may have others too)
  - getUsername
```
public String getUsername()
```
  - setUsername
```
public void setUsername(String username)
```
  - getAlternateUsername
```
public String getAlternateUsername()
```
  - setAlternateUsername
```
public void setAlternateUsername(String alternateUsername)
```
  - getPersonId
```
public Integer getPersonId()
```
  - setPersonId
```
public void setPersonId(Integer personId)
```
  - getCommonName
```
public List<FlaggableString> getCommonName()
```
    Gets an immutable view of the list of common names, which may be empty but will never be null.
    
    Returns:
    
    an immutable list of common names
  - getCommonNameVisible
```
public List<String> getCommonNameVisible()
```
    Gets only those values of the common name that are not hidden by being flagged x-alternate, in a freshly-created List.
    
    Returns:
    
    The visible values of commonName
  - setCommonName
```
public void setCommonName(List<FlaggableString> commonName)
```
    Sets the list of common names. A copy is taken so there is no ongoing dependency on the List object provided.
    
    Parameters:
    
    commonName - A list of common names, or null
  - getDisplayName
```
public String getDisplayName()
```
  - setDisplayName
```
public void setDisplayName(String displayName)
```
  - getExternalDisplayName
```
public String getExternalDisplayName()
```
  - setExternalDisplayName
```
public void setExternalDisplayName(String externalDisplayName)
```
  - getKnownAs
```
public List<FlaggableString> getKnownAs()
```
    Gets an immutable view of the list of knownAs values, which may be empty but will never be null.
    
    Returns:
    
    an immutable list of knownAs values
  - getKnownAsVisible
```
public String getKnownAsVisible()
```
    Gets only the value of knownAs that is not hidden by being flagged x-alternate.
    
    Returns:
    
    The visible value of knownAs, or null
  - setKnownAs
```
public void setKnownAs(List<FlaggableString> knownAs)
```
    Sets the list of knownAs values. A copy is taken so there is no ongoing dependency on the List object provided.
    
    Parameters:
    
    knownAs - A list of knownAs values, or null
  - getForename
```
public List<FlaggableString> getForename()
```
    Gets an immutable view of the list of forenames, which may be empty but will never be null.
    
    Returns:
    
    an immutable list of forenames
  - getForenameVisible
```
public String getForenameVisible()
```
    Gets only the value of forename that is not hidden by being flagged x-alternate.
    
    Returns:
    
    The visible value of forename, or null
  - setForename
```
public void setForename(List<FlaggableString> forename)
```
    Sets the list of forenames. A copy is taken so there is no ongoing dependency on the List object provided.
    
    Parameters:
    
    forename - A list of forenames, or null
  - getSurname
```
public List<FlaggableString> getSurname()
```
    Gets an immutable view of the list of surnames, which may be empty but will never be null.
    
    Returns:
    
    an immutable list of surnames
  - getSurnameVisible
```
public String getSurnameVisible()
```
    Gets only the value of surname that is not hidden by being flagged x-alternate.
    
    Returns:
    
    The visible value of surname, or null
  - setSurname
```
public void setSurname(List<FlaggableString> surname)
```
    Sets the list of surnames. A copy is taken so there is no ongoing dependency on the List object provided.
    
    Parameters:
    
    surname - A list of surnames, or null
  - getMiddleInitials
```
public List<FlaggableString> getMiddleInitials()
```
    Gets an immutable view of the list of middle initial values, which may be empty but will never be null.
    
    Returns:
    
    an immutable list of middle initial values
  - getMiddleInitialsVisible
```
public String getMiddleInitialsVisible()
```
    Gets only the value of middle initials that is not hidden by being flagged x-alternate.
    
    Returns:
    
    The visible value of middle initials, or null
  - setMiddleInitials
```
public void setMiddleInitials(List<FlaggableString> middleInitials)
```
    Sets the list of middle initial values. A copy is taken so there is no ongoing dependency on the List object provided.
    
    Parameters:
    
    middleInitials - A list of middle initial values, or null
  - getInitials
```
public List<FlaggableString> getInitials()
```
    Gets an immutable view of the list of initial values, which may be empty but will never be null.
    
    Returns:
    
    an immutable list of initial values
  - getInitialsVisible
```
public String getInitialsVisible()
```
    Gets only the value of initials that is not hidden by being flagged x-alternate.
    
    Returns:
    
    The visible value of initials, or null
  - setInitials
```
public void setInitials(List<FlaggableString> initials)
```
    Sets the list of initial values. A copy is taken so there is no ongoing dependency on the List object provided.
    
    Parameters:
    
    initials - A list of initial values, or null
  - getDesignation
```
public String getDesignation()
```
  - setDesignation
```
public void setDesignation(String designation)
```
  - getGender
```
public PersonRecord.Gender getGender()
```
    Gets the value of the gender attribute. Note that this attribute is only visible to privileged system accounts, and therefore this property will be null when read by other users or by unauthenticated access.
    
    It is assumed that a process with permission to write the record will also have permission to read the attribute. If this assumption is violated then the attribute may be cleared inappropriately.
    
    Returns:
    
    the value of the gender attribute, or null if the LdapService was not able to read the value
  - setGender
```
public void setGender(PersonRecord.Gender gender)
```
  - getMail
```
public String getMail()
```
  - setMail
```
public void setMail(String mail)
```
  - getMailRouting
```
public Set<String> getMailRouting()
```
  - setMailRouting
```
public void setMailRouting(Set<String> mailRouting)
```
  - getExtraMailAliases
```
public List<String> getExtraMailAliases()
```
    Gets an immutable view of the list of extra mail aliases, which may be empty but will never be null. Values do not include '@bath.ac.uk' but may optionally have a date appended with a colon, e.g. "J.Smith:1997-03-15".
    
    Returns:
    
    an immutable list of extra mail aliases
  - setExtraMailAliases
```
public void setExtraMailAliases(List<String> extraMailAliases)
```
    Sets the list of extra mail aliases. A copy is taken so there is no ongoing dependency on the List object provided. Values do not include '@bath.ac.uk' but may optionally have a date appended with a colon, e.g. "J.Smith:1997-03-15".
    
    Parameters:
    
    extraMailAliases - A list of extra mail aliases, or null
  - getExternalMail
```
public Set<String> getExternalMail()
```
    Gets an immutable view of the set of external mail addresses, which may be empty but will never be null.
    
    Returns:
    
    an immutable set of email addresses
  - setExternalMail
```
public void setExternalMail(Set<String> externalMail)
```
    Sets the set of external email addresses. A copy is taken so there is no ongoing dependency on the Set object provided.
    
    Parameters:
    
    externalMail - A set of email addresses, or null
  - getMailAll
```
public Set<String> getMailAll()
```
    Gets an immutable view of the set of all routed email addresses, which may be empty but will never be null.
    
    Returns:
    
    an immutable set of all routed email addresses
  - setMailAll
```
public void setMailAll(Collection<String> mailAll)
```
    Sets the list of all routed email addresses. A copy is taken so there is no ongoing dependency on the Collection provided, and addresses that differ only in case are eliminated in the process.
    
    Parameters:
    
    mailAll - A collection of email addresses, or null
  - getEmployeeType
```
public String getEmployeeType()
```
  - setEmployeeType
```
public void setEmployeeType(String employeeType)
```
  - getOrganisation
```
public String getOrganisation()
```
  - setOrganisation
```
public void setOrganisation(String organisation)
```
  - getLocation
```
public String getLocation()
```
  - setLocation
```
public void setLocation(String location)
```
  - getOu
```
public String getOu()
```
  - setOu
```
public void setOu(String ou)
```
  - getShortOu
```
public String getShortOu()
```
  - setShortOu
```
public void setShortOu(String shortOu)
```
  - getDescription
```
public String getDescription()
```
  - setDescription
```
public void setDescription(String description)
```
  - getTitle
```
public String getTitle()
```
  - setTitle
```
public void setTitle(String title)
```
  - getPhoneNumber
```
public String getPhoneNumber()
```
  - setPhoneNumber
```
public void setPhoneNumber(String phoneNumber)
```
  - getFaxNumber
```
public String getFaxNumber()
```
  - setFaxNumber
```
public void setFaxNumber(String faxNumber)
```
  - getMobileNumber
```
public String getMobileNumber()
```
  - setMobileNumber
```
public void setMobileNumber(String mobileNumber)
```
  - getExternalPhone
```
public String getExternalPhone()
```
  - setExternalPhone
```
public void setExternalPhone(String externalPhone)
```
  - getRoomNumber
```
public String getRoomNumber()
```
  - setRoomNumber
```
public void setRoomNumber(String roomNumber)
```
  - getPersonLinks
```
public List<String> getPersonLinks()
```
    Gets an immutable view of the list of personLinks, which may be empty but will never be null. Format is (<Username>,<Phone>,<Description>).
    
    Returns:
    
    an immutable list of personLinks
  - setPersonLinks
```
public void setPersonLinks(List<String> personLinks)
```
    Sets the list of personLinks. A copy is taken so there is no ongoing dependency on the List object provided. Format is (<Username>,<Phone>,<Description>).
    
    Parameters:
    
    personLinks - a list of personLink strings, or null
  - isExDirectory
```
public boolean isExDirectory()
```
  - setExDirectory
```
public void setExDirectory(boolean exDirectory)
```
  - getAccountState
```
public Set<String> getAccountState()
```
    Gets an immutable view of the account state values, which may be empty but will never be null.
    
    Returns:
    
    an immutable set of account state values
  - setAccountState
```
public void setAccountState(Set<String> accountState)
```
    Sets the account state. A copy is taken so there is no ongoing dependency on the Set object provided.
    
    Parameters:
    
    accountState - A set of account state values, or null
  - getAccessControls
```
public Map<String,String> getAccessControls()
```
    Gets an immutable view of the map of access controls, which may be empty but will never be null.
    
    Returns:
    
    an immutable map of access control key-value pairs
  - getAccessControlsCopy
```
public Map<String,String> getAccessControlsCopy()
```
    Gets a copy of the map of access controls, which may be empty but will never be null.
    
    Returns:
    
    a mutable copy of the map of access control key-value pairs
  - setAccessControls
```
public void setAccessControls(Map<String,String> accessControls)
```
    Sets the map of access control key-value pairs. A copy is taken so there is no ongoing dependency on the Map object provided.
    
    Parameters:
    
    accessControls - A Map of access controls, or null to clear
  - getAutogenAdditions
```
public Set<String> getAutogenAdditions()
```
    Gets an immutable view of the set of additions to autogenerated things, which may be empty but will never be null.
    
    Returns:
    
    an immutable set of additions to autogenerated things
  - setAutogenAdditions
```
public void setAutogenAdditions(Set<String> autogenAdditions)
```
    Sets the set of additions to autogenerated things. A copy is taken so there is no ongoing dependency on the Set object provided.
    
    Parameters:
    
    autogenAdditions - A set of additions to autogenerated things, or null
  - getAutogenExclusions
```
public Set<String> getAutogenExclusions()
```
    Gets an immutable view of the set of exclusions from autogenerated things, which may be empty but will never be null.
    
    Returns:
    
    an immutable set of exclusions from autogenerated things
  - setAutogenExclusions
```
public void setAutogenExclusions(Set<String> autogenExclusions)
```
    Sets the set of exclusions from autogenerated things. A copy is taken so there is no ongoing dependency on the Set object provided.
    
    Parameters:
    
    autogenExclusions - A set of exclusions from autogenerated things, or null
  - getAdministrativeLock
```
public AdministrativeLock getAdministrativeLock()
```
  - setAdministrativeLock
```
public void setAdministrativeLock(AdministrativeLock administrativeLock)
```
  - getPosixUid
```
public Integer getPosixUid()
```
  - setPosixUid
```
public void setPosixUid(Integer posixUid)
```
  - getPosixGid
```
public Integer getPosixGid()
```
  - setPosixGid
```
public void setPosixGid(Integer posixGid)
```
  - getPosixHome
```
public String getPosixHome()
```
  - setPosixHome
```
public void setPosixHome(String posixHome)
```
  - getPosixShell
```
public String getPosixShell()
```
  - setPosixShell
```
public void setPosixShell(String posixShell)
```
  - getPosixGecos
```
public String getPosixGecos()
```
  - setPosixGecos
```
public void setPosixGecos(String posixGecos)
```
  - getHpcPosixGid
```
public Integer getHpcPosixGid()
```
  - setHpcPosixGid
```
public void setHpcPosixGid(Integer posixGid)
```
  - getHpcPosixHome
```
public String getHpcPosixHome()
```
  - setHpcPosixHome
```
public void setHpcPosixHome(String posixHome)
```
  - getLabeledURI
```
public String getLabeledURI()
```
  - setLabeledURI
```
public void setLabeledURI(String labeledURI)
```
  - getPayrollNo
```
public List<String> getPayrollNo()
```
    Gets an immutable view of the list of payroll numbers, which may be empty but will never be null.
    
    Returns:
    
    an immutable list of payroll numbers
  - setPayrollNo
```
public void setPayrollNo(List<String> payrollNo)
```
    Sets the list of payroll numbers. A copy is taken so there is no ongoing dependency on the List object provided.
    
    Parameters:
    
    payrollNo - A list of payroll numbers, or null
  - getLibraryCardNumber
```
public String getLibraryCardNumber()
```
  - setLibraryCardNumber
```
public void setLibraryCardNumber(String libraryCardNumber)
```
  - getSupportOuOverride
```
public String getSupportOuOverride()
```
  - setSupportOuOverride
```
public void setSupportOuOverride(String supportOuOverride)
```
  - getLeftDate
```
public org.threeten.bp.LocalDate getLeftDate()
```
  - setLeftDate
```
public void setLeftDate(org.threeten.bp.LocalDate leftDate)
```
  - getEndDate
```
public org.threeten.bp.LocalDate getEndDate()
```
  - setEndDate
```
public void setEndDate(org.threeten.bp.LocalDate endDate)
```
  - isAccountNotIssued
```
public boolean isAccountNotIssued()
```
    Gets the value of the accountNotIssued attribute. Note that this attribute is only visible to privileged system accounts, and therefore this property will be false when read by other users or by unauthenticated access.
    
    It is assumed that a process with permission to write the record will also have permission to read the attribute. If this assumption is violated then the flag may be cleared inappropriately.
    
    Returns:
    
    the value of the accountNotIssued attribute, or false if the LdapService was not able to read the value
  - setAccountNotIssued
```
public void setAccountNotIssued(boolean accountNotIssued)
```
  - getOwnCloudQuota
```
public int getOwnCloudQuota()
```
    Gets the value of the ownCloudQuota attribute in megabytes. Note that this attribute is only visible to privileged system accounts, and therefore this property will be zero when read by other users or by unauthenticated access.
    
    It is assumed that a process with permission to write the record will also have permission to read the attribute. If this assumption is violated then the attribute may be cleared inappropriately.
    
    Returns:
    
    the value of the accountNotIssued attribute, or false if the LdapService was not able to read the value
  - setOwnCloudQuota
```
public void setOwnCloudQuota(int ownCloudQuota)
```
    Sets the value of the ownCloudQuota attribute, in megabytes.
    
    Parameters:
    
    ownCloudQuota - the megabyte quota value to set
    
    Throws:
    
    IllegalArgumentException - if the supplied value is negative
  - getManagerUsername
```
public String getManagerUsername()
```
    Gets the username of the manager. The LDAP attribute stores the Distinguished Name, but for convenience this property stores just the username. If the user has multiple managers then the manager of the highest-ranked role with a manager will normally be in this property.
    
    Returns:
    
    the manager username, or null
  - setManagerUsername
```
public void setManagerUsername(String managerUsername)
```
    Sets the username of the manager. The LDAP attribute stores the Distinguished Name, but for convenience this property stores just the username. If the user has multiple managers then the manager of the highest-ranked role with a manager should normally be used.
    
    Parameters:
    
    managerUsername - the manager username to set, or null
  - getRoles
```
public List<RoleRecord> getRoles()
```
    Gets an immutable view of the list of roles, which may be empty but will never be null. The roles themselves are not immutable - just the List containing them.
    
    Returns:
    
    an immutable list of roles
  - setRoles
```
public void setRoles(List<RoleRecord> roles)
```
    Sets the list of role. A copy is taken so there is no ongoing dependency on the List object provided. The roles themselves are not copied, however.
    
    Parameters:
    
    roles - A list of role, or null
  - getRole
```
public RoleRecord getRole(int index)
```
    Gets a reference to the specified role held within the object.
    
    Parameters:
    
    index - The index of the role to get (starting with 0)
    
    Returns:
    
    the specified role
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds
  - setRole
```
public void setRole(int index,
                    RoleRecord role)
```
    Sets the specified role held within the object. The role is not copied.
    
    Parameters:
    
    index - The index of the role to set
    
    role - The role to set, or null to remove the specified role
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of bounds
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(PersonRecord pr)
```
    Defines a sort order based on username, falling back to the first surname and forename values, and then the first common name. If the set of things to be compared have different combinations of these set then the results are undefined.
    
    Specified by:
    
    compareTo in interface Comparable<PersonRecord>
    
    Parameters:
    
    pr - The PersonRecord to compare to this one
    
    Returns:
    
    the value 0 if the argument record is equal to this one; a value less than 0 if this record is less than the argument; and a value greater than 0 if this record is greater than the argument

Class PersonRecord

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PersonRecord

Method Detail

getRecordType

getRecordTypes

setRecordType

setRecordTypes

isBathPerson

isExternalPerson

isApplicant

isNonPerson

getUsername

setUsername

getAlternateUsername

setAlternateUsername

getPersonId

setPersonId

getCommonName

getCommonNameVisible

setCommonName

getDisplayName

setDisplayName

getExternalDisplayName

setExternalDisplayName

getKnownAs

getKnownAsVisible

setKnownAs

getForename

getForenameVisible

setForename

getSurname

getSurnameVisible

setSurname

getMiddleInitials

getMiddleInitialsVisible

setMiddleInitials

getInitials

getInitialsVisible

setInitials

getDesignation

setDesignation

getGender

setGender

getMail

setMail

getMailRouting

setMailRouting

getExtraMailAliases

setExtraMailAliases

getExternalMail

setExternalMail

getMailAll

setMailAll

getEmployeeType

setEmployeeType

getOrganisation

setOrganisation

getLocation

setLocation

getOu

setOu

getShortOu

setShortOu

getDescription

setDescription

getTitle

setTitle

getPhoneNumber

setPhoneNumber

getFaxNumber

setFaxNumber

getMobileNumber

setMobileNumber

getExternalPhone

setExternalPhone