public final class AccountState extends Object implements Cloneable, Serializable
Modifier and Type | Class and Description |
---|---|
static class |
AccountState.State |
Constructor and Description |
---|
AccountState()
Creates a new AccountState instance with the default state of NONE.
|
Modifier and Type | Method and Description |
---|---|
Object |
clone() |
boolean |
equals(Object obj) |
static AccountState |
fromLdap(Set<String> ldapValue)
Builds an
AccountState instance from data in the format supplied by
PersonRecord from the LDAP. |
static AccountState |
fromPersonRecord(PersonRecord pr)
Builds an
AccountState instance from data contained in a PersonRecord . |
SortedSet<String> |
getFacilities()
Gets an immutable view of the account's set of facilities, which may be empty but will never
be
null . |
SortedSet<String> |
getFacilitiesCopy()
Gets a copy of the account's set of facilities, which may be empty but will never be
null . |
org.threeten.bp.LocalDate |
getGraceEndDate() |
AccountState.State |
getState() |
int |
hashCode() |
boolean |
hasSameBitsAs(AccountState s)
Returns
true if the supplied state has the same account components as this
state. |
boolean |
isApplicant() |
boolean |
isApplicantClosed() |
boolean |
isApplicantGrace() |
boolean |
isApplicantGraceWithResidue() |
boolean |
isApplicantWithResidue() |
boolean |
isClosed() |
boolean |
isExternal() |
boolean |
isExternalClosed() |
boolean |
isFull() |
boolean |
isGrace() |
boolean |
isGraceToApplicant() |
boolean |
isLocked() |
boolean |
isNone() |
boolean |
isNonPayroll() |
boolean |
isNotRegistered() |
boolean |
isStaffGrace() |
boolean |
isStaffGraceToApplicant() |
boolean |
isTemp() |
boolean |
isWeb() |
void |
setFacilities(Set<String> facilities)
Sets the set of facility strings.
|
void |
setFacilities(String facilities)
Sets the set of facility strings by splitting a single string on the tilde character '~'.
|
void |
setGraceEndDate(org.threeten.bp.LocalDate graceEndDate)
Sets the grace end date, the day the account is expected to close.
|
void |
setLocked(boolean locked) |
void |
setNonPayroll(boolean nonPayroll) |
void |
setNotRegistered(boolean notRegistered) |
void |
setState(AccountState.State state)
Setting any state other than one of the six GRACE states will erase graceEndDate.
|
Set<String> |
toLdap()
Converts the state into the form required to store in a
PersonRecord , and thenceforth
the LDAP. |
String |
toString() |
public AccountState()
public AccountState.State getState()
public void setState(AccountState.State state)
state
- The state to setpublic boolean isLocked()
true
if the account is lockedpublic void setLocked(boolean locked)
locked
- Pass true
to indicate the account is lockedpublic boolean isNotRegistered()
true
if the account is in not-registered lock-downpublic void setNotRegistered(boolean notRegistered)
notRegistered
- Pass true
to indicate the account is in not-registered
lock-downpublic boolean isNonPayroll()
true
if the StaffGrace
state is for a non-payroll rolepublic void setNonPayroll(boolean nonPayroll)
nonPayroll
- true
to indicate the StaffGrace
state is for a non-payroll
rolepublic org.threeten.bp.LocalDate getGraceEndDate()
public void setGraceEndDate(org.threeten.bp.LocalDate graceEndDate)
graceEndDate
- the graceEndDate to set, or null
public SortedSet<String> getFacilities()
null
. Only relevant to External states.public SortedSet<String> getFacilitiesCopy()
null
. Only relevant to External states.public void setFacilities(Set<String> facilities)
facilities
- A Set of facility strings, or null
to clearpublic void setFacilities(String facilities)
facilities
- A tilde-separated string, or null
to clearpublic boolean isNone()
public boolean isFull()
public boolean isStaffGrace()
public boolean isGrace()
public boolean isClosed()
public boolean isStaffGraceToApplicant()
public boolean isGraceToApplicant()
public boolean isApplicantWithResidue()
public boolean isApplicant()
public boolean isApplicantGrace()
public boolean isApplicantGraceWithResidue()
public boolean isApplicantClosed()
public boolean isTemp()
public boolean isWeb()
public boolean isExternal()
public boolean isExternalClosed()
public boolean hasSameBitsAs(AccountState s)
true
if the supplied state has the same account components as this
state. This is evaluated only by looking at the states, rather than any other data about
the account.s
- the state to compare with this onetrue
if the supplied state has the same bitspublic Set<String> toLdap()
PersonRecord
, and thenceforth
the LDAP.IllegalStateException
- if the object is not in a valid statepublic static AccountState fromLdap(Set<String> ldapValue)
AccountState
instance from data in the format supplied by
PersonRecord
from the LDAP.ldapValue
- The data from the LDAP to convert to an AccountState
AccountState
instance createdIllegalArgumentException
- if the supplied data is invalidpublic static AccountState fromPersonRecord(PersonRecord pr)
AccountState
instance from data contained in a PersonRecord
.pr
- the PersonRecord
containing data to convert, or null
AccountState
instance createdIllegalArgumentException
- if the supplied data is invalidpublic Object clone() throws CloneNotSupportedException
clone
in class Object
CloneNotSupportedException
Copyright © 2018. All rights reserved.