com.aspc.Layers.aspc_app.subscription

Class SubscriptionItem

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Task.ChargeItem

com.aspc.Layers.aspc_app.Task.JobItem

com.aspc.Layers.aspc_app.Task.ChargeGroupItem

com.aspc.Layers.aspc_app.subscription.SubscriptionItem

All Implemented Interfaces:

SecondaryCacheGroup

public class SubscriptionItem
extends ChargeGroupItem

A subscription item contains a set of chargeable items to be charged for the next subscription period.

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

Since:

August 18, 2004

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 A subscription item contains a set of chargeable items to be charged for the next subscription period
static java.lang.String	DBCLASS_NAME A subscription item contains a set of chargeable items to be charged for the next subscription period

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	dependentModified(DBObject o, FldParams params)
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 void	extCheckModifyAccess(DBField field) Additional access checking for write access of this object.
protected void	extFixUp() The extended fix up routine for known problems.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected boolean	extIsMandatory(DBField field) Conditional mandatory field.
protected boolean	extIsOnChange(DBField field) OVERRIDE This method to specify that when a field is updated it will affect other fields.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
SalesCycle	findSalesCycle(java.lang.String... args) Sales cycle that this item was generated from.
TaskStatus	findStatus(java.lang.String... args) Status.
SubscriptionItemType	findSubscriptionItemType(java.lang.String... args) Identifies the type of subscription item, ie.
SubscriptionTerm	findTerm(java.lang.String... args) Term.
Invoice	generateInvoice()
int	getDeliveriesMade(java.lang.String... args)
int	getDeliveriesRemaining(java.lang.String... args)
java.util.Date	getEndDate(java.lang.String... args)
int	getMaxIssues(java.lang.String... args)
int	getNumDeliveries(java.lang.String... args)
SalesCycle	getSalesCycle(java.lang.String... args)
java.util.Date	getStartDate(java.lang.String... args)
TaskStatus	getStatus(java.lang.String... args)
SubscriptionItemType	getSubscriptionItemType(java.lang.String... args)
SubscriptionTerm	getTerm(java.lang.String... args)
int	getUsers(java.lang.String... args)
boolean	isRenewal(java.lang.String... args)
SubscriptionItem	setEndDate(java.util.Date value, java.lang.String... args)
SubscriptionItem	setSalesCycle(com.aspc.dal.layers.aspc_app.task.SalesCycle value, java.lang.String... args)
SubscriptionItem	setStartDate(java.util.Date value, java.lang.String... args)
SubscriptionItem	setStatus(com.aspc.dal.layers.aspc_app.misc.TaskStatus value, java.lang.String... args)
SubscriptionItem	setSubscriptionItemType(com.aspc.dal.layers.aspc_app.subscription.SubscriptionItemType value, java.lang.String... args)
SubscriptionItem	setTerm(com.aspc.dal.layers.aspc_app.subscription.SubscriptionTerm value, java.lang.String... args)
SubscriptionItem	setUsers(int value, java.lang.String... args)
void	updateConcreteCalcFields(FldParams params)
void	updateConcreteCalcFields(ProductItem pi, FldParams inParams) Updates concrete fields that are calculated based on other fields which could be a combination of fields from the Invoice class and dependent classes such as InvoiceItem.

Methods inherited from class com.aspc.Layers.aspc_app.Task.ChargeGroupItem

extCopy, getJobItems, isLocked

Methods inherited from class com.aspc.Layers.aspc_app.Task.JobItem

extCheckCreateAccess, extCheckModifyAccess, extCheckReadAccess, extPreValidate, findChargableTaskID, findGroupItem, getAdjTotalCostExcludingTax, getCalcTotalCostExcludingTax, getChargableTaskID, getChargeTask, getGroupItem, getTotalCostExcludingTax, getUnitCostExcludingTax, isOrderFromSupplier, setAdjTotalCostExcludingTax, setChargableTaskID, setGroupItem, setOrderFromSupplier, setUnitCostExcludingTax

Methods inherited from class com.aspc.Layers.aspc_app.Task.ChargeItem

copyIncludeField, findAccount, findAdjPriceCheckedBy, findAdjPriceReason, findCalcPriceMatrix, findChargeItemStatus, findChargeItemType, findEnteredBy, findExportFg, findKey, findOwnerBusUnit, findRecurringBase, findTaxCodeId, getAccount, getAdjPriceCheckedBy, getAdjPriceCheckedNotes, getAdjPriceReason, getAdjPriceReasonNotes, getAdjTotalPrice, getAdjTotalPriceIncludingTax, getAdjUnitPrice, getAdjUnitPriceExcludingTax, getAdjUnitPriceIncludingTax, getBackOrdered, getCalcPriceMatrix, getCalcUnitPriceExcludingTax, getChargeItemStatus, getChargeItemType, getCode, getDescription, getDiscountRate, getEnteredBy, getEnteredTime, getExportedTime, getExportFg, getID, getItemCode, getMyobImportTime, getNotes, getOrdered, getOwnerBusUnit, getQty, getRecurringBase, getRoyalties, getTaxCodeId, getTaxRate, getTotalDiscount, getTotalPriceExcludingTax, getTotalPriceIncludingTax, getTotalRoyalties, getTotalTax, getUnitMeasure, getUnitPrice, getUnitPriceDisplay, getUnitPriceDisplayExcludingTax, getUnitPriceDisplayIncludingTax, getUnitPriceExcludingTax, getUnitPriceIncludingTax, hasReadAccess, isAdjPriceChecked, isAdjPriceReasonRequired, isAdjTotalPriceIncludesTax, isAdjUnitPriceIncludesTax, isAdjustItem, isMonthlyRecurring, isNeedToBeCloned, isUnitPriceIncludesTax, makeQuery, setAccount, setAdjPriceChecked, setAdjPriceCheckedBy, setAdjPriceCheckedNotes, setAdjPriceReason, setAdjPriceReasonNotes, setAdjPriceReasonRequired, setAdjTotalPrice, setAdjTotalPriceIncludesTax, setAdjTotalPriceIncludingTax, setAdjUnitPrice, setAdjUnitPriceIncludesTax, setAdjustItem, setBackOrdered, setChargeItemStatus, setCode, setDescription, setDiscountRate, setEnteredBy, setEnteredTime, setExportedTime, setExportFg, setID, setItemCode, setMonthlyRecurring, setMyobImportTime, setNotes, setOrdered, setOwnerBusUnit, setQty, setRecurringBase, setTaxCodeId, setTaxRate, setUnitMeasure, setUnitPrice, setUnitPriceExcludingTax, setUnitPriceIncludesTax, setUnitPriceIncludingTax

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, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, extCanDeleteDependantObject, extCheckDeleteAccess, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, 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

A subscription item contains a set of chargeable items to be charged for the next subscription period

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

A subscription item contains a set of chargeable items to be charged for the next subscription period

Constructor Detail

SubscriptionItem

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

getDeliveriesMade

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

getDeliveriesRemaining

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

getEndDate

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

setEndDate

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

Throws:

java.lang.Exception

isRenewal

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

getMaxIssues

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

getNumDeliveries

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

getSalesCycle

@CheckReturnValue
 @Nullable
public SalesCycle getSalesCycle(java.lang.String... args)

findSalesCycle

@CheckReturnValue
 @Nonnull
public final SalesCycle findSalesCycle(java.lang.String... args)
                                                            throws NotFoundException

Sales cycle that this item was generated from.

--> SalesCycle (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Opportunity

Throws:

NotFoundException - SalesCycle was not found

setSalesCycle

@Nonnull
public SubscriptionItem setSalesCycle(com.aspc.dal.layers.aspc_app.task.SalesCycle value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getStartDate

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

setStartDate

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

Throws:

java.lang.Exception

getStatus

@CheckReturnValue
 @Nullable
public TaskStatus getStatus(java.lang.String... args)

findStatus

@CheckReturnValue
 @Nonnull
public final TaskStatus findStatus(java.lang.String... args)
                                                        throws NotFoundException

Status.

--> TaskStatus (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

TaskStatus

Throws:

NotFoundException - TaskStatus was not found

setStatus

@Nonnull
public SubscriptionItem setStatus(com.aspc.dal.layers.aspc_app.misc.TaskStatus value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getSubscriptionItemType

@CheckReturnValue
 @Nullable
public SubscriptionItemType getSubscriptionItemType(java.lang.String... args)

findSubscriptionItemType

@CheckReturnValue
 @Nonnull
public final SubscriptionItemType findSubscriptionItemType(java.lang.String... args)
                                                                                throws NotFoundException

Identifies the type of subscription item, ie. Trial, Renewal, etc

--> .SubscriptionItemType SubscriptionItemType (String, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

SubscriptionItemType

Throws:

NotFoundException - SubscriptionItemType was not found

setSubscriptionItemType

@Nonnull
public SubscriptionItem setSubscriptionItemType(com.aspc.dal.layers.aspc_app.subscription.SubscriptionItemType value,
                                                         java.lang.String... args)
                                                  throws java.lang.Exception

Throws:

java.lang.Exception

getTerm

@CheckReturnValue
 @Nullable
public SubscriptionTerm getTerm(java.lang.String... args)

findTerm

@CheckReturnValue
 @Nonnull
public final SubscriptionTerm findTerm(java.lang.String... args)
                                                            throws NotFoundException

Term.

--> SubscriptionTerm (String, Searchable)

Parameters:

args - the optional arguments

Returns:

SubscriptionTerm

Throws:

NotFoundException - SubscriptionTerm was not found

setTerm

@Nonnull
public SubscriptionItem setTerm(com.aspc.dal.layers.aspc_app.subscription.SubscriptionTerm value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getUsers

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

setUsers

@Nonnull
public SubscriptionItem setUsers(int value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

extAutoEnterCreate

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

Additional functionality when an object is created.

Overrides:

extAutoEnterCreate in class ChargeItem

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

generateInvoice

public Invoice generateInvoice()
                        throws java.lang.Exception

Returns:

the 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 ChargeGroupItem

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

dependentModified

public void dependentModified(DBObject o,
                              FldParams params)
                       throws java.lang.Exception

Overrides:

dependentModified in class ChargeGroupItem

Parameters:

o -

params - the field parameters

Throws:

java.lang.Exception - a serious problem

updateConcreteCalcFields

public void updateConcreteCalcFields(FldParams params)
                              throws java.lang.Exception

Parameters:

params - the field parameters

Throws:

java.lang.Exception - a serious problem

updateConcreteCalcFields

public void updateConcreteCalcFields(ProductItem pi,
                                     FldParams inParams)
                              throws java.lang.Exception

Updates concrete fields that are calculated based on other fields which could be a combination of fields from the Invoice class and dependent classes such as InvoiceItem.

Parameters:

pi -

inParams -

Throws:

java.lang.Exception - a serious problem

extIsOnChange

@CheckReturnValue
protected boolean extIsOnChange(@Nonnull
                                                  DBField field)

Description copied from class: DBObject

OVERRIDE This method to specify that when a field is updated it will affect other fields.

Overrides:

extIsOnChange in class ChargeItem

Parameters:

field - The field

Returns:

the value

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class ChargeGroupItem

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess(@Nonnull
                                                                      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

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 JobItem

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

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 ChargeGroupItem

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

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Performs additional validations on this record. Only ever called from MutableDataSource.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

extFixUp

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

The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class JobItem

Throws:

java.lang.Exception - A serious problem