com.aspc.DBObj.Contact

Class ContactGroup

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Contact.Contact

com.aspc.DBObj.Contact.PermissionedContact

com.aspc.DBObj.Contact.ContactGroup

All Implemented Interfaces:

DependanceListener, ReloadEventListener, Watcher, SecondaryCacheGroup

Direct Known Subclasses:

ContactGroup

public class ContactGroup
extends PermissionedContact
implements DependanceListener, ReloadEventListener

Groups businesses and people together.

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

Since:

May 8, 2003, 2:50 PM

Author:

ContactGroup

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 java.lang.String	CONTACT_GROUP_MEMBERS_CACHE_KEY Key used to retrieve cached data for contact group maps
static GlobalId	DBCLASS_GID Groups businesses and people together
static java.lang.String	DBCLASS_NAME Groups businesses and people together
static java.lang.String	GROUP_CONTACTS_CACHE_KEY
static java.lang.String	IGNORE_EXCLUDES ignore the exclusion of contacts from groups

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
ContactGroup(DBClass def, DataSource dataSource) Creates new Group.

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.
void	eventDependantAdded(GlobalKey addedKey, GlobalKey sourceFieldKey) A record that points to this record was added.
void	eventDependantRemoved(GlobalKey removedKey, GlobalKey sourceFieldKey) A record that points to this record was removed.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) clear the cache
void	eventReload(DBObject obj) Called when a watched DBObject is reloaded, internally or externally.
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.
PersonGroupType	findGroupType(java.lang.String... args) link to PersonGroupType.
PersonGroupType	getGroupType(java.lang.String... args)
protected PermissionedContact	getIsMemberOfUser(DataSource ds, FldParams params) Finds the correct user to be checking if they are a member of this group
boolean	hideAssignToGroup(java.lang.String... args)
ContactGroup	setGroupType(com.aspc.dal.dbobj.contact.PersonGroupType value, java.lang.String... args)
ContactGroup	setHideAssignToGroup(boolean 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, 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, 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

Methods inherited from interface com.aspc.DBObj.Listeners.Watcher

registerWatchedObject

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Groups businesses and people together

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Groups businesses and people together

IGNORE_EXCLUDES

public static final java.lang.String IGNORE_EXCLUDES

ignore the exclusion of contacts from groups

See Also:

Constant Field Values

CONTACT_GROUP_MEMBERS_CACHE_KEY

public static final java.lang.String CONTACT_GROUP_MEMBERS_CACHE_KEY

Key used to retrieve cached data for contact group maps

See Also:

Constant Field Values

GROUP_CONTACTS_CACHE_KEY

public static final java.lang.String GROUP_CONTACTS_CACHE_KEY

See Also:

Constant Field Values

Constructor Detail

ContactGroup

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

Creates new Group.

Parameters:

def - The class def.

dataSource - The current datasource

Throws:

java.lang.Exception - A serious problem

Method Detail

getGroupType

@CheckReturnValue
 @Nullable
public PersonGroupType getGroupType(java.lang.String... args)

findGroupType

@CheckReturnValue
 @Nonnull
public final PersonGroupType findGroupType(java.lang.String... args)
                                                                throws NotFoundException

link to PersonGroupType.

--> PersonGroupType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

PersonGroupType

Throws:

NotFoundException - PersonGroupType was not found

setGroupType

@Nonnull
public ContactGroup setGroupType(com.aspc.dal.dbobj.contact.PersonGroupType value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

hideAssignToGroup

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

setHideAssignToGroup

@Nonnull
public ContactGroup setHideAssignToGroup(boolean value,
                                                  java.lang.String... args)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

eventFieldUpdated

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

clear the cache

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

eventDependantAdded

public void eventDependantAdded(GlobalKey addedKey,
                                GlobalKey sourceFieldKey)

A record that points to this record was added. The object is available via findKey.

Specified by:

eventDependantAdded in interface DependanceListener

Parameters:

addedKey - The record's key that was added.

sourceFieldKey - Via which field is this object linked ?

eventDependantRemoved

public void eventDependantRemoved(GlobalKey removedKey,
                                  GlobalKey sourceFieldKey)

A record that points to this record was removed. Only the global key is avaliable now.

Specified by:

eventDependantRemoved in interface DependanceListener

Parameters:

removedKey - The record key that was removed.

sourceFieldKey - Via which field was this object linked ?

clearCache

@OverridingMethodsMustInvokeSuper
protected void clearCache(@Nullable
                                                            GlobalKey changedKey)

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 - The key that was changed.

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

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 to check if modifications are allowed

Throws:

DBAccessException - No access to modify

eventReload

public void eventReload(@Nonnull
                        DBObject obj)

Called when a watched DBObject is reloaded, internally or externally. Use to clear secondary caches

Specified by:

eventReload in interface ReloadEventListener

Parameters:

obj - The object that was reloaded.

getIsMemberOfUser

protected PermissionedContact getIsMemberOfUser(DataSource ds,
                                                FldParams params)
                                         throws java.lang.Exception

Finds the correct user to be checking if they are a member of this group

Parameters:

ds - the data source

params - field parameters containing details of the user to be checked

Returns:

the value

Throws:

java.lang.Exception - a serious problem