com.aspc.Layers.aspc_app.xero.DBObj

Class XeroApp

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.xero.DBObj.XeroApp

All Implemented Interfaces:

SecondaryCacheGroup

public class XeroApp
extends DBObject

Store the settings for an Xero OAuth 2.0 App
The client id and client secret are stored in json file in conf directory

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

Author:

CORP\lei

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 Store the settings for an Xero OAuth 2.0 App The client id and client secret are stored in json file in conf directory
static java.lang.String	DBCLASS_NAME Store the settings for an Xero OAuth 2.0 App The client id and client secret are stored in json file in conf directory

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
XeroApp(DBClass theClass, DataSource dataSource)

Method Summary

Modifier and Type	Method and Description
static XeroApp	create(MutableDataSource mds) Make a new instance of this class.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
static XeroApp	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
Company	findOwnerBusiness(java.lang.String... args) Owner business contact unit of this Xero app.
java.lang.String	getAccessToken(java.lang.String... args)
java.lang.String	getAuthorizationLink(java.lang.String... args)
java.lang.String	getClientId(java.lang.String... args)
java.lang.String	getClientSecret(java.lang.String... args)
java.lang.String	getCode(java.lang.String... args)
java.lang.String	getCurrency(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
Company	getOwnerBusiness(java.lang.String... args)
java.lang.String	getRawAccessToken(java.lang.String... args)
java.lang.String	getRawClientId()
java.lang.String	getRawClientSecret()
java.lang.String	getRawCurrency()
java.lang.String	getRedirectURI(java.lang.String... args)
java.lang.String	getRefreshToken(java.lang.String... args)
java.util.ArrayList<java.lang.String>	getScopeList() get the scope list for this app configuration
java.lang.String	getSecretState(java.lang.String... args)
java.lang.String	getTenantId(java.lang.String... args)
static DBQuery<XeroApp>	makeQuery(DataSource ds) Make a new QUERY for this class.
XeroApp	setCode(java.lang.String value, java.lang.String... args)
XeroApp	setName(java.lang.String value, java.lang.String... args)
XeroApp	setOwnerBusiness(com.aspc.dal.layers.aspc_app.contact.Business value, java.lang.String... args)
XeroApp	setRawAccessToken(java.lang.String value, java.lang.String... args)
XeroApp	setRefreshToken(java.lang.String value, java.lang.String... args)
XeroApp	setSecretState(java.lang.String value, java.lang.String... args)
XeroApp	setTenantId(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, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, 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

Store the settings for an Xero OAuth 2.0 App
The client id and client secret are stored in json file in conf directory

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Store the settings for an Xero OAuth 2.0 App
The client id and client secret are stored in json file in conf directory

Constructor Detail

XeroApp

public XeroApp(DBClass theClass,
               DataSource dataSource)
        throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

getCode

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

setCode

@Nonnull
public XeroApp setCode(java.lang.String 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 XeroApp setName(java.lang.String value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getAccessToken

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

getAuthorizationLink

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

getClientId

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

getClientSecret

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

getCurrency

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

getOwnerBusiness

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

findOwnerBusiness

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

Owner business contact unit of this Xero app.

--> Business (Integer, Mandatory, Unique, Searchable)

Parameters:

args - the optional arguments

Returns:

Business Unit

Throws:

NotFoundException - Business was not found

setOwnerBusiness

@Nonnull
public XeroApp setOwnerBusiness(com.aspc.dal.layers.aspc_app.contact.Business value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getRawAccessToken

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

setRawAccessToken

@Nonnull
public XeroApp setRawAccessToken(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getRedirectURI

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

getRefreshToken

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

setRefreshToken

@Nonnull
public XeroApp setRefreshToken(java.lang.String value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getSecretState

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

setSecretState

@Nonnull
public XeroApp setSecretState(java.lang.String value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getTenantId

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

setTenantId

@Nonnull
public XeroApp setTenantId(java.lang.String value,
                                    java.lang.String... args)
                             throws java.lang.Exception

Throws:

java.lang.Exception

create

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

extPreSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPreSaveRecord()
                                                           throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - A Serious problem

getRawClientId

@Nonnull
public java.lang.String getRawClientId()
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getRawClientSecret

@Nonnull
public java.lang.String getRawClientSecret()
                                             throws java.lang.Exception

Throws:

java.lang.Exception

getRawCurrency

@Nonnull
public java.lang.String getRawCurrency()
                                         throws java.lang.Exception

Throws:

java.lang.Exception

extGetDerivedValue

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

Description copied from class: DBObject

OVERRIDE This method for all objects with derived fields that are NOT linked. A linked derived field should extend the extGetDerivedGlobalKey.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

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

Returns:

The value of the field.

Throws:

java.lang.Exception - a serious problem

getScopeList

@Nonnull
public java.util.ArrayList<java.lang.String> getScopeList()
                                                            throws java.lang.Exception

get the scope list for this app configuration

Returns:

Throws:

java.lang.Exception