com.aspc.Layers.aspc_app.Misc

Class Address

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Misc.Address

All Implemented Interfaces:

SecondaryCacheGroup

public class Address
extends DBObject

Additional Address.

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

Since:

10 June 2016

Author:

Liam Itzhaki

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

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static Address	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
Contact	findContact(java.lang.String... args) Contact Id.
Country	findCountry(java.lang.String... args) Country code, eg, UK, United Kingdom.
static Address	findKey(DataSource ds, int key) Find the target for this class by the primary key
StateRegion	findState(java.lang.String... args) State or Territory abreviation, eg, NSW.
ContactAddressType	findType(java.lang.String... args) Address type.
Contact	getContact(java.lang.String... args)
Country	getCountry(java.lang.String... args)
int	getID(java.lang.String... args)
java.lang.String	getPostcode(java.lang.String... args)
java.lang.String	getShortDesc(java.lang.String... args)
StateRegion	getState(java.lang.String... args)
java.lang.String	getStreet(java.lang.String... args)
java.lang.String	getSuburbCity(java.lang.String... args)
ContactAddressType	getType(java.lang.String... args)
static DBQuery<Address>	makeQuery(DataSource ds) Make a new QUERY for this class.
Address	setContact(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
Address	setCountry(com.aspc.dal.dbobj.misc.Country value, java.lang.String... args)
Address	setID(int value, java.lang.String... args)
Address	setPostcode(java.lang.String value, java.lang.String... args)
Address	setShortDesc(java.lang.String value, java.lang.String... args)
Address	setState(com.aspc.dal.layers.aspc_app.misc.StateRegion value, java.lang.String... args)
Address	setStreet(java.lang.String value, java.lang.String... args)
Address	setSuburbCity(java.lang.String value, java.lang.String... args)
Address	setType(com.aspc.dal.layers.aspc_app.contact.ContactAddressType value, java.lang.String... args)

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, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, extValidateRecord, 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

Additional Address

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Additional Address

Constructor Detail

Address

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

getID

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

setID

@Nonnull
public Address setID(int value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getContact

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

findContact

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

Contact Id.

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setContact

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

Throws:

java.lang.Exception

getCountry

@CheckReturnValue
 @Nullable
public Country getCountry(java.lang.String... args)

findCountry

@CheckReturnValue
 @Nonnull
public final Country findCountry(java.lang.String... args)
                                                      throws NotFoundException

Country code,
eg, UK, United Kingdom.

--> Country (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Country

Throws:

NotFoundException - Country was not found

setCountry

@Nonnull
public Address setCountry(com.aspc.dal.dbobj.misc.Country value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getPostcode

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

setPostcode

@Nonnull
public Address setPostcode(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getShortDesc

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

setShortDesc

@Nonnull
public Address setShortDesc(java.lang.String value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getState

@CheckReturnValue
 @Nullable
public StateRegion getState(java.lang.String... args)

findState

@CheckReturnValue
 @Nonnull
public final StateRegion findState(java.lang.String... args)
                                                        throws NotFoundException

State or Territory abreviation, eg, NSW.

--> StateRegion (String, Searchable)

Parameters:

args - the optional arguments

Returns:

StateRegion

Throws:

NotFoundException - StateRegion was not found

setState

@Nonnull
public Address setState(com.aspc.dal.layers.aspc_app.misc.StateRegion value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getStreet

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

setStreet

@Nonnull
public Address setStreet(java.lang.String value,
                                  java.lang.String... args)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getSuburbCity

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

setSuburbCity

@Nonnull
public Address setSuburbCity(java.lang.String value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getType

@CheckReturnValue
 @Nullable
public ContactAddressType getType(java.lang.String... args)

findType

@CheckReturnValue
 @Nonnull
public final ContactAddressType findType(java.lang.String... args)
                                                              throws NotFoundException

Address type.

--> ContactAddressType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

ContactAddressType

Throws:

NotFoundException - ContactAddressType was not found

setType

@Nonnull
public Address setType(com.aspc.dal.layers.aspc_app.contact.ContactAddressType value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static Address create(@Nonnull
                                                         MutableDataSource mds)
                                                  throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<Address> makeQuery(@Nonnull
                                                                     DataSource ds)
                                                              throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static Address findKey(@Nonnull
                                                          DataSource ds,
                                                          int key)
                                                   throws NotFoundException,
                                                          java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

eventFieldUpdated

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

update dependent fields.

Overrides:

eventFieldUpdated in class DBObject

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