com.aspc.DBObj.Contact

Class Person

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Contact.Contact

com.aspc.DBObj.Contact.PermissionedContact

com.aspc.DBObj.Contact.Person

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

Person

public class Person
extends PermissionedContact

A normal "real" person.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

October 2, 2000, 2:50 PM

Author:

Nigel Leck

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID A normal "real" person.
static java.lang.String	DBCLASS_NAME A normal "real" person.

Fields inherited from class com.aspc.DBObj.Contact.Contact

DBEVERYONE_CONTACT, DBFIELD_MOBILE, DBUSERS_ADMIN, DBUSERS_CONTACT

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
Person(DBClass theClass, DataSource dataSource) Creates new DBObject.

Method Summary

Modifier and Type	Method and Description
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extFixUp() The extended fix up routine for known problems.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsMemberOf(PermissionedContact pc)
protected void	extPreValidate() Update the in-memory universe BEFORE validating
protected void	extSetValue(DBField field, java.lang.Object currentValue, FldParams params) We prevent some values from being set by a user.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
Gender	findGender(java.lang.String... args) Male or Female.
PersonTitle	findTitle(java.lang.String... args) eg, Mr, Ms, Mrs, Professor, Doctor.
Login	findUserId(java.lang.String... args) Links to login information if they are a user.
java.lang.String	getBiography(java.lang.String... args)
DBEmailAccount	getDefaultEmailAccount()
java.lang.String	getDisplayNameType(java.lang.String... args)
java.util.Date	getDOB(java.lang.String... args)
java.lang.String	getFirstName(java.lang.String... args)
Gender	getGender(java.lang.String... args)
java.lang.String	getHomePhone(java.lang.String... args)
java.lang.String	getLastName(java.lang.String... args)
java.lang.String	getLastNameFirstName(java.lang.String... args)
static Person[]	getListByEmailAddress(DataSource ds, java.lang.String email)
java.lang.String	getMiddleName(java.lang.String... args)
static Person	getPersonBySOEID(MutableDataSource ds, java.lang.String soeid)
static java.util.ArrayList<Person>	getPersonListBySOEIDs(MutableDataSource ds, java.lang.String soeIds)
BusinessToContactMap	getPrimaryBusUnit()
java.lang.String	getShortName(java.lang.String... args)
java.lang.String	getSmsAddress(java.lang.String... args)
java.lang.String	getSmsEmail(java.lang.String... args)
java.lang.String	getSmsMobile(java.lang.String... args)
PersonTitle	getTitle(java.lang.String... args)
Login	getUserId(java.lang.String... args)
boolean	isActiveUser(java.lang.String... args)
Person	setBiography(java.lang.String value, java.lang.String... args)
Person	setDisplayNameType(java.lang.String value, java.lang.String... args)
Person	setDOB(java.util.Date value, java.lang.String... args)
Person	setFirstName(java.lang.String value, java.lang.String... args)
Person	setGender(com.aspc.dal.dbobj.misc.Gender value, java.lang.String... args)
Person	setHomePhone(java.lang.String value, java.lang.String... args)
Person	setLastName(java.lang.String value, java.lang.String... args)
Person	setLastNameFirstName(java.lang.String value, java.lang.String... args)
Person	setMiddleName(java.lang.String value, java.lang.String... args)
Person	setShortName(java.lang.String value, java.lang.String... args)
Person	setSmsEmail(java.lang.String value, java.lang.String... args)
Person	setSmsMobile(java.lang.String value, java.lang.String... args)
Person	setTitle(com.aspc.dal.dbobj.misc.PersonTitle value, java.lang.String... args)
Person	setUserId(com.aspc.dal.dbobj.contact.Login value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.Contact.PermissionedContact

getCode, getGroups, getMembers, hasEntitlement, isMemberOf, isMemberOfGroup, isValid, setCode

Methods inherited from class com.aspc.DBObj.Contact.Contact

canReceiveAlert, decodeUnsubscribeId, displayName, encodeUnsubscribeId, extGetDerivedGlobalKey, extPostSaveRecord, extPreSaveRecord, findContactPerson, findCountry, findDisplayMailCountry, findDisplayMailState, findKey, findLastModifiedBy, findMailCountry, findMailState, findState, getAddress, getContactId, getContactPerson, getCoordinate, getCountry, getCurrentEmail, getDisplayEmail, getDisplayMailAddress, getDisplayMailCountry, getDisplayMailPostCode, getDisplayMailState, getDisplayMailSuburbCity, getEmail, getFax, getFullTextSearchScore, getKeyWords, getLastModifiedBy, getLastModifiedTime, getMailAddress, getMailCountry, getMailPostCode, getMailState, getMailSuburbCity, getMapsHREF, getName, getNotes, getPhone, getPostcode, getPrimaryType, getProperties, getReferencesUUID, getSequence, getSocialFacebook, getSocialGithub, getSocialGooglePlus, getSocialInstagram, getSocialLinkedIn, getSocialPinterest, getSocialTwitter, getSocialYoutube, getState, getSuburbCity, getTFN, getTmpAttachmentKey, getUnsubscribeURL, getUUID, getWeakReferencesUUID, hasReadAccess, isAdmin, isChildNode, isContains, isDescendantNode, isDirectory, isInternal, isNoEmailCorrespondance, isNoEmailCorrespondanceDrv, isPrivate, isPublic, isReferenceable, isSameNode, isVersionable, lastModified, listNodes, makeQuery, makeSearchPlan, setAddress, setAdmin, setContactId, setContactPerson, setCoordinate, setCountry, setEmail, setFax, setKeyWords, setLastModifiedBy, setLastModifiedTime, setMailAddress, setMailCountry, setMailPostCode, setMailState, setMailSuburbCity, setName, setNoEmailCorrespondance, setNotes, setPhone, setPostcode, setPrimaryType, setPrivate, setProperties, setReferenceable, setReferencesUUID, setSequence, setSocialFacebook, setSocialGithub, setSocialGooglePlus, setSocialInstagram, setSocialLinkedIn, setSocialPinterest, setSocialTwitter, setSocialYoutube, setState, setSuburbCity, setTFN, setTmpAttachmentKey, setUUID, setVersionable, setWeakReferencesUUID, toString, vDisplayName, vName

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayValue, doSearch, dump, equals, eventDataLoaded, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPreDeleteRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extUndelete, extValidateDelete, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

A normal "real" person.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

A normal "real" person.

Constructor Detail

Person

public Person(DBClass theClass,
              DataSource dataSource)
       throws java.lang.Exception

Creates new DBObject.

Parameters:

theClass - The class of this object

dataSource - Your current data source

Throws:

java.lang.Exception - Failed to initiate the database object.

Method Detail

getDOB

@CheckReturnValue
 @Nullable
public java.util.Date getDOB(java.lang.String... args)

setDOB

@Nonnull
public Person setDOB(java.util.Date value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getBiography

@CheckReturnValue
 @Nonnull
public java.lang.String getBiography(java.lang.String... args)

setBiography

@Nonnull
public Person setBiography(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayNameType

@CheckReturnValue
 @Nonnull
public java.lang.String getDisplayNameType(java.lang.String... args)

setDisplayNameType

@Nonnull
public Person setDisplayNameType(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getFirstName

@CheckReturnValue
 @Nonnull
public java.lang.String getFirstName(java.lang.String... args)

setFirstName

@Nonnull
public Person setFirstName(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getGender

@CheckReturnValue
 @Nullable
public Gender getGender(java.lang.String... args)

findGender

@CheckReturnValue
 @Nonnull
public final Gender findGender(java.lang.String... args)
                                                    throws NotFoundException

Male or Female.

--> Gender (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Gender

Throws:

NotFoundException - Gender was not found

setGender

@Nonnull
public Person setGender(com.aspc.dal.dbobj.misc.Gender value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getHomePhone

@CheckReturnValue
 @Nonnull
public java.lang.String getHomePhone(java.lang.String... args)

setHomePhone

@Nonnull
public Person setHomePhone(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

isActiveUser

@CheckReturnValue
public boolean isActiveUser(java.lang.String... args)

getLastName

@CheckReturnValue
 @Nonnull
public java.lang.String getLastName(java.lang.String... args)

setLastName

@Nonnull
public Person setLastName(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getLastNameFirstName

@CheckReturnValue
 @Nonnull
public java.lang.String getLastNameFirstName(java.lang.String... args)

setLastNameFirstName

@Nonnull
public Person setLastNameFirstName(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getMiddleName

@CheckReturnValue
 @Nonnull
public java.lang.String getMiddleName(java.lang.String... args)

setMiddleName

@Nonnull
public Person setMiddleName(java.lang.String value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getShortName

@CheckReturnValue
 @Nonnull
public java.lang.String getShortName(java.lang.String... args)

setShortName

@Nonnull
public Person setShortName(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getSmsAddress

@CheckReturnValue
 @Nonnull
public java.lang.String getSmsAddress(java.lang.String... args)

getSmsEmail

@CheckReturnValue
 @Nonnull
public java.lang.String getSmsEmail(java.lang.String... args)

setSmsEmail

@Nonnull
public Person setSmsEmail(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getSmsMobile

@CheckReturnValue
 @Nonnull
public java.lang.String getSmsMobile(java.lang.String... args)

setSmsMobile

@Nonnull
public Person setSmsMobile(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getTitle

@CheckReturnValue
 @Nullable
public PersonTitle getTitle(java.lang.String... args)

findTitle

@CheckReturnValue
 @Nonnull
public final PersonTitle findTitle(java.lang.String... args)
                                                        throws NotFoundException

eg, Mr, Ms, Mrs, Professor, Doctor.

--> PersonTitle (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PersonTitle

Throws:

NotFoundException - PersonTitle was not found

setTitle

@Nonnull
public Person setTitle(com.aspc.dal.dbobj.misc.PersonTitle value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getUserId

@CheckReturnValue
 @Nullable
public Login getUserId(java.lang.String... args)

findUserId

@CheckReturnValue
 @Nonnull
public final Login findUserId(java.lang.String... args)
                                                   throws NotFoundException

Links to login information if they are a user.

--> Login (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Login

Throws:

NotFoundException - Login was not found

setUserId

@Nonnull
public Person setUserId(com.aspc.dal.dbobj.contact.Login value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getListByEmailAddress

@CheckReturnValue
 @Nonnull
public static Person[] getListByEmailAddress(DataSource ds,
                                                                         java.lang.String email)
                                                                  throws java.lang.Exception

Parameters:

ds - the data source

email -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getDefaultEmailAccount

@CheckReturnValue
 @Nullable
public DBEmailAccount getDefaultEmailAccount()

Returns:

the value

getPrimaryBusUnit

@CheckReturnValue
 @Nullable
public BusinessToContactMap getPrimaryBusUnit()

Returns:

the value

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class PermissionedContact

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem

extIsMemberOf

@CheckReturnValue
protected boolean extIsMemberOf(@Nullable
                                                  PermissionedContact pc)
                                           throws java.lang.Exception

Parameters:

pc -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

extSetValue

protected void extSetValue(@Nonnull
                           DBField field,
                           @Nullable
                           java.lang.Object currentValue,
                           @Nullable
                           FldParams params)
                    throws java.lang.Exception

We prevent some values from being set by a user.

Overrides:

extSetValue in class DBObject

Parameters:

field - The field that is being changed

currentValue - The new value

params - The extra parameters

Throws:

java.lang.Exception - A serious problem

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

Description copied from class: Contact

update dependent fields.

Overrides:

eventFieldUpdated in class Contact

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

Throws:

java.lang.Exception - a serious problem

extPreValidate

@OverridingMethodsMustInvokeSuper
protected void extPreValidate()
                                                         throws java.lang.Exception

Update the in-memory universe BEFORE validating

Overrides:

extPreValidate in class Contact

Throws:

java.lang.Exception - A serious problem

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Performs additional validations on this record. Only ever called from MutableDataSource.

Overrides:

extValidateRecord in class Contact

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

extFixUp

@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception

The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class Contact

Throws:

java.lang.Exception - a serious problem

getPersonBySOEID

@CheckReturnValue
 @Nonnull
public static Person getPersonBySOEID(MutableDataSource ds,
                                                                  java.lang.String soeid)
                                                           throws java.lang.Exception

Parameters:

ds - the data source

soeid -

Returns:

the value

Throws:

java.lang.Exception - a serious problem.

getPersonListBySOEIDs

@CheckReturnValue
 @Nonnull
public static java.util.ArrayList<Person> getPersonListBySOEIDs(MutableDataSource ds,
                                                                                            java.lang.String soeIds)
                                                                                     throws java.lang.Exception

Parameters:

ds - the data source

soeIds - the ids

Returns:

the value

Throws:

java.lang.Exception - a serious problem.