com.aspc.Layers.aspc_app.Branch

Class Branch

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Contact.Contact

com.aspc.DBObj.Contact.Company

com.aspc.Layers.aspc_app.Contact.Company

com.aspc.Layers.aspc_app.Branch.Branch

All Implemented Interfaces:

SecondaryCacheGroup

public class Branch
extends Company

Branch.java Business Branch.

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

Since:

$Date: 2014-12-18 01:46:49 $

Author:

Liam

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

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
Branch(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Calculate the derived global key for this field.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsMandatory(DBField field) Conditional mandatory field.
Branch	findParentBranch(java.lang.String... args) The parent branch if it's a sub-branch.
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getCodeAndName(java.lang.String... args)
int	getMembersCount(java.lang.String... args)
Branch	getParentBranch(java.lang.String... args)
boolean	isInCountry(java.lang.String... args)
boolean	isSub(java.lang.String... args)
Branch	setCode(java.lang.String value, java.lang.String... args)
Branch	setInCountry(boolean value, java.lang.String... args)
Branch	setParentBranch(com.aspc.dal.layers.aspc_app.branch.Branch value, java.lang.String... args)

Methods inherited from class com.aspc.Layers.aspc_app.Contact.Company

eventFieldUpdated, extAutoEnterCreate, extCheckModifyAccess, extFixUp, extGetValue, extIsOnChange, extSetValue, extValidateField, findAccountant, findCompanyLogo, findDefaultStockBin, findOrganisationType, findRootBusiness, findSiteManager, getAccountant, getAccountNumber, getAccountsEmail, getAustCompanyNo, getCalcNumEmployees, getCeasedTradingDate, getCompanyLogo, getDefaultStockBin, getDescription, getDisplayAddress, getDisplayMailAddress, getDxExchangeBox, getDxNumber, getNoEmployees, getOrganisationName, getOrganisationType, getRootBusiness, getSiteManager, hasSubsidiaryCompany, isCeasedTrading, isChildBusUnitOf, setAccountant, setAccountNumber, setAccountsEmail, setAustCompanyNo, setCeasedTrading, setCeasedTradingDate, setCompanyLogo, setDefaultStockBin, setDescription, setDxExchangeBox, setDxNumber, setNoEmployees, setOrganisationName, setOrganisationType, setSiteManager

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

extPreSaveRecord, findLogo, findParentBusUnit, getABN, getAboutUs, getAccountPayableEmail, getACN, getDisplayABN, getElectoralDivision, getLogo, getMission, getParentBusUnit, getParentCompany, getRootBusUnit, getSlogan, getWebSite, inFamily, setABN, setAboutUs, setAccountPayableEmail, setACN, setElectoralDivision, setLogo, setMission, setParentBusUnit, setSlogan, setWebSite

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

canReceiveAlert, decodeUnsubscribeId, displayName, encodeUnsubscribeId, 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, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extMarkSavePoint, extPostDeleteRecord, extPreDeleteRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, 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 Branch

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Business Branch

Constructor Detail

Branch

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

getCode

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

setCode

@Nonnull
public Branch setCode(java.lang.String value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getCodeAndName

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

isInCountry

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

setInCountry

@Nonnull
public Branch setInCountry(boolean value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

isSub

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

getMembersCount

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

getParentBranch

@CheckReturnValue
 @Nullable
public Branch getParentBranch(java.lang.String... args)

findParentBranch

@CheckReturnValue
 @Nonnull
public final Branch findParentBranch(java.lang.String... args)
                                                          throws NotFoundException

The parent branch if it's a sub-branch.

--> Branch (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Branch

Throws:

NotFoundException - Branch was not found

setParentBranch

@Nonnull
public Branch setParentBranch(com.aspc.dal.layers.aspc_app.branch.Branch value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

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 Company

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

extGetDerivedGlobalKey

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

Calculate the derived global key for this field.

Overrides:

extGetDerivedGlobalKey in class Company

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated global key

Throws:

java.lang.Exception - A serious problem

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class DBObject

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)