com.aspc.DBObj.Contact

Class Company

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Contact.Contact

com.aspc.DBObj.Contact.Company

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

Company

public class Company
extends Contact

Generic DBObject.

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

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

Method Summary

Modifier and Type	Method and Description
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 void	extPreSaveRecord() presave
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
DBFile	findLogo(java.lang.String... args) Logo.
Company	findParentBusUnit(java.lang.String... args) Parent business unit.
java.lang.String	getABN(java.lang.String... args)
java.lang.String	getAboutUs(java.lang.String... args)
java.lang.String	getAccountPayableEmail(java.lang.String... args)
java.lang.String	getACN(java.lang.String... args)
java.lang.String	getDisplayABN(java.lang.String... args)
java.lang.String	getElectoralDivision(java.lang.String... args)
DBFile	getLogo(java.lang.String... args)
java.lang.String	getMission(java.lang.String... args)
Company	getParentBusUnit(java.lang.String... args)
Company	getParentCompany() The parent company
Company	getRootBusUnit() The root business unit
java.lang.String	getSlogan(java.lang.String... args)
java.lang.String	getWebSite(java.lang.String... args)
boolean	inFamily(Company c) In the family tree
Company	setABN(java.lang.String value, java.lang.String... args)
Company	setAboutUs(java.lang.String value, java.lang.String... args)
Company	setAccountPayableEmail(java.lang.String value, java.lang.String... args)
Company	setACN(java.lang.String value, java.lang.String... args)
Company	setElectoralDivision(java.lang.String value, java.lang.String... args)
Company	setLogo(com.aspc.dal.file.DBFile value, java.lang.String... args)
Company	setMission(java.lang.String value, java.lang.String... args)
Company	setParentBusUnit(com.aspc.dal.dbobj.contact.Business value, java.lang.String... args)
Company	setSlogan(java.lang.String value, java.lang.String... args)
Company	setWebSite(java.lang.String value, java.lang.String... args)

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

canReceiveAlert, decodeUnsubscribeId, displayName, encodeUnsubscribeId, eventFieldUpdated, extGetDerivedGlobalKey, extPostSaveRecord, 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, 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, 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

Business

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Business

Constructor Detail

Company

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

Creates new DBObject.

Parameters:

def - The class

dataSource - Your current data source

Throws:

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

Method Detail

getABN

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

setABN

@Nonnull
public Company setABN(@MatchesPattern(value="^(\\d *?){11}$")
                               java.lang.String value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getACN

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

setACN

@Nonnull
public Company setACN(java.lang.String value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getAboutUs

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

setAboutUs

@Nonnull
public Company setAboutUs(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getAccountPayableEmail

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

setAccountPayableEmail

@Nonnull
public Company setAccountPayableEmail(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getDisplayABN

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

getElectoralDivision

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

setElectoralDivision

@Nonnull
public Company setElectoralDivision(java.lang.String value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getLogo

@CheckReturnValue
 @Nullable
public DBFile getLogo(java.lang.String... args)

findLogo

@CheckReturnValue
 @Nonnull
public final DBFile findLogo(java.lang.String... args)
                                                  throws NotFoundException

Logo.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setLogo

@Nonnull
public Company setLogo(com.aspc.dal.file.DBFile value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getMission

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

setMission

@Nonnull
public Company setMission(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getParentBusUnit

@CheckReturnValue
 @Nullable
public Company getParentBusUnit(java.lang.String... args)

findParentBusUnit

@CheckReturnValue
 @Nonnull
public final Company findParentBusUnit(java.lang.String... args)
                                                            throws NotFoundException

Parent business unit.

--> Business (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Business

Throws:

NotFoundException - Business was not found

setParentBusUnit

@Nonnull
public Company setParentBusUnit(com.aspc.dal.dbobj.contact.Business value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getSlogan

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

setSlogan

@Nonnull
public Company setSlogan(java.lang.String value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getWebSite

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

setWebSite

@Nonnull
public Company setWebSite(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getRootBusUnit

public Company getRootBusUnit()

The root business unit

Returns:

the root business unit

getParentCompany

public Company getParentCompany()

The parent company

Returns:

parent company

extFixUp

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

Description copied from class: Contact

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

inFamily

public boolean inFamily(Company c)

In the family tree

Parameters:

c - The company to check

Returns:

true if in the tree

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 Contact

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

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

extPreSaveRecord

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

presave

Overrides:

extPreSaveRecord in class Contact

Throws:

java.lang.Exception - a serious problem