com.aspc.DBObj.Misc

Class StateRegion

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Misc.StateRegion

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

StateRegion

public class StateRegion
extends DBObject

Identifies a state/region within a country.

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

Since:

January 31, 2003, 4:44 PM

Author:

Jason McGrath

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 Identifies a state/region within a country.
static java.lang.String	DBCLASS_NAME Identifies a state/region within a country.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
StateRegion(DBClass def, DataSource dataSource) Creates new State/Region

Method Summary

Modifier and Type	Method and Description
static StateRegion	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.
protected void	extCheckModifyAccess(DBField field) May not change an State/Regions code/country.
protected void	extSetValue(DBField field, java.lang.Object currentValue, FldParams params) We prevent some values from being set by a user.
Country	findCountry(java.lang.String... args) Country.
static StateRegion	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
static StateRegion	findState(MutableDataSource mds, java.lang.String country, java.lang.String state)
static StateRegion	findStateByCodeOrName(DataSource ds, Country country, java.lang.String state) find the state in the given country, if country is null, find the first matching state
java.lang.String	getCode(java.lang.String... args)
Country	getCountry(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
java.lang.String	getStateRegionKey(java.lang.String... args)
static DBQuery<StateRegion>	makeQuery(DataSource ds) Make a new QUERY for this class.
StateRegion	setCode(java.lang.String value, java.lang.String... args)
StateRegion	setCountry(com.aspc.dal.dbobj.misc.Country value, java.lang.String... args)
StateRegion	setName(java.lang.String value, java.lang.String... args)
StateRegion	setStateRegionKey(java.lang.String 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, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, 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

Identifies a state/region within a country.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Identifies a state/region within a country.

Constructor Detail

StateRegion

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

Creates new State/Region

Parameters:

def - The class

dataSource - The user datasource

Throws:

java.lang.Exception - A serious problem

Method Detail

getStateRegionKey

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

setStateRegionKey

@Nonnull
public StateRegion setStateRegionKey(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getCode

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

setCode

@Nonnull
public StateRegion setCode(java.lang.String 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.

--> Country (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Country

Throws:

NotFoundException - Country was not found

setCountry

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

Throws:

java.lang.Exception

getName

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

setName

@Nonnull
public StateRegion setName(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static StateRegion 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<StateRegion> 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 StateRegion findKey(@Nonnull
                                                              DataSource ds,
                                                              @Nonnull
                                                              java.lang.String 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

findState

public static StateRegion findState(MutableDataSource mds,
                                    java.lang.String country,
                                    java.lang.String state)
                             throws java.lang.Exception

Throws:

java.lang.Exception

findStateByCodeOrName

@Nonnull
public static StateRegion findStateByCodeOrName(DataSource ds,
                                                         Country country,
                                                         java.lang.String state)
                                                  throws java.lang.Exception

find the state in the given country, if country is null, find the first matching state

Parameters:

ds -

country -

state -

Returns:

Throws:

java.lang.Exception

extCheckModifyAccess

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

May not change an State/Regions code/country.

Overrides:

extCheckModifyAccess in class DBObject

Parameters:

field - The field

Throws:

DBAccessException - You don't have access

extSetValue

protected void extSetValue(DBField field,
                           java.lang.Object currentValue,
                           FldParams params)
                    throws java.lang.Exception

We prevent some values from being set by a user.

Overrides:

extSetValue in class DBObject

Parameters:

field - The field that is being changed

currentValue - The new value

params - The extra parameters

Throws:

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