com.aspc.Layers.aspc_app.ProductLabour

Class Royalty

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.ProductLabour.Royalty

All Implemented Interfaces:

SecondaryCacheGroup

public class Royalty
extends DBObject

A Royalty is payed to a third party when you sell a product that they have full or part ownership in Generic DBObject.

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

Since:

August 6, 2004, 3:11 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 Royalty
static java.lang.String	DBCLASS_NAME Royalty

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static Royalty	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	extAutoEnterCreate() Additional functionality when an object is created.
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 a particular field.
Account	findAccount(java.lang.String... args) Account.
Contact	findContact(java.lang.String... args) Customer.
static Royalty	findKey(DataSource ds, int key) Find the target for this class by the primary key
Product	findProduct(java.lang.String... args) Product.
TaxCode	findTaxCode(java.lang.String... args) Tax Code.
Account	getAccount(java.lang.String... args)
double	getCalcAmountIncludingTax(java.lang.String... args)
double	getChargeAmount(java.lang.String... args)
double	getChargePerc(java.lang.String... args)
Contact	getContact(java.lang.String... args)
int	getID(java.lang.String... args)
Product	getProduct(java.lang.String... args)
TaxCode	getTaxCode(java.lang.String... args)
boolean	isAmountIncludesTax(java.lang.String... args)
static DBQuery<Royalty>	makeQuery(DataSource ds) Make a new QUERY for this class.
Royalty	setAccount(com.aspc.dal.layers.aspc_app.accounts.Account value, java.lang.String... args)
Royalty	setAmountIncludesTax(boolean value, java.lang.String... args)
Royalty	setChargeAmount(double value, java.lang.String... args)
Royalty	setChargePerc(double value, java.lang.String... args)
Royalty	setContact(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
Royalty	setID(int value, java.lang.String... args)
Royalty	setProduct(com.aspc.dal.layers.aspc_app.productlabour.Product value, java.lang.String... args)
Royalty	setTaxCode(com.aspc.dal.layers.aspc_app.misc.Tax 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, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, 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

Royalty

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Royalty

Constructor Detail

Royalty

public Royalty(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 Royalty setID(int value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

getAccount

@CheckReturnValue
 @Nullable
public Account getAccount(java.lang.String... args)

findAccount

@CheckReturnValue
 @Nonnull
public final Account findAccount(java.lang.String... args)
                                                      throws NotFoundException

Account.

--> Account (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Account

Throws:

NotFoundException - Account was not found

setAccount

@Nonnull
public Royalty setAccount(com.aspc.dal.layers.aspc_app.accounts.Account value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

isAmountIncludesTax

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

setAmountIncludesTax

@Nonnull
public Royalty setAmountIncludesTax(boolean value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getCalcAmountIncludingTax

@CheckReturnValue
public double getCalcAmountIncludingTax(java.lang.String... args)

getChargeAmount

@CheckReturnValue
public double getChargeAmount(java.lang.String... args)

setChargeAmount

@Nonnull
public Royalty setChargeAmount(double value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getChargePerc

@CheckReturnValue
public double getChargePerc(java.lang.String... args)

setChargePerc

@Nonnull
public Royalty setChargePerc(double 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

Customer.

--> Contact (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setContact

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

Throws:

java.lang.Exception

getProduct

@CheckReturnValue
 @Nullable
public Product getProduct(java.lang.String... args)

findProduct

@CheckReturnValue
 @Nonnull
public final Product findProduct(java.lang.String... args)
                                                      throws NotFoundException

Product.

--> Product (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Product

Throws:

NotFoundException - Product was not found

setProduct

@Nonnull
public Royalty setProduct(com.aspc.dal.layers.aspc_app.productlabour.Product value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getTaxCode

@CheckReturnValue
 @Nullable
public TaxCode getTaxCode(java.lang.String... args)

findTaxCode

@CheckReturnValue
 @Nonnull
public final TaxCode findTaxCode(java.lang.String... args)
                                                      throws NotFoundException

Tax Code.

--> Tax (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Tax Codes

Throws:

NotFoundException - Tax was not found

setTaxCode

@Nonnull
public Royalty setTaxCode(com.aspc.dal.layers.aspc_app.misc.Tax value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

create

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

extAutoEnterCreate

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

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class DBObject

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

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 calculated value

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

extValidateField

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

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem