com.aspc.DBObj

Class Globals

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.Globals

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

STGlobals

public class Globals
extends DBObject

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:

15 May 2001, 11:19

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 Globals is a special DBObject.
static java.lang.String	DBCLASS_NAME Globals is a special DBObject.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addSytleGWT(HTMLPage page)
protected java.lang.Boolean	checkModuleAccess(FldParams params, java.lang.String fieldName) check the module access
static Globals	create(MutableDataSource mds) Make a new instance of this class.
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 ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
DBClassAbstract	findClassFromKey(java.lang.String... args) Returns the base class for a specified key.
Company	findCompany(java.lang.String... args) Company.
DBLanguage	findCurrentLanguage(java.lang.String... args) Current Language.
DBLogicalLock	findCurrentLock(java.lang.String... args) currentLock.
Login	findCurrentLogin(java.lang.String... args) The current user's login.
Company	findCurrentLoginBusUnit(java.lang.String... args) Current Login Bus Unit.
Person	findCurrentPerson(java.lang.String... args) Current Person.
DBCurrency	findDefaultCurrency(java.lang.String... args) Default Currency.
DBTimeZone	findDefaultTimeZone(java.lang.String... args) Default Time Zone.
static Globals	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
DBFile	findLogo(java.lang.String... args) The current logo for this layer.
DBEmailAccountSecurity	findOutgoingMailSmtpSecurity(java.lang.String... args) outgoing Mail SMTP Security.
DBSkins	findRealSkin() returns System Preferences.
DBSkins	findSkin(java.lang.String... args) Skin.
DBUserPrefGroup	findUserPrefGroup(java.lang.String... args) the DBUserPrefGroup for the current login.
java.util.Date	getBuildTS(java.lang.String... args)
int	getCalcScreenVersion(java.lang.String... args)
DBClassAbstract	getClassFromKey(java.lang.String... args)
java.lang.String	getCleanerClass(java.lang.String... args)
java.lang.String	getCode(java.lang.String... args)
Company	getCompany(java.lang.String... args)
java.lang.String	getControllerXML(java.lang.String... args)
int	getCurrentHourOfDay(java.lang.String... args)
DBLanguage	getCurrentLanguage(java.lang.String... args)
int	getCurrentLayerId(java.lang.String... args)
java.lang.String	getCurrentLayerSignature(java.lang.String... args)
java.util.Date	getCurrentLayerSuspendedTime(java.lang.String... args)
DBLogicalLock	getCurrentLock(java.lang.String... args)
Login	getCurrentLogin(java.lang.String... args)
Company	getCurrentLoginBusUnit(java.lang.String... args)
java.lang.String	getCurrentPageValidationResults(java.lang.String... args)
Person	getCurrentPerson(java.lang.String... args)
java.lang.String	getCurrentPersonName(java.lang.String... args)
java.util.Date	getCurrentTime(java.lang.String... args)
DBCurrency	getDefaultCurrency(java.lang.String... args)
java.lang.String	getDefaultLocale(java.lang.String... args)
java.lang.String	getDefaultServerUrl(java.lang.String... args)
DBTimeZone	getDefaultTimeZone(java.lang.String... args)
java.lang.String	getEcho(java.lang.String... args)
int	getEmailLimit(java.lang.String... args)
int	getEmailRecipientsLimit(java.lang.String... args)
java.lang.String	getGwtControlModule(java.lang.String... args)
java.lang.String	getGwtTheme(java.lang.String... args)
java.util.Date	getIndexerLastRuntime(java.lang.String... args)
java.lang.String	getKnownSecureServerURL(java.lang.String... args)
java.lang.String	getKnownServerURL(java.lang.String... args)
java.util.Date	getLicenseExpiryDt(java.lang.String... args)
int	getLicenseUserLimit(java.lang.String... args)
DBFile	getLogo(java.lang.String... args)
java.lang.String	getOutgoingMailPassword(java.lang.String... args)
int	getOutgoingMailPort(java.lang.String... args)
java.lang.String	getOutgoingMailServer(java.lang.String... args)
DBEmailAccountSecurity	getOutgoingMailSmtpSecurity(java.lang.String... args)
java.lang.String	getOutgoingMailUser(java.lang.String... args)
java.lang.String	getServerSecureURL(java.lang.String... args)
java.lang.String	getServerURL(java.lang.String... args)
DBSkins	getSkin(java.lang.String... args)
java.lang.String	getSmsOriginator(java.lang.String... args)
java.lang.String	getSmsProviderAddress(java.lang.String... args)
java.lang.String	getSmsProviderKey(java.lang.String... args)
java.lang.String	getSmsReplayEmail(java.lang.String... args)
java.lang.String	getSmsSendFromAddress(java.lang.String... args)
java.lang.String	getSmsSerialNo(java.lang.String... args)
java.lang.String	getStartupTime(java.lang.String... args)
DBSysPrefs	getSysPrefs() returns System Preferences.
java.lang.String	getSystemMessage(java.lang.String... args)
DBUserPrefGroup	getUserPrefGroup(java.lang.String... args)
boolean	hasEntitlement(java.lang.String... args)
boolean	hasModuleCreateAccess(java.lang.String... args)
boolean	hasModuleDeleteAccess(java.lang.String... args)
boolean	hasModuleFullAccess(java.lang.String... args)
boolean	hasModuleModifyAccess(java.lang.String... args)
boolean	hasModuleReadAccess(java.lang.String... args)
boolean	hideBottomDEToolbar(java.lang.String... args)
boolean	isBrowserMobile(java.lang.String... args)
boolean	isEchoMatches(java.lang.String... args)
boolean	isLoggedIn(java.lang.String... args)
boolean	isMemberOfGroup(java.lang.String... args)
boolean	isOutgoingMailEnableTLS(java.lang.String... args)
boolean	isTransparentLogin(java.lang.String... args)
java.lang.String[]	listSupportedLangauges() which languages are supported
static DBQuery<Globals>	makeQuery(DataSource ds) Make a new QUERY for this class.
Globals	setCleanerClass(java.lang.String value, java.lang.String... args)
Globals	setCode(java.lang.String value, java.lang.String... args)
Globals	setCompany(com.aspc.dal.dbobj.contact.Business value, java.lang.String... args)
Globals	setDefaultCurrency(com.aspc.dal.dbobj.misc.DBCurrency value, java.lang.String... args)
Globals	setDefaultTimeZone(com.aspc.dal.dbobj.misc.TimeZone value, java.lang.String... args)
Globals	setHideBottomDEToolbar(boolean value, java.lang.String... args)
Globals	setIndexerLastRuntime(java.util.Date value, java.lang.String... args)
Globals	setKnownSecureServerURL(java.lang.String value, java.lang.String... args)
Globals	setKnownServerURL(java.lang.String value, java.lang.String... args)
Globals	setOutgoingMailEnableTLS(boolean value, java.lang.String... args)
Globals	setOutgoingMailPassword(java.lang.String value, java.lang.String... args)
Globals	setOutgoingMailPort(int value, java.lang.String... args)
Globals	setOutgoingMailServer(java.lang.String value, java.lang.String... args)
Globals	setOutgoingMailSmtpSecurity(com.aspc.dal.dbobj.email.DBEmailAccountSecurity value, java.lang.String... args)
Globals	setOutgoingMailUser(java.lang.String value, java.lang.String... args)
Globals	setSkin(com.aspc.dal.dbobj.settings.DBSkins value, java.lang.String... args)
Globals	setSmsOriginator(java.lang.String value, java.lang.String... args)
Globals	setSmsProviderAddress(java.lang.String value, java.lang.String... args)
Globals	setSmsProviderKey(java.lang.String value, java.lang.String... args)
Globals	setSmsReplayEmail(java.lang.String value, java.lang.String... args)
Globals	setSmsSendFromAddress(java.lang.String value, java.lang.String... args)
Globals	setSmsSerialNo(java.lang.String value, java.lang.String... args)
Globals	setSysPrefs(com.aspc.dal.dbobj.misc.DBSysPrefs value, java.lang.String... args)
Globals	setUseWebSocket(boolean value, java.lang.String... args)
boolean	useWebSocket(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, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, 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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

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.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

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.

Constructor Detail

Globals

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

getCode

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

setCode

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

Throws:

java.lang.Exception

getBuildTS

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

getCalcScreenVersion

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

getClassFromKey

@CheckReturnValue
 @Nullable
public DBClassAbstract getClassFromKey(java.lang.String... args)

findClassFromKey

@CheckReturnValue
 @Nonnull
public final DBClassAbstract findClassFromKey(java.lang.String... args)
                                                                   throws NotFoundException

Returns the base class for a specified key. Expects a parameter of GKEY=<global key>.

--> DBClassAbstract (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBClassAbstract

Throws:

NotFoundException - DBClassAbstract was not found

getCleanerClass

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

setCleanerClass

@Nonnull
public Globals setCleanerClass(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getCompany

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

findCompany

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

Company.

--> Business (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Business

Throws:

NotFoundException - Business was not found

setCompany

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

Throws:

java.lang.Exception

getControllerXML

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

getCurrentHourOfDay

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

getCurrentLanguage

@CheckReturnValue
 @Nullable
public DBLanguage getCurrentLanguage(java.lang.String... args)

findCurrentLanguage

@CheckReturnValue
 @Nonnull
public final DBLanguage findCurrentLanguage(java.lang.String... args)
                                                                 throws NotFoundException

Current Language.

--> DBLanguage (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Language

Throws:

NotFoundException - DBLanguage was not found

getCurrentLayerId

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

getCurrentLayerSignature

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

getCurrentLayerSuspendedTime

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

getCurrentLock

@CheckReturnValue
 @Nullable
public DBLogicalLock getCurrentLock(java.lang.String... args)

findCurrentLock

@CheckReturnValue
 @Nonnull
public final DBLogicalLock findCurrentLock(java.lang.String... args)
                                                                throws NotFoundException

currentLock.

--> DBLogicalLock (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBLogicalLock

Throws:

NotFoundException - DBLogicalLock was not found

getCurrentLogin

@CheckReturnValue
 @Nullable
public Login getCurrentLogin(java.lang.String... args)

findCurrentLogin

@CheckReturnValue
 @Nonnull
public final Login findCurrentLogin(java.lang.String... args)
                                                         throws NotFoundException

The current user's login. This is a runtime evaluated field and is different for everybody.

--> Login (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Login

Throws:

NotFoundException - Login was not found

getCurrentLoginBusUnit

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

findCurrentLoginBusUnit

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

Current Login Bus Unit.

--> Business (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Business

Throws:

NotFoundException - Business was not found

getCurrentPageValidationResults

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

getCurrentPerson

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

findCurrentPerson

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

Current Person.

--> Person (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

getCurrentPersonName

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

getCurrentTime

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

getDefaultCurrency

@CheckReturnValue
 @Nullable
public DBCurrency getDefaultCurrency(java.lang.String... args)

findDefaultCurrency

@CheckReturnValue
 @Nonnull
public final DBCurrency findDefaultCurrency(java.lang.String... args)
                                                                 throws NotFoundException

Default Currency.

--> DBCurrency (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBCurrency

Throws:

NotFoundException - DBCurrency was not found

setDefaultCurrency

@Nonnull
public Globals setDefaultCurrency(com.aspc.dal.dbobj.misc.DBCurrency value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getDefaultLocale

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

getDefaultServerUrl

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

getDefaultTimeZone

@CheckReturnValue
 @Nullable
public DBTimeZone getDefaultTimeZone(java.lang.String... args)

findDefaultTimeZone

@CheckReturnValue
 @Nonnull
public final DBTimeZone findDefaultTimeZone(java.lang.String... args)
                                                                 throws NotFoundException

Default Time Zone.

--> TimeZone (String, Searchable)

Parameters:

args - the optional arguments

Returns:

TimeZone

Throws:

NotFoundException - TimeZone was not found

setDefaultTimeZone

@Nonnull
public Globals setDefaultTimeZone(com.aspc.dal.dbobj.misc.TimeZone value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getEcho

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

isEchoMatches

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

getEmailLimit

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

getEmailRecipientsLimit

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

getGwtControlModule

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

getGwtTheme

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

hasEntitlement

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

hasModuleCreateAccess

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

hasModuleDeleteAccess

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

hasModuleFullAccess

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

hasModuleModifyAccess

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

hasModuleReadAccess

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

hideBottomDEToolbar

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

setHideBottomDEToolbar

@Nonnull
public Globals setHideBottomDEToolbar(boolean value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getIndexerLastRuntime

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

setIndexerLastRuntime

@Nonnull
public Globals setIndexerLastRuntime(java.util.Date value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

isBrowserMobile

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

isLoggedIn

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

isMemberOfGroup

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

isTransparentLogin

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

getKnownSecureServerURL

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

setKnownSecureServerURL

@Nonnull
public Globals setKnownSecureServerURL(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getKnownServerURL

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

setKnownServerURL

@Nonnull
public Globals setKnownServerURL(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getLicenseExpiryDt

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

getLicenseUserLimit

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

getLogo

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

findLogo

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

The current logo for this layer.

--> DBFile (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

isOutgoingMailEnableTLS

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

setOutgoingMailEnableTLS

@Nonnull
public Globals setOutgoingMailEnableTLS(boolean value,
                                                 java.lang.String... args)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

getOutgoingMailPassword

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

setOutgoingMailPassword

@Nonnull
public Globals setOutgoingMailPassword(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getOutgoingMailPort

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

setOutgoingMailPort

@Nonnull
public Globals setOutgoingMailPort(int value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getOutgoingMailServer

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

setOutgoingMailServer

@Nonnull
public Globals setOutgoingMailServer(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getOutgoingMailSmtpSecurity

@CheckReturnValue
 @Nullable
public DBEmailAccountSecurity getOutgoingMailSmtpSecurity(java.lang.String... args)

findOutgoingMailSmtpSecurity

@CheckReturnValue
 @Nonnull
public final DBEmailAccountSecurity findOutgoingMailSmtpSecurity(java.lang.String... args)
                                                                                      throws NotFoundException

outgoing Mail SMTP Security.

--> DBEmailAccountSecurity (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBEmailAccountSecurity

Throws:

NotFoundException - DBEmailAccountSecurity was not found

setOutgoingMailSmtpSecurity

@Nonnull
public Globals setOutgoingMailSmtpSecurity(com.aspc.dal.dbobj.email.DBEmailAccountSecurity value,
                                                    java.lang.String... args)
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getOutgoingMailUser

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

setOutgoingMailUser

@Nonnull
public Globals setOutgoingMailUser(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getServerSecureURL

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

getServerURL

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

getSkin

@CheckReturnValue
 @Nullable
public DBSkins getSkin(java.lang.String... args)

findSkin

@CheckReturnValue
 @Nonnull
public final DBSkins findSkin(java.lang.String... args)
                                                   throws NotFoundException

Skin.

--> DBSkins (String, Searchable)

Parameters:

args - the optional arguments

Returns:

DBSkins

Throws:

NotFoundException - DBSkins was not found

setSkin

@Nonnull
public Globals setSkin(com.aspc.dal.dbobj.settings.DBSkins value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getSmsOriginator

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

setSmsOriginator

@Nonnull
public Globals setSmsOriginator(java.lang.String value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getSmsProviderAddress

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

setSmsProviderAddress

@Nonnull
public Globals setSmsProviderAddress(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getSmsProviderKey

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

setSmsProviderKey

@Nonnull
public Globals setSmsProviderKey(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getSmsReplayEmail

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

setSmsReplayEmail

@Nonnull
public Globals setSmsReplayEmail(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getSmsSendFromAddress

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

setSmsSendFromAddress

@Nonnull
public Globals setSmsSendFromAddress(java.lang.String value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getSmsSerialNo

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

setSmsSerialNo

@Nonnull
public Globals setSmsSerialNo(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getStartupTime

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

setSysPrefs

@Nonnull
public Globals setSysPrefs(com.aspc.dal.dbobj.misc.DBSysPrefs value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getSystemMessage

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

useWebSocket

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

setUseWebSocket

@Nonnull
public Globals setUseWebSocket(boolean value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getUserPrefGroup

@CheckReturnValue
 @Nullable
public DBUserPrefGroup getUserPrefGroup(java.lang.String... args)

findUserPrefGroup

@CheckReturnValue
 @Nonnull
public final DBUserPrefGroup findUserPrefGroup(java.lang.String... args)
                                                                    throws NotFoundException

the DBUserPrefGroup for the current login.

--> DBUserPrefGroup (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

DBUserPrefGroup

Throws:

NotFoundException - DBUserPrefGroup was not found

create

@Nonnull
 @CheckReturnValue
public static Globals 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<Globals> 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 Globals 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

getSysPrefs

@Nullable
public DBSysPrefs getSysPrefs()
                                 throws java.lang.Exception

returns System Preferences.

Returns:

the system prefs

Throws:

java.lang.Exception - a serious problem

findRealSkin

@CheckReturnValue
 @Nonnull
public DBSkins findRealSkin()

returns System Preferences.

Returns:

the skin

addSytleGWT

public void addSytleGWT(HTMLPage page)

Parameters:

page - the page

listSupportedLangauges

@CheckReturnValue
 @Nonnull
public java.lang.String[] listSupportedLangauges()

which languages are supported

Returns:

the list

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 DBObject

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

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Description copied from class: DBObject

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

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 DBObject

Parameters:

field - The field to get

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

Returns:

the value

Throws:

java.lang.Exception - A serious problem

checkModuleAccess

@CheckReturnValue
 @Nullable
protected java.lang.Boolean checkModuleAccess(FldParams params,
                                                                           java.lang.String fieldName)
                                                                    throws java.lang.Exception

check the module access

Parameters:

params - the params to use

fieldName - the field name

Returns:

the access

Throws:

java.lang.Exception - a serious problem