com.aspc.DBObj.Contact

Class Contact

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Contact.Contact

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

Company, PermissionedContact

public class Contact
extends DBObject

A person or company may be a contact of the system. They are both legal entities and share many properties. A job maybe done for a person or a company but you can only marry another person. So many fields will be linked to contact and others like "mother" would be linked to person.

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

Since:

October 2, 2000, 4:44 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 person or company may be a contact of the system.
static java.lang.String	DBCLASS_NAME A person or company may be a contact of the system.
static GlobalId	DBEVERYONE_CONTACT everyone
static java.lang.String	DBFIELD_MOBILE
static GlobalId	DBUSERS_ADMIN admin
static GlobalId	DBUSERS_CONTACT users

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
Contact(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
boolean	canReceiveAlert(java.lang.String... args)
static java.lang.String[]	decodeUnsubscribeId(java.lang.String s)
java.lang.String	displayName() The human display name of this object.
java.lang.String	encodeUnsubscribeId()
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 GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams inParams) displayMailCountry is linked and derived
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extPostSaveRecord(long transNr) OVERRIDE this method to add functionality to stSoftware AFTER saving the record to the database.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
protected void	extPreValidate() OVERRIDE To add functionality to before validation is called.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
Person	findContactPerson(java.lang.String... args) An alternative contact person for this record.
Country	findCountry(java.lang.String... args) Country code, eg, UK, United Kingdom.
Country	findDisplayMailCountry(java.lang.String... args) If mail address is blank then use the street address' country.
StateRegion	findDisplayMailState(java.lang.String... args) If mail address is blank then use the street address' state.
static Contact	findKey(DataSource ds, int key) Find the target for this class by the primary key
Person	findLastModifiedBy(java.lang.String... args) User that last modified this contact.
Country	findMailCountry(java.lang.String... args) Country code, eg, UK, United Kingdom.
StateRegion	findMailState(java.lang.String... args) State/Territory.
StateRegion	findState(java.lang.String... args) State or Territory abreviation, eg, NSW.
java.lang.String	getAddress(java.lang.String... args)
int	getContactId(java.lang.String... args)
Person	getContactPerson(java.lang.String... args)
java.lang.String	getCoordinate(java.lang.String... args)
Country	getCountry(java.lang.String... args)
java.lang.String	getCurrentEmail(java.lang.String... args)
java.lang.String	getDisplayEmail(java.lang.String... args)
java.lang.String	getDisplayMailAddress(java.lang.String... args)
Country	getDisplayMailCountry(java.lang.String... args)
java.lang.String	getDisplayMailPostCode(java.lang.String... args)
StateRegion	getDisplayMailState(java.lang.String... args)
java.lang.String	getDisplayMailSuburbCity(java.lang.String... args)
java.lang.String	getEmail(java.lang.String... args)
java.lang.String	getFax(java.lang.String... args)
double	getFullTextSearchScore(java.lang.String... args)
java.lang.String	getKeyWords(java.lang.String... args)
Person	getLastModifiedBy(java.lang.String... args)
java.util.Date	getLastModifiedTime(java.lang.String... args)
java.lang.String	getMailAddress(java.lang.String... args)
Country	getMailCountry(java.lang.String... args)
java.lang.String	getMailPostCode(java.lang.String... args)
StateRegion	getMailState(java.lang.String... args)
java.lang.String	getMailSuburbCity(java.lang.String... args)
java.lang.String	getMapsHREF(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
java.lang.String	getNotes(java.lang.String... args)
java.lang.String	getPhone(java.lang.String... args)
java.lang.String	getPostcode(java.lang.String... args)
java.lang.String	getPrimaryType(java.lang.String... args)
java.util.List	getProperties(java.lang.String... args)
java.util.List<java.lang.String>	getReferencesUUID(java.lang.String... args)
int	getSequence(java.lang.String... args)
java.lang.String	getSocialFacebook(java.lang.String... args)
java.lang.String	getSocialGithub(java.lang.String... args)
java.lang.String	getSocialGooglePlus(java.lang.String... args)
java.lang.String	getSocialInstagram(java.lang.String... args)
java.lang.String	getSocialLinkedIn(java.lang.String... args)
java.lang.String	getSocialPinterest(java.lang.String... args)
java.lang.String	getSocialTwitter(java.lang.String... args)
java.lang.String	getSocialYoutube(java.lang.String... args)
StateRegion	getState(java.lang.String... args)
java.lang.String	getSuburbCity(java.lang.String... args)
long	getTFN(java.lang.String... args)
java.lang.String	getTmpAttachmentKey(java.lang.String... args)
java.lang.String	getUnsubscribeURL(java.lang.String... args)
java.lang.String	getUUID(java.lang.String... args)
java.util.List<java.lang.String>	getWeakReferencesUUID(java.lang.String... args)
boolean	hasReadAccess(java.lang.String... args)
boolean	isAdmin(java.lang.String... args)
boolean	isChildNode(java.lang.String... args)
boolean	isContains(java.lang.String... args)
boolean	isDescendantNode(java.lang.String... args)
boolean	isDirectory()
boolean	isInternal()
boolean	isNoEmailCorrespondance(java.lang.String... args)
boolean	isNoEmailCorrespondanceDrv(java.lang.String... args)
boolean	isPrivate(java.lang.String... args)
boolean	isPublic(java.lang.String... args)
boolean	isReferenceable(java.lang.String... args)
boolean	isSameNode(java.lang.String... args)
boolean	isVersionable(java.lang.String... args)
long	lastModified()
DBNode[]	listNodes()
static DBQuery<Contact>	makeQuery(DataSource ds) Make a new QUERY for this class.
static SearchPlan	makeSearchPlan(DBQuery<DBObject> query) Allows for specific attributes to be set for the queries
Contact	setAddress(java.lang.String value, java.lang.String... args)
Contact	setAdmin(boolean value, java.lang.String... args)
Contact	setContactId(int value, java.lang.String... args)
Contact	setContactPerson(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)
Contact	setCoordinate(java.lang.String value, java.lang.String... args)
Contact	setCountry(com.aspc.dal.dbobj.misc.Country value, java.lang.String... args)
Contact	setEmail(java.lang.String value, java.lang.String... args)
Contact	setFax(java.lang.String value, java.lang.String... args)
Contact	setKeyWords(java.lang.String value, java.lang.String... args)
Contact	setLastModifiedBy(com.aspc.dal.dbobj.contact.Person value, java.lang.String... args)
Contact	setLastModifiedTime(java.util.Date value, java.lang.String... args)
Contact	setMailAddress(java.lang.String value, java.lang.String... args)
Contact	setMailCountry(com.aspc.dal.dbobj.misc.Country value, java.lang.String... args)
Contact	setMailPostCode(java.lang.String value, java.lang.String... args)
Contact	setMailState(com.aspc.dal.dbobj.misc.StateRegion value, java.lang.String... args)
Contact	setMailSuburbCity(java.lang.String value, java.lang.String... args)
Contact	setName(java.lang.String value, java.lang.String... args)
Contact	setNoEmailCorrespondance(boolean value, java.lang.String... args)
Contact	setNotes(java.lang.String value, java.lang.String... args)
Contact	setPhone(java.lang.String value, java.lang.String... args)
Contact	setPostcode(java.lang.String value, java.lang.String... args)
Contact	setPrimaryType(java.lang.String value, java.lang.String... args)
Contact	setPrivate(boolean value, java.lang.String... args)
Contact	setProperties(java.util.List value, java.lang.String... args)
Contact	setReferenceable(boolean value, java.lang.String... args)
Contact	setReferencesUUID(java.util.List<java.lang.String> value, java.lang.String... args)
Contact	setSequence(int value, java.lang.String... args)
Contact	setSocialFacebook(java.lang.String value, java.lang.String... args)
Contact	setSocialGithub(java.lang.String value, java.lang.String... args)
Contact	setSocialGooglePlus(java.lang.String value, java.lang.String... args)
Contact	setSocialInstagram(java.lang.String value, java.lang.String... args)
Contact	setSocialLinkedIn(java.lang.String value, java.lang.String... args)
Contact	setSocialPinterest(java.lang.String value, java.lang.String... args)
Contact	setSocialTwitter(java.lang.String value, java.lang.String... args)
Contact	setSocialYoutube(java.lang.String value, java.lang.String... args)
Contact	setState(com.aspc.dal.dbobj.misc.StateRegion value, java.lang.String... args)
Contact	setSuburbCity(java.lang.String value, java.lang.String... args)
Contact	setTFN(long value, java.lang.String... args)
Contact	setTmpAttachmentKey(java.lang.String value, java.lang.String... args)
Contact	setUUID(java.lang.String value, java.lang.String... args)
Contact	setVersionable(boolean value, java.lang.String... args)
Contact	setWeakReferencesUUID(java.util.List<java.lang.String> value, java.lang.String... args)
java.lang.String	toString() The description.
java.lang.String	vDisplayName()
java.lang.String	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, extSetValue, extUndelete, extValidateDelete, extValidateField, 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

DBEVERYONE_CONTACT

public static final GlobalId DBEVERYONE_CONTACT

everyone

DBUSERS_CONTACT

public static final GlobalId DBUSERS_CONTACT

users

DBUSERS_ADMIN

public static final GlobalId DBUSERS_ADMIN

admin

DBFIELD_MOBILE

public static final java.lang.String DBFIELD_MOBILE

See Also:

Constant Field Values

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

A person or company may be a contact of the system. They are both legal entities and share many properties. A job maybe done for a person or a company but you can only marry another person. So many fields will be linked to contact and others like "mother" would be linked to person.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

A person or company may be a contact of the system. They are both legal entities and share many properties. A job maybe done for a person or a company but you can only marry another person. So many fields will be linked to contact and others like "mother" would be linked to person.

Constructor Detail

Contact

public Contact(DBClass def,
               DataSource dataSource)
        throws java.lang.Exception

Std. DBObject constructor.

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getContactId

@CheckReturnValue
public int getContactId(java.lang.String... args)

setContactId

@Nonnull
public Contact setContactId(int value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getTFN

@CheckReturnValue
public long getTFN(java.lang.String... args)

setTFN

@Nonnull
public Contact setTFN(long value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getUUID

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

setUUID

@Nonnull
public Contact setUUID(java.lang.String value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getAddress

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

setAddress

@Nonnull
public Contact setAddress(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

canReceiveAlert

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

getContactPerson

@CheckReturnValue
 @Nullable
public Person getContactPerson(java.lang.String... args)

findContactPerson

@CheckReturnValue
 @Nonnull
public final Person findContactPerson(java.lang.String... args)
                                                           throws NotFoundException

An alternative contact person for this record.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setContactPerson

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

Throws:

java.lang.Exception

isContains

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

getCoordinate

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

setCoordinate

@Nonnull
public Contact setCoordinate(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getCountry

@CheckReturnValue
 @Nullable
public Country getCountry(java.lang.String... args)

findCountry

@CheckReturnValue
 @Nonnull
public final Country findCountry(java.lang.String... args)
                                                      throws NotFoundException

Country code,
eg, UK, United Kingdom.

--> Country (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Country

Throws:

NotFoundException - Country was not found

setCountry

@Nonnull
public Contact setCountry(com.aspc.dal.dbobj.misc.Country value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getCurrentEmail

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

getDisplayEmail

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

getDisplayMailAddress

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

getDisplayMailCountry

@CheckReturnValue
 @Nullable
public Country getDisplayMailCountry(java.lang.String... args)

findDisplayMailCountry

@CheckReturnValue
 @Nonnull
public final Country findDisplayMailCountry(java.lang.String... args)
                                                                 throws NotFoundException

If mail address is blank then use the street address' country.

--> Country (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Country

Throws:

NotFoundException - Country was not found

getDisplayMailPostCode

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

getDisplayMailState

@CheckReturnValue
 @Nullable
public StateRegion getDisplayMailState(java.lang.String... args)

findDisplayMailState

@CheckReturnValue
 @Nonnull
public final StateRegion findDisplayMailState(java.lang.String... args)
                                                                   throws NotFoundException

If mail address is blank then use the street address' state.

--> StateRegion (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

StateRegion

Throws:

NotFoundException - StateRegion was not found

getDisplayMailSuburbCity

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

getEmail

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

setEmail

@Nonnull
public Contact setEmail(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getFax

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

setFax

@Nonnull
public Contact setFax(java.lang.String value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getFullTextSearchScore

@CheckReturnValue
public double getFullTextSearchScore(java.lang.String... args)

hasReadAccess

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

isAdmin

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

setAdmin

@Nonnull
public Contact setAdmin(boolean value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

isChildNode

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

isDescendantNode

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

isSameNode

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

getKeyWords

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

setKeyWords

@Nonnull
public Contact setKeyWords(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getLastModifiedBy

@CheckReturnValue
 @Nullable
public Person getLastModifiedBy(java.lang.String... args)

findLastModifiedBy

@CheckReturnValue
 @Nonnull
public final Person findLastModifiedBy(java.lang.String... args)
                                                            throws NotFoundException

User that last modified this contact.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

setLastModifiedBy

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

Throws:

java.lang.Exception

getLastModifiedTime

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

setLastModifiedTime

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

Throws:

java.lang.Exception

getMailAddress

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

setMailAddress

@Nonnull
public Contact setMailAddress(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getMailCountry

@CheckReturnValue
 @Nullable
public Country getMailCountry(java.lang.String... args)

findMailCountry

@CheckReturnValue
 @Nonnull
public final Country findMailCountry(java.lang.String... args)
                                                          throws NotFoundException

Country code,
eg, UK, United Kingdom.

--> Country (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Country

Throws:

NotFoundException - Country was not found

setMailCountry

@Nonnull
public Contact setMailCountry(com.aspc.dal.dbobj.misc.Country value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getMailPostCode

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

setMailPostCode

@Nonnull
public Contact setMailPostCode(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getMailState

@CheckReturnValue
 @Nullable
public StateRegion getMailState(java.lang.String... args)

findMailState

@CheckReturnValue
 @Nonnull
public final StateRegion findMailState(java.lang.String... args)
                                                            throws NotFoundException

State/Territory.

--> StateRegion (String, Searchable)

Parameters:

args - the optional arguments

Returns:

StateRegion

Throws:

NotFoundException - StateRegion was not found

setMailState

@Nonnull
public Contact setMailState(com.aspc.dal.dbobj.misc.StateRegion value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getMailSuburbCity

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

setMailSuburbCity

@Nonnull
public Contact setMailSuburbCity(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getMapsHREF

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

getName

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

setName

@Nonnull
public Contact setName(java.lang.String value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

isNoEmailCorrespondance

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

setNoEmailCorrespondance

@Nonnull
public Contact setNoEmailCorrespondance(boolean value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

isNoEmailCorrespondanceDrv

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

getNotes

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

setNotes

@Nonnull
public Contact setNotes(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getPhone

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

setPhone

@Nonnull
public Contact setPhone(@MatchesPattern(value="(\\+|)( |)((\\(|)[0-9]{1,4}(\\)|)[ \\-\\.]{0,1}){1,5}(( |)*(x|ext)( |)*[0-9]{1,4}){0,1}")
                                 java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getPostcode

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

setPostcode

@Nonnull
public Contact setPostcode(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getPrimaryType

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

setPrimaryType

@Nonnull
public Contact setPrimaryType(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

isPrivate

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

setPrivate

@Nonnull
public Contact setPrivate(boolean value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getProperties

@CheckReturnValue
 @Nonnull
public java.util.List getProperties(java.lang.String... args)

setProperties

@Nonnull
public Contact setProperties(java.util.List value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

isPublic

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

isReferenceable

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

setReferenceable

@Nonnull
public Contact setReferenceable(boolean value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getReferencesUUID

@CheckReturnValue
 @Nonnull
public java.util.List<java.lang.String> getReferencesUUID(java.lang.String... args)

setReferencesUUID

@Nonnull
public Contact setReferencesUUID(java.util.List<java.lang.String> value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getSequence

@CheckReturnValue
public int getSequence(java.lang.String... args)

setSequence

@Nonnull
public Contact setSequence(int value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getSocialFacebook

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

setSocialFacebook

@Nonnull
public Contact setSocialFacebook(@MatchesPattern(value="([\\-A-Za-z\\d]{5,50}|pages/[\\-A-Za-z\\d]{5,}/[0-9]+)")
                                          java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getSocialGithub

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

setSocialGithub

@Nonnull
public Contact setSocialGithub(@MatchesPattern(value="[A-Za-z0-9_]*")
                                        java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getSocialGooglePlus

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

setSocialGooglePlus

@Nonnull
public Contact setSocialGooglePlus(@MatchesPattern(value="(\\+[A-Za-z0-9_]*|[0-9]/[0-9]+|[0-9]{15,})")
                                            java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getSocialInstagram

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

setSocialInstagram

@Nonnull
public Contact setSocialInstagram(@MatchesPattern(value="[A-Za-z0-9_]{4,30}")
                                           java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getSocialLinkedIn

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

setSocialLinkedIn

@Nonnull
public Contact setSocialLinkedIn(@MatchesPattern(value="((company|in)/[A-Za-z\\d\\-]{5,})|pub/.*")
                                          java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getSocialPinterest

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

setSocialPinterest

@Nonnull
public Contact setSocialPinterest(@MatchesPattern(value="[A-Za-z0-9_]*")
                                           java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getSocialTwitter

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

setSocialTwitter

@Nonnull
public Contact setSocialTwitter(@MatchesPattern(value="^[A-Za-z0-9_]{1,15}$")
                                         java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getSocialYoutube

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

setSocialYoutube

@Nonnull
public Contact setSocialYoutube(@MatchesPattern(value="[A-Za-z0-9_]*")
                                         java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getState

@CheckReturnValue
 @Nullable
public StateRegion getState(java.lang.String... args)

findState

@CheckReturnValue
 @Nonnull
public final StateRegion findState(java.lang.String... args)
                                                        throws NotFoundException

State or Territory abreviation, eg, NSW.

--> StateRegion (String, Searchable)

Parameters:

args - the optional arguments

Returns:

StateRegion

Throws:

NotFoundException - StateRegion was not found

setState

@Nonnull
public Contact setState(com.aspc.dal.dbobj.misc.StateRegion value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getSuburbCity

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

setSuburbCity

@Nonnull
public Contact setSuburbCity(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getTmpAttachmentKey

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

setTmpAttachmentKey

@Nonnull
public Contact setTmpAttachmentKey(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getUnsubscribeURL

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

isVersionable

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

setVersionable

@Nonnull
public Contact setVersionable(boolean value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getWeakReferencesUUID

@CheckReturnValue
 @Nonnull
public java.util.List<java.lang.String> getWeakReferencesUUID(java.lang.String... args)

setWeakReferencesUUID

@Nonnull
public Contact setWeakReferencesUUID(java.util.List<java.lang.String> value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<Contact> makeQuery(@Nonnull
                                                                     DataSource ds)
                                                              throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static Contact findKey(@Nonnull
                                                          DataSource ds,
                                                          int key)
                                                   throws NotFoundException,
                                                          java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

displayName

@CheckReturnValue
 @Nonnull
public java.lang.String displayName()

The human display name of this object.

Overrides:

displayName in class DBObject

Returns:

the display name

toString

@CheckReturnValue
 @Nonnull
public java.lang.String toString()

The description.

Overrides:

toString in class DBObject

Returns:

The description

isInternal

@CheckReturnValue
public boolean isInternal()

Returns:

the value

extGetDerivedGlobalKey

@CheckReturnValue
 @Nullable
protected GlobalKey extGetDerivedGlobalKey(@Nonnull
                                                                        DBField field,
                                                                        @Nullable
                                                                        FldParams inParams)
                                                                 throws java.lang.Exception

displayMailCountry is linked and derived

Overrides:

extGetDerivedGlobalKey in class DBObject

Parameters:

field - The field

inParams - the field parameters

Returns:

The global key

Throws:

java.lang.Exception - A serious problem

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 DBObject

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

encodeUnsubscribeId

public java.lang.String encodeUnsubscribeId()
                                     throws java.lang.Exception

Throws:

java.lang.Exception

decodeUnsubscribeId

public static java.lang.String[] decodeUnsubscribeId(java.lang.String s)
                                              throws java.lang.Exception

Parameters:

s - encoded string

Returns:

String array with layerid and global key

Throws:

java.io.UnsupportedEncodingException

java.lang.Exception

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 DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extPreValidate

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

Description copied from class: DBObject

OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS.

Overrides:

extPreValidate in class DBObject

Throws:

java.lang.Exception - a serious problem

extPreSaveRecord

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

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - A Serious problem

extPostSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPostSaveRecord(@Nonnegative
                                                                   long transNr)

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware AFTER saving the record to the database. At this stage the database transaction has been committed. YOU MAY NOT CHANGE THE UNIVERSE AT THIS STAGE.

Overrides:

extPostSaveRecord in class DBObject

Parameters:

transNr - This transaction number that was just saved.

eventFieldUpdated

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

update dependent fields.

Overrides:

eventFieldUpdated in class DBObject

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

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 DBObject

Throws:

java.lang.Exception - a serious problem

makeSearchPlan

@CheckReturnValue
 @Nonnull
public static SearchPlan makeSearchPlan(@Nonnull
                                                                    DBQuery<DBObject> query)

Allows for specific attributes to be set for the queries

Parameters:

query - The calling query

Returns:

The search plan

lastModified

@CheckReturnValue
public long lastModified()

isDirectory

@CheckReturnValue
public boolean isDirectory()

vName

@CheckReturnValue
 @Nonnull
public java.lang.String vName()

vDisplayName

@CheckReturnValue
 @Nonnull
public java.lang.String vDisplayName()

listNodes

@Nonnull
public DBNode[] listNodes()
                            throws java.lang.Exception

Throws:

java.lang.Exception