com.aspc.Layers.aspc_app.Contact

Class ContactRelationshipMap

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Contact.ContactMap

com.aspc.Layers.aspc_app.Contact.ContactRelationshipMap

All Implemented Interfaces:

SecondaryCacheGroup

public class ContactRelationshipMap
extends ContactMap

Contact relationship map.

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

Since:

November 9, 2006, 1:05 AM

Author:

nabhilash

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 Contact relationship map
static java.lang.String	DBCLASS_NAME Contact relationship map

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extValidateRecord(ValidationList list) checks duplicate contact.
Contact	findDisplayContact(java.lang.String... args) Returns the opposite contact based to the contact supplied through the BASE_CONTACT field parameter.
ContactRelationshipType	findDisplayType(java.lang.String... args) Returns the correct type based on the BASE_CONTACT field parameter.
Contact	findRelatedContact(java.lang.String... args) related contacts.
ContactRelationshipType	findRelationshipType(java.lang.String... args) type of relationship.
java.lang.String	getDetails(java.lang.String... args)
Contact	getDisplayContact(java.lang.String... args)
ContactRelationshipType	getDisplayType(java.lang.String... args)
Contact	getRelatedContact(java.lang.String... args)
ContactRelationshipType	getRelationshipType(java.lang.String... args)
ContactRelationshipMap	setDetails(java.lang.String value, java.lang.String... args)
ContactRelationshipMap	setRelatedContact(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
ContactRelationshipMap	setRelationshipType(com.aspc.dal.layers.aspc_app.contact.ContactRelationshipType value, java.lang.String... args)
ContactRelationshipMap	setUseContactDetails(boolean value, java.lang.String... args)
boolean	useContactDetails(java.lang.String... args)

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

extFixUp, findContact, findEnteredBy, findKey, getContact, getEnteredBy, getEnterTime, getID, getLastModifiedTime, makeQuery, setContact, setEnteredBy, setEnterTime, setID, setLastModifiedTime

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, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, 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, makeSearchPlan, 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, toString, 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

Contact relationship map

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Contact relationship map

Constructor Detail

ContactRelationshipMap

public ContactRelationshipMap(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

getDetails

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

setDetails

@Nonnull
public ContactRelationshipMap setDetails(java.lang.String value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayContact

@CheckReturnValue
 @Nullable
public Contact getDisplayContact(java.lang.String... args)

findDisplayContact

@CheckReturnValue
 @Nonnull
public final Contact findDisplayContact(java.lang.String... args)
                                                             throws NotFoundException

Returns the opposite contact based to the contact supplied through the BASE_CONTACT field parameter.

--> Contact (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

getDisplayType

@CheckReturnValue
 @Nullable
public ContactRelationshipType getDisplayType(java.lang.String... args)

findDisplayType

@CheckReturnValue
 @Nonnull
public final ContactRelationshipType findDisplayType(java.lang.String... args)
                                                                          throws NotFoundException

Returns the correct type based on the BASE_CONTACT field parameter.

--> ContactRelationshipType (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

ContactRelationshipType

Throws:

NotFoundException - ContactRelationshipType was not found

getRelatedContact

@CheckReturnValue
 @Nullable
public Contact getRelatedContact(java.lang.String... args)

findRelatedContact

@CheckReturnValue
 @Nonnull
public final Contact findRelatedContact(java.lang.String... args)
                                                             throws NotFoundException

related contacts.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setRelatedContact

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

Throws:

java.lang.Exception

getRelationshipType

@CheckReturnValue
 @Nullable
public ContactRelationshipType getRelationshipType(java.lang.String... args)

findRelationshipType

@CheckReturnValue
 @Nonnull
public final ContactRelationshipType findRelationshipType(java.lang.String... args)
                                                                               throws NotFoundException

type of relationship.

--> ContactRelationshipType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

ContactRelationshipType

Throws:

NotFoundException - ContactRelationshipType was not found

setRelationshipType

@Nonnull
public ContactRelationshipMap setRelationshipType(com.aspc.dal.layers.aspc_app.contact.ContactRelationshipType value,
                                                           java.lang.String... args)
                                                    throws java.lang.Exception

Throws:

java.lang.Exception

useContactDetails

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

setUseContactDetails

@Nonnull
public ContactRelationshipMap setUseContactDetails(boolean value,
                                                            java.lang.String... args)
                                                     throws java.lang.Exception

Throws:

java.lang.Exception

extValidateRecord

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

checks duplicate contact.

Overrides:

extValidateRecord in class DBObject

Parameters:

list -

Throws:

java.lang.Exception - 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