com.aspc.DBObj.Contact

Class PathGroup

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Contact.Contact

com.aspc.DBObj.Contact.PermissionedContact

com.aspc.DBObj.Contact.PathGroup

All Implemented Interfaces:

DBClassListener, SecondaryCacheGroup

Direct Known Subclasses:

PathGroup

public class PathGroup
extends PermissionedContact
implements DBClassListener

Generic DBObject.

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

Since:

December 16, 2003, 2:50 PM

Author:

PathGroup

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 PathGroup
static java.lang.String	DBCLASS_NAME PathGroup

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
PathGroup(DBClass theClass, DataSource dataSource) Creates new DBObject.

Method Summary

Modifier and Type	Method and Description
protected void	clearCache(GlobalKey changedKey) Automatically called for eventDataLoaded() with this GlobalKey and getCleanVersion() with null for the global key.
protected void	clearTargetCache()
void	eventObjectCreated(GlobalKey createdKey, VirtualDB layer) The record was created.
void	eventObjectDeleted(GlobalKey deletedKey, VirtualDB layer) The record was deleted.
void	eventObjectModified(GlobalKey modifiedKey, VirtualDB layer) The record was modified.
protected void	extCheckModifyAccess(DBField field) Additional access checking for write access of this object.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsMemberOf(DBField field, FldParams params, Path pth, DBObject base, boolean isBusiness)
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
java.lang.String	getFieldPath(java.lang.String... args)
protected java.lang.String	getMembers(DBField field, FldParams params)
protected java.util.HashMap	getPersonMap(GlobalKey loginObject, Path pth)
protected java.lang.Object	isMemberOf(DBField field, FldParams params)
protected boolean	isMemberOf(PermissionedContact pc)
boolean	isValid(FldParams params)
PathGroup	setFieldPath(java.lang.String value, java.lang.String... args)

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

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

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

canReceiveAlert, decodeUnsubscribeId, displayName, encodeUnsubscribeId, eventFieldUpdated, extFixUp, extGetDerivedGlobalKey, extPostSaveRecord, extPreSaveRecord, extPreValidate, extValidateRecord, 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, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayValue, doSearch, dump, equals, eventDataLoaded, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPreDeleteRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, 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

PathGroup

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

PathGroup

Constructor Detail

PathGroup

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

getFieldPath

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

setFieldPath

@Nonnull
public PathGroup setFieldPath(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

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

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess(@Nonnull
                                                                      DBField field)
                                                               throws DBAccessException

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Parameters:

field - The field

Throws:

DBAccessException - No access to modify

clearCache

@OverridingMethodsMustInvokeSuper
protected void clearCache(@Nullable
                                                            GlobalKey changedKey)

Description copied from class: DBObject

Automatically called for eventDataLoaded() with this GlobalKey and getCleanVersion() with null for the global key. The design should clear ALL cache if the changedKey is null.

Overrides:

clearCache in class DBObject

Parameters:

changedKey -

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

isMemberOf

protected java.lang.Object isMemberOf(DBField field,
                                      FldParams params)
                               throws java.lang.Exception

Parameters:

field - The field

params - the field parameters

Returns:

the value

Throws:

java.lang.Exception - a serious problem

isMemberOf

protected boolean isMemberOf(PermissionedContact pc)
                      throws java.lang.Exception

Parameters:

pc -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

extIsMemberOf

protected boolean extIsMemberOf(DBField field,
                                FldParams params,
                                Path pth,
                                DBObject base,
                                boolean isBusiness)
                         throws java.lang.Exception

Parameters:

field - The field

params - the field parameters

pth -

base - the base object

isBusiness -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

getPersonMap

protected java.util.HashMap getPersonMap(GlobalKey loginObject,
                                         Path pth)
                                  throws java.lang.Exception

Parameters:

loginObject -

pth -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

eventObjectCreated

public void eventObjectCreated(@Nonnull
                               GlobalKey createdKey,
                               @Nonnull
                               VirtualDB layer)

Description copied from interface: DBClassListener

The record was created. (Not just loaded)

Specified by:

eventObjectCreated in interface DBClassListener

Parameters:

createdKey -

layer - the layer

eventObjectDeleted

public void eventObjectDeleted(@Nonnull
                               GlobalKey deletedKey,
                               @Nonnull
                               VirtualDB layer)

Description copied from interface: DBClassListener

The record was deleted.

Specified by:

eventObjectDeleted in interface DBClassListener

Parameters:

deletedKey -

layer - the layer

eventObjectModified

public void eventObjectModified(@Nonnull
                                GlobalKey modifiedKey,
                                @Nonnull
                                VirtualDB layer)

Description copied from interface: DBClassListener

The record was modified.

Specified by:

eventObjectModified in interface DBClassListener

Parameters:

modifiedKey -

layer - the layer

clearTargetCache

protected void clearTargetCache()

getMembers

protected java.lang.String getMembers(DBField field,
                                      FldParams params)
                               throws java.lang.Exception

Parameters:

field - The field

params - the field parameters

Returns:

the value

Throws:

java.lang.Exception - a serious problem

isValid

public boolean isValid(FldParams params)

Overrides:

isValid in class PermissionedContact

Parameters:

params - the field parameters

Returns:

the value