com.aspc.Layers.aspc_app.Misc

Class STGlobals

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Globals

com.aspc.Layers.aspc_app.Misc.STGlobals

All Implemented Interfaces:

SecondaryCacheGroup

public class STGlobals
extends Globals

STGlobals extends the Globals object so that fields and business logic specific to the app layer can be handled. Globals is a special DBObject. A VirtualDB has exactly ONE Global DBObject. The Global DBObject is always accessable even without a base object. It may be used to place the current user's name on a data entry screen.

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

Since:

4 October 2002, 11:19

Author:

Jason McGrath

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields inherited from class com.aspc.DBObj.Globals

DBCLASS_GID, DBCLASS_NAME

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
STGlobals(DBClass dbClass, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
void	extCheckModifyAccess(DBField field) Additional access checking for write access of this object.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) get the derived fields
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
Campaign	findCurrentCampaign(java.lang.String... args) Current Campaign.
SiteSpider	findCurrentSpider(java.lang.String... args) Helper for Site Spider screen.
TimeSheet	findCurrentTimeSheet(java.lang.String... args) Current Time Sheet.
DBDashboard	findDashboard(java.lang.String... args) Dashboard object.
Country	findDefaultCountry(java.lang.String... args) Sets the default country to use when creating new contacts, etc.
StockBin	findDefaultStockBin(java.lang.String... args) Retrieves the default Stock Bin for this user.
DBMonthOfYear	findFinancialYearStartMonth(java.lang.String... args) financial year start Month.
Person	findOwner(java.lang.String... args) Owner.
Person	findSendLeadsTo(java.lang.String... args) Person who should receive leads generated from other web sites.
DBSmsProvider	findSmsProvider(java.lang.String... args) SMS provider.
int	getActiveUsers(java.lang.String... args)
java.util.Date	getCalcFinancialYearStartDate(java.lang.String... args)
Campaign	getCurrentCampaign(java.lang.String... args)
SiteSpider	getCurrentSpider(java.lang.String... args)
TimeSheet	getCurrentTimeSheet(java.lang.String... args)
DBDashboard	getDashboard(java.lang.String... args)
Country	getDefaultCountry(java.lang.String... args)
StockBin	getDefaultStockBin(java.lang.String... args)
java.lang.String	getDefaultTaxCode(java.lang.String... args)
int	getDrvContactCategoryVersion(java.lang.String... args)
DBMonthOfYear	getFinancialYearStartMonth(java.lang.String... args)
java.lang.String	getJiraAPIToken(java.lang.String... args)
java.lang.String	getJiraDomain(java.lang.String... args)
java.lang.String	getJiraUserEmail(java.lang.String... args)
Person	getOwner(java.lang.String... args)
java.util.Date	getRetainerEndDate(java.lang.String... args)
java.util.Date	getRetainerStartDate(java.lang.String... args)
Person	getSendLeadsTo(java.lang.String... args)
DBSmsProvider	getSmsProvider(java.lang.String... args)
boolean	hasModuleAccess(java.lang.String module)
STGlobals	setCurrentSpider(com.aspc.dal.cms.spider.SiteSpider value, java.lang.String... args)
STGlobals	setDashboard(com.aspc.dal.layers.aspc_app.dashboard.DBDashboard value, java.lang.String... args)
STGlobals	setDefaultCountry(com.aspc.dal.dbobj.misc.Country value, java.lang.String... args)
STGlobals	setFinancialYearStartMonth(com.aspc.dal.calendar.dbobj.DBMonthOfYear value, java.lang.String... args)
STGlobals	setJiraAPIToken(java.lang.String value, java.lang.String... args)
STGlobals	setJiraDomain(java.lang.String value, java.lang.String... args)
STGlobals	setJiraUserEmail(java.lang.String value, java.lang.String... args)
STGlobals	setOwner(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
STGlobals	setSendLeadsTo(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
STGlobals	setSmsProvider(com.aspc.dal.dbobj.sms.DBSmsProvider value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.Globals

addSytleGWT, checkModuleAccess, create, extValidateField, findClassFromKey, findCompany, findCurrentLanguage, findCurrentLock, findCurrentLogin, findCurrentLoginBusUnit, findCurrentPerson, findDefaultCurrency, findDefaultTimeZone, findKey, findLogo, findOutgoingMailSmtpSecurity, findRealSkin, findSkin, findUserPrefGroup, getBuildTS, getCalcScreenVersion, getClassFromKey, getCleanerClass, getCode, getCompany, getControllerXML, getCurrentHourOfDay, getCurrentLanguage, getCurrentLayerId, getCurrentLayerSignature, getCurrentLayerSuspendedTime, getCurrentLock, getCurrentLogin, getCurrentLoginBusUnit, getCurrentPageValidationResults, getCurrentPerson, getCurrentPersonName, getCurrentTime, getDefaultCurrency, getDefaultLocale, getDefaultServerUrl, getDefaultTimeZone, getEcho, getEmailLimit, getEmailRecipientsLimit, getGwtControlModule, getGwtTheme, getIndexerLastRuntime, getKnownSecureServerURL, getKnownServerURL, getLicenseExpiryDt, getLicenseUserLimit, getLogo, getOutgoingMailPassword, getOutgoingMailPort, getOutgoingMailServer, getOutgoingMailSmtpSecurity, getOutgoingMailUser, getServerSecureURL, getServerURL, getSkin, getSmsOriginator, getSmsProviderAddress, getSmsProviderKey, getSmsReplayEmail, getSmsSendFromAddress, getSmsSerialNo, getStartupTime, getSysPrefs, getSystemMessage, getUserPrefGroup, hasEntitlement, hasModuleCreateAccess, hasModuleDeleteAccess, hasModuleFullAccess, hasModuleModifyAccess, hasModuleReadAccess, hideBottomDEToolbar, isBrowserMobile, isEchoMatches, isLoggedIn, isMemberOfGroup, isOutgoingMailEnableTLS, isTransparentLogin, listSupportedLangauges, makeQuery, setCleanerClass, setCode, setCompany, setDefaultCurrency, setDefaultTimeZone, setHideBottomDEToolbar, setIndexerLastRuntime, setKnownSecureServerURL, setKnownServerURL, setOutgoingMailEnableTLS, setOutgoingMailPassword, setOutgoingMailPort, setOutgoingMailServer, setOutgoingMailSmtpSecurity, setOutgoingMailUser, setSkin, setSmsOriginator, setSmsProviderAddress, setSmsProviderKey, setSmsReplayEmail, setSmsSendFromAddress, setSmsSerialNo, setSysPrefs, setUseWebSocket, useWebSocket

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

Constructor Detail

STGlobals

public STGlobals(DBClass dbClass,
                 DataSource dataSource)
          throws java.lang.Exception

Std. DBObject constructor

Parameters:

dbClass - the class

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getActiveUsers

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

getCalcFinancialYearStartDate

@CheckReturnValue
 @Nullable
public java.util.Date getCalcFinancialYearStartDate(java.lang.String... args)

getCurrentCampaign

@CheckReturnValue
 @Nullable
public Campaign getCurrentCampaign(java.lang.String... args)

findCurrentCampaign

@CheckReturnValue
 @Nonnull
public final Campaign findCurrentCampaign(java.lang.String... args)
                                                               throws NotFoundException

Current Campaign.

--> Campaign (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Campaign

Throws:

NotFoundException - Campaign was not found

getCurrentSpider

@CheckReturnValue
 @Nullable
public SiteSpider getCurrentSpider(java.lang.String... args)

findCurrentSpider

@CheckReturnValue
 @Nonnull
public final SiteSpider findCurrentSpider(java.lang.String... args)
                                                               throws NotFoundException

Helper for Site Spider screen.

--> SiteSpider (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

SiteSpider

Throws:

NotFoundException - SiteSpider was not found

setCurrentSpider

@Nonnull
public STGlobals setCurrentSpider(com.aspc.dal.cms.spider.SiteSpider value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getCurrentTimeSheet

@CheckReturnValue
 @Nullable
public TimeSheet getCurrentTimeSheet(java.lang.String... args)

findCurrentTimeSheet

@CheckReturnValue
 @Nonnull
public final TimeSheet findCurrentTimeSheet(java.lang.String... args)
                                                                 throws NotFoundException

Current Time Sheet.

--> TimeSheet (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

TimeSheet

Throws:

NotFoundException - TimeSheet was not found

getDashboard

@CheckReturnValue
 @Nullable
public DBDashboard getDashboard(java.lang.String... args)

findDashboard

@CheckReturnValue
 @Nonnull
public final DBDashboard findDashboard(java.lang.String... args)
                                                            throws NotFoundException

Dashboard object.

--> DBDashboard (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBDashboard

Throws:

NotFoundException - DBDashboard was not found

setDashboard

@Nonnull
public STGlobals setDashboard(com.aspc.dal.layers.aspc_app.dashboard.DBDashboard value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getDefaultCountry

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

findDefaultCountry

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

Sets the default country to use when creating new contacts, etc.

--> Country (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Country

Throws:

NotFoundException - Country was not found

setDefaultCountry

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

Throws:

java.lang.Exception

getDefaultStockBin

@CheckReturnValue
 @Nullable
public StockBin getDefaultStockBin(java.lang.String... args)

findDefaultStockBin

@CheckReturnValue
 @Nonnull
public final StockBin findDefaultStockBin(java.lang.String... args)
                                                               throws NotFoundException

Retrieves the default Stock Bin for this user.

--> StockBin (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

StockBin

Throws:

NotFoundException - StockBin was not found

getDefaultTaxCode

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

getDrvContactCategoryVersion

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

getFinancialYearStartMonth

@CheckReturnValue
 @Nullable
public DBMonthOfYear getFinancialYearStartMonth(java.lang.String... args)

findFinancialYearStartMonth

@CheckReturnValue
 @Nonnull
public final DBMonthOfYear findFinancialYearStartMonth(java.lang.String... args)
                                                                            throws NotFoundException

financial year start Month.

--> DBMonthOfYear (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBMonthOfYear

Throws:

NotFoundException - DBMonthOfYear was not found

setFinancialYearStartMonth

@Nonnull
public STGlobals setFinancialYearStartMonth(com.aspc.dal.calendar.dbobj.DBMonthOfYear value,
                                                     java.lang.String... args)
                                              throws java.lang.Exception

Throws:

java.lang.Exception

getJiraAPIToken

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

setJiraAPIToken

@Nonnull
public STGlobals setJiraAPIToken(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getJiraDomain

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

setJiraDomain

@Nonnull
public STGlobals setJiraDomain(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getJiraUserEmail

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

setJiraUserEmail

@Nonnull
public STGlobals setJiraUserEmail(java.lang.String value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getOwner

@CheckReturnValue
 @Nullable
public Person getOwner(java.lang.String... args)

findOwner

@CheckReturnValue
 @Nonnull
public final Person findOwner(java.lang.String... args)
                                                   throws NotFoundException

Owner.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setOwner

@Nonnull
public STGlobals setOwner(com.aspc.dal.layers.aspc_app.contact.Person value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getRetainerEndDate

@CheckReturnValue
 @Nullable
public java.util.Date getRetainerEndDate(java.lang.String... args)

getRetainerStartDate

@CheckReturnValue
 @Nullable
public java.util.Date getRetainerStartDate(java.lang.String... args)

getSendLeadsTo

@CheckReturnValue
 @Nullable
public Person getSendLeadsTo(java.lang.String... args)

findSendLeadsTo

@CheckReturnValue
 @Nonnull
public final Person findSendLeadsTo(java.lang.String... args)
                                                         throws NotFoundException

Person who should receive leads generated from other web sites.

--> Person (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setSendLeadsTo

@Nonnull
public STGlobals setSendLeadsTo(com.aspc.dal.layers.aspc_app.contact.Person value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getSmsProvider

@CheckReturnValue
 @Nullable
public DBSmsProvider getSmsProvider(java.lang.String... args)

findSmsProvider

@CheckReturnValue
 @Nonnull
public final DBSmsProvider findSmsProvider(java.lang.String... args)
                                                                throws NotFoundException

SMS provider.

--> DBSmsProvider (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBSmsProvider

Throws:

NotFoundException - DBSmsProvider was not found

setSmsProvider

@Nonnull
public STGlobals setSmsProvider(com.aspc.dal.dbobj.sms.DBSmsProvider value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

hasModuleAccess

public boolean hasModuleAccess(java.lang.String module)
                        throws java.lang.Exception

Parameters:

module -

Returns:

the value

Throws:

java.lang.Exception - a serious problem

extGetDerivedGlobalKey

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

get the derived fields

Overrides:

extGetDerivedGlobalKey in class Globals

Parameters:

field - The field

params - the field parameters

Returns:

the value

Throws:

java.lang.Exception - a serious problem

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 Globals

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

public void extCheckModifyAccess(DBField field)
                          throws DBAccessException

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Parameters:

field - The field

Throws:

DBAccessException - No access to modify