com.aspc.Layers.aspc_app.subscription

Class Subscription

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.Task.Task

com.aspc.Layers.aspc_app.Task.ChargeableTask

com.aspc.Layers.aspc_app.Task.Sale

com.aspc.Layers.aspc_app.subscription.Subscription

All Implemented Interfaces:

SecondaryCacheGroup

public class Subscription
extends Sale

A Subscription is a sale which is valid for a specific period of time.

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

Since:

July 30, 2003, 9:41 AM

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 is a sale which is valid for a specific period of time.
static java.lang.String	DBCLASS_NAME A Subscription is a sale which is valid for a specific period of time.

Fields inherited from class com.aspc.Layers.aspc_app.Task.Task

skipAlert, STATUS_ACCEPTED, STATUS_COMPLETED, STATUS_DOLATER, STATUS_ENTERED, STATUS_REJECTED, STATUS_STARTED

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	adjSubscriptionDates(Invoice afterInvoice)
void	adjust()
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) Additional business logic when a field is updated.
protected void	extAutoEnterCreate() Additional functionality when an object is created.
protected void	extFixUp() The extended fix up routine for known problems.
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 boolean	extIsMandatory(DBField field) Conditional mandatory field.
protected void	extPreValidate() ' OVERRIDE To add functionality to before validation is called.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
void	fill(ChargeableTask ct) Fills in the subscription by copying in the details from either a sales opportunity or quote The super.fill method would have copied the chargeable items although in the case of subscriptions we do not keep a list of these charges.
SubContinuationMethod	findContinuationMethod(java.lang.String... args) Process that should be used to handle expiry of current subscription.
Invoice	findInitialItem(java.lang.String... args) Initial Item.
ProductPartOrder	findLastDelivery(java.lang.String... args) the last delivery.
protected DBObject	findLastInvoice()
Invoice	findLastItem(java.lang.String... args) Last Item.
InvoiceRefundMethod	findRefundMethod(java.lang.String... args) Method of refund in Subscription.
InvoiceRefundReason	findRefundReason(java.lang.String... args) Reason for refund in Subscription.
java.util.ArrayList	generateCreditInvoices(MutableDataSource mds, java.lang.String refund_method)
Invoice	generateRenewal(MutableDataSource mds)
Invoice	generateRenewal(MutableDataSource mds, FldParams params)
java.util.Date	getAdjSubscriptionStart(java.lang.String... args)
java.util.Date	getCalcSubscriptionEndDate(java.lang.String... args)
SubContinuationMethod	getContinuationMethod(java.lang.String... args)
int	getDeliveriesMade(java.lang.String... args)
int	getDeliveriesRemaining(java.lang.String... args)
java.lang.String	getDisplayProductList(java.lang.String... args)
Invoice	getInitialItem(java.lang.String... args)
java.util.Date	getLastDelivered(java.lang.String... args)
ProductPartOrder	getLastDelivery(java.lang.String... args)
Invoice	getLastItem(java.lang.String... args)
InvoiceRefundMethod	getRefundMethod(java.lang.String... args)
java.lang.String	getRefundNotes(java.lang.String... args)
InvoiceRefundReason	getRefundReason(java.lang.String... args)
java.util.Date	getSubscriptionEndDate(java.lang.String... args)
int	getSubscriptionNumber(java.lang.String... args)
java.util.Date	getSubscriptionStart(java.lang.String... args)
int	getUsers(java.lang.String... args)
boolean	isAllowRenewalNotices(java.lang.String... args)
boolean	isDueForRenewal(java.lang.String... args)
protected void	processProductItems(DBObject[] allInvoiceItems) extra logic to handle invoice items when we create the renewal
Subscription	setAdjSubscriptionStart(java.util.Date value, java.lang.String... args)
Subscription	setContinuationMethod(com.aspc.dal.layers.aspc_app.subscription.SubContinuationMethod value, java.lang.String... args)
Subscription	setRefundMethod(com.aspc.dal.layers.aspc_app.invoice.InvoiceRefundMethod value, java.lang.String... args)
Subscription	setRefundNotes(java.lang.String value, java.lang.String... args)
Subscription	setRefundReason(com.aspc.dal.layers.aspc_app.invoice.InvoiceRefundReason value, java.lang.String... args)
Subscription	setSubscriptionEndDate(java.util.Date value, java.lang.String... args)
Subscription	setSubscriptionNumber(int value, java.lang.String... args)
Subscription	setUsers(int value, java.lang.String... args)
DBObject	updateLastDelivery() Updates the current Invoice field
void	updateStatus() Update status to reflect subscription status of associated Invoices
protected void	updateSubscriptionEndDate()
protected void	updateSubscriptionNumber()

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

createInvoice, extCreateInvoice, extPreSaveRecord, findContract, findInquirySource, findPaymentAccount, findPurchaseStatus, findQuoteId, findRetainerEmailTemplate, findSalesCycle, findSalesPerson, getBalance, getBalanceExcludingTax, getBalancePayable, getCalcLabourLimit, getCapEndDate, getCapExceed, getCapRemain, getCapStartDate, getClientOrderNo, getContract, getCostOfSale, getDaysLeftCurrentTerm, getEstCredit, getEstLabourDaysCredit, getInquirySource, getInvoiceNumbers, getLabourHoursRemainThisCap, getLabourHoursRemainThisMonth, getLabourHoursUsedThisPeriod, getLabourInDays, getLabourInHours, getLabourInHoursAdjusted, getLabourLimit, getMinimumTermDate, getNotCompleted, getOverdueAmount, getPaid, getPaymentAccount, getPoDate, getPoExtensionDate, getPrePaidDaysLeft, getPrePaidEnd, getPrePaidHoursLeft, getPrePaidStart, getPurchaseStatus, getQuoteId, getReadyToInvoice, getRetainerCapEnds, getRetainerCapStarts, getRetainerEmailTemplate, getRetainerJobType, getRetainerRecipients, getSalesCycle, getSalesPerson, getSumTotals, getToPay, getToPayExcludeOverdue, getTotalLabourHoursRemain, getTotalProductLabourHours, isBalancePayableWarning, isCapStartToday, isInvoiced, isLabourHoursLow, isLabourHoursOver, isNotCompletedWarning, isReadyToInvoiceWarning, isSendRetainerEmail, setClientOrderNo, setContract, setInquirySource, setLabourLimit, setMinimumTermDate, setPaymentAccount, setPoDate, setPoExtensionDate, setPrePaidEnd, setPrePaidStart, setPurchaseStatus, setQuoteId, setRetainerEmailTemplate, setRetainerJobType, setSalesCycle, setSalesPerson, setSendRetainerEmail

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

copyChildren, extCopy, extIsOnChange, extPostSaveRecord, findAccountManager, findBillTo, findCalcSaleType, findCampaign, findChargeTaxCode, findContact, findCopyFromTemplate, findDefaultLabourRate, findLastCompleteActivity, findLastModifiedActivity, findNextScheduledActivity, findPaymentTerms, findRecipient, findSite, findSiteRegion, findState, findSuburb, getAccountManager, getActivities, getAdjTotalPrice, getBillTo, getCalcAttn, getCalcBillTo, getCalcSaleType, getCampaign, getChargeTaxCode, getChargeTaxRate, getContact, getContactDisplaySiteAddress, getCopyFromTemplate, getCreditSurchargePerc, getCustomerInvoice, getCustomerInvoiceDate, getCustomerPO, getDefaultLabourRate, getDefaultSiteContact, getDeliveryFee, getDiscountRate, getDisplayContact, getDisplaySiteAddress, getDisplaySiteCountry, getDisplaySitePhone, getDisplaySitePostCode, getDisplaySiteState, getDisplaySiteSuburbCity, getJobItems, getLastActionTime, getLastCompleteActivity, getLastModifiedActivity, getLastNoticeNumber, getNextScheduledActivity, getOrderConfirmationNum, getPaymentTerms, getProfit, getProfitPerc, getRecipient, getRecipientName, getReminderComment, getSite, getSiteAddress, getSiteContactMobile, getSiteContactPerson, getSiteContactPhone, getSiteCoordinate, getSiteCountry, getSiteFax, getSiteName, getSiteNotes, getSitePhone, getSitePostcode, getSiteRegion, getSiteState, getSiteSuburbCity, getState, getStatusJournal, getSuburb, getTotalDiscount, getTotalRoyalties, setAccountManager, setAdjTotalPrice, setBillTo, setCampaign, setChargeTaxCode, setChargeTaxRate, setContact, setCopyFromTemplate, setCreditSurchargePerc, setCustomerInvoice, setCustomerInvoiceDate, setCustomerPO, setDefaultLabourRate, setDeliveryFee, setDiscountRate, setOrderConfirmationNum, setPaymentTerms, setRecipient, setReminderComment, setSite, setSiteAddress, setSiteContactMobile, setSiteContactPerson, setSiteContactPhone, setSiteCoordinate, setSiteCountry, setSiteFax, setSiteName, setSiteNotes, setSitePhone, setSitePostcode, setSiteRegion, setSiteState, setSiteSuburbCity, setState, setSuburb, updateProspectCategory

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

cleanupCurrentNote, copyIncludeField, createFromType, extPreValidateDelete, extSetValue, findAssignTo, findAssignToGroup, findAttachedEmail, findCalcCustomer, findCategory, findCurrentNote, findCurrentNoteRaw, findDependsOn, findEnteredBy, findInitialAssignTo, findInitialNotNullAssignTo, findKey, findLastModifiedBy, findOwner, findOwnerBusUnit, findPredecessorsStatus, findPriority, findRepeatBase, findRepeatNext, findRepeatPrevious, findRequestedBy, findResult, findSchedAmPm, findSeriesPrevious, findSimpleStatus, findStatus, findStatusLastChangedBy, findTemplateType, findType, getActionByDate, getActualDuration, getActualEnd, getActualEndMonth, getActualStart, getAdditionalCharge, getAdditionalCosts, getAdditionalDetails, getAdjActualDuration, getAdjustedCost, getAssignTo, getAssignToDate, getAssignToGroup, getAttachedEmail, getCalcActualDuration, getCalcCustomer, getCalcTotalDuration, getCategory, getCurrentNote, getCurrentNoteRaw, getDependsOn, getDescription, getDisplayBusyTime, getDisplayId, getDisplaySchedTime, getDisplayShortDesc, getDisplayStatus, getDueBy, getDuration, getEndDate, getEnteredBy, getEnterTime, getEnterTimeMonthYear, getEstVSActualHours, getExpectedFinishMonthYear, getFullTextSearchScore, getHtmlDescription, getICalEnd, getICalFullAddress, getICalOrganizer, getICalStart, getID, getInitialAssignTo, getInitialAssignToDate, getInitialNotNullAssignTo, getInitialNotNullAssignToDate, getIssueDate, getLastModifiedBy, getLastModifiedTime, getLinkedJobs, getNextAlert, getNextOverdueAlert, getObseleteNotes, getOwner, getOwnerBusUnit, getPercUntilClosed, getPreAlertDuration, getPredecessorsStatus, getPrimaryType, getPriority, getProperties, getRawSearchText, getReferenceNumber, getReferencesUUID, getRepeatBase, getRepeatedTimezone, getRepeatNext, getRepeatPrevious, getRequestedBy, getResult, getSchedAmPm, getSequence, getSeriesPrevious, getShortDesc, getSimpleStatus, getStartDate, getStatus, getStatusLastChanged, getStatusLastChangedBy, getStatusLastChangedTurnaround, getTags, getTagsLabel, getTagsRaw, getTaskCoverphoto, getTaskfeedBackBad, getTaskfeedBackGood, getTaskfeedbacknotes, getTaskRating, getTaskSeries, getTemplateType, getTimemapDurationField, getTimemapEndTime, getTimemapEndTimeField, getTimemapStartTime, getTimemapStartTimeField, getTmpAttachmentKey, getTotalCost, getTotalLabourCosts, getTotalLabourPrice, getTotalLabourPriceExcTax, getTotalPriceExcTax, getTotalPriceIncTax, getTotalProductCosts, getTotalProductPrice, getTotalProductPriceExcTax, getTotalProfit, getTotalProfitPerc, getTotalRelatedCosts, getTotalTax, getType, getUntouchedTaskSeries, getUUID, getValueForPublic, getWeakReferencesUUID, handleEvent, hasReadAccess, isAllPredecessorsClosed, isApplicableTo, isCategoryRequired, isChangedByUser, isCheckPredecessorsClosed, isChildNode, isClosed, isContains, isCurrent, isDescendantNode, isDirectory, isDueByExpiresIn, isLockedAssignTo, isLockedStartDate, isMatchesSkillLevel, isMyGroup, isNextAlertDueIn, isNoteRequired, isPublic, isReferenceable, isRepeated, isSameNode, isSendAlert, isTimemapHasEndTime, isVersionable, lastModified, listNodes, makeQuery, makeSearchPlan, processRawTags, setActualEnd, setActualStart, setAdditionalCharge, setAdditionalCosts, setAdditionalDetails, setAdjActualDuration, setAdjustedCost, setAllPredecessorsClosed, setAssignTo, setAssignToDate, setAssignToGroup, setAttachedEmail, setCategory, setCategoryRequired, setChangedByUser, setCurrentNoteRaw, setDependsOn, setDescription, setDueBy, setDuration, setEndDate, setEnteredBy, setEnterTime, setID, setInitialAssignTo, setInitialAssignToDate, setIssueDate, setLastModifiedBy, setLastModifiedTime, setLockedAssignTo, setLockedStartDate, setNextAlert, setNextOverdueAlert, setObseleteNotes, setOwner, setOwnerBusUnit, setPercUntilClosed, setPreAlertDuration, setPredecessorsStatus, setPrimaryType, setPriority, setProperties, setRawSearchText, setReferenceable, setReferenceNumber, setReferencesUUID, setRepeatBase, setRepeated, setRepeatedTimezone, setRepeatNext, setRepeatPrevious, setRequestedBy, setResult, setSchedAmPm, setSendAlert, setSequence, setSeriesPrevious, setShortDesc, setSimpleStatus, setStartDate, setStatus, setStatusLastChanged, setStatusLastChangedBy, setTags, setTagsRaw, setTaskCoverphoto, setTaskfeedBackBad, setTaskfeedBackGood, setTaskfeedbacknotes, setTaskRating, setTemplateType, setTmpAttachmentKey, setType, setUUID, setVersionable, setWeakReferencesUUID, toString, updateStatus, vDisplayName, vName

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, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extDelete, extDeleteRecord, extGetValue, extMarkSavePoint, extPostDeleteRecord, extPreDeleteRecord, extRaiseEvents, extRollbackTo, extSaveRecord, 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, 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, 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 is a sale which is valid for a specific period of time.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

A Subscription is a sale which is valid for a specific period of time.

Constructor Detail

Subscription

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

getAdjSubscriptionStart

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

setAdjSubscriptionStart

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

Throws:

java.lang.Exception

isAllowRenewalNotices

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

getCalcSubscriptionEndDate

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

getContinuationMethod

@CheckReturnValue
 @Nullable
public SubContinuationMethod getContinuationMethod(java.lang.String... args)

findContinuationMethod

@CheckReturnValue
 @Nonnull
public final SubContinuationMethod findContinuationMethod(java.lang.String... args)
                                                                               throws NotFoundException

Process that should be used to handle expiry of current subscription.

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

Parameters:

args - the optional arguments

Returns:

SubContinuationMethod

Throws:

NotFoundException - SubContinuationMethod was not found

setContinuationMethod

@Nonnull
public Subscription setContinuationMethod(com.aspc.dal.layers.aspc_app.subscription.SubContinuationMethod value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getDeliveriesMade

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

getDeliveriesRemaining

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

getDisplayProductList

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

getInitialItem

@CheckReturnValue
 @Nullable
public Invoice getInitialItem(java.lang.String... args)

findInitialItem

@CheckReturnValue
 @Nonnull
public final Invoice findInitialItem(java.lang.String... args)
                                                          throws NotFoundException

Initial Item.

--> Invoice (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Invoice

Throws:

NotFoundException - Invoice was not found

isDueForRenewal

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

getLastDelivered

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

getLastDelivery

@CheckReturnValue
 @Nullable
public ProductPartOrder getLastDelivery(java.lang.String... args)

findLastDelivery

@CheckReturnValue
 @Nonnull
public final ProductPartOrder findLastDelivery(java.lang.String... args)
                                                                    throws NotFoundException

the last delivery.

--> ProductPartOrder (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

ProductPartOrder

Throws:

NotFoundException - ProductPartOrder was not found

getLastItem

@CheckReturnValue
 @Nullable
public Invoice getLastItem(java.lang.String... args)

findLastItem

@CheckReturnValue
 @Nonnull
public final Invoice findLastItem(java.lang.String... args)
                                                       throws NotFoundException

Last Item.

--> Invoice (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Invoice

Throws:

NotFoundException - Invoice was not found

getRefundMethod

@CheckReturnValue
 @Nullable
public InvoiceRefundMethod getRefundMethod(java.lang.String... args)

findRefundMethod

@CheckReturnValue
 @Nonnull
public final InvoiceRefundMethod findRefundMethod(java.lang.String... args)
                                                                       throws NotFoundException

Method of refund in Subscription.

--> InvoiceRefundMethod (String, Searchable)

Parameters:

args - the optional arguments

Returns:

InvoiceRefundMethod

Throws:

NotFoundException - InvoiceRefundMethod was not found

setRefundMethod

@Nonnull
public Subscription setRefundMethod(com.aspc.dal.layers.aspc_app.invoice.InvoiceRefundMethod value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getRefundNotes

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

setRefundNotes

@Nonnull
public Subscription setRefundNotes(java.lang.String value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getRefundReason

@CheckReturnValue
 @Nullable
public InvoiceRefundReason getRefundReason(java.lang.String... args)

findRefundReason

@CheckReturnValue
 @Nonnull
public final InvoiceRefundReason findRefundReason(java.lang.String... args)
                                                                       throws NotFoundException

Reason for refund in Subscription.

--> InvoiceRefundReason (String, Searchable)

Parameters:

args - the optional arguments

Returns:

InvoiceRefundReason

Throws:

NotFoundException - InvoiceRefundReason was not found

setRefundReason

@Nonnull
public Subscription setRefundReason(com.aspc.dal.layers.aspc_app.invoice.InvoiceRefundReason value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getSubscriptionEndDate

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

setSubscriptionEndDate

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

Throws:

java.lang.Exception

getSubscriptionNumber

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

setSubscriptionNumber

@Nonnull
public Subscription setSubscriptionNumber(int value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getSubscriptionStart

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

getUsers

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

setUsers

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

Throws:

java.lang.Exception

fill

public void fill(ChargeableTask ct)
          throws java.lang.Exception

Fills in the subscription by copying in the details from either a sales opportunity or quote The super.fill method would have copied the chargeable items although in the case of subscriptions we do not keep a list of these charges. Instead we use them to generate an invoice and then discard the originals. Depending on the system, a subscription item may have been provided which contains information about the term of the subscription etc. We use the subscription item to generate the invoice. If a subscription item was not provided then we generate one which then allows us to create the invoice

Overrides:

fill in class Sale

Parameters:

ct -

Throws:

java.lang.Exception - a serious problem

generateRenewal

public Invoice generateRenewal(MutableDataSource mds)
                        throws java.lang.Exception

Parameters:

mds - the mutable data source

Returns:

the value

Throws:

java.lang.Exception - a serious problem

generateRenewal

public Invoice generateRenewal(MutableDataSource mds,
                               @Nullable
                               FldParams params)
                        throws java.lang.Exception

Parameters:

mds - the mutable data source

params - params

Returns:

the value

Throws:

java.lang.Exception - a serious problem

processProductItems

protected void processProductItems(DBObject[] allInvoiceItems)
                            throws java.lang.Exception

extra logic to handle invoice items when we create the renewal

Parameters:

allInvoiceItems -

Throws:

java.lang.Exception

generateCreditInvoices

public java.util.ArrayList generateCreditInvoices(MutableDataSource mds,
                                                  java.lang.String refund_method)
                                           throws java.lang.Exception

Parameters:

mds - the mutable data source

refund_method -

Returns:

the value

Throws:

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 ChargeableTask

Throws:

java.lang.Exception - A serious problem

See Also:

com.aspc.DBObj.DBObject#autoEnterCreate()

extIsMandatory

@CheckReturnValue
protected boolean extIsMandatory(@Nonnull
                                                   DBField field)

Conditional mandatory field.

Overrides:

extIsMandatory in class ChargeableTask

Parameters:

field - The field to get

Returns:

TRUE if this field is now mandatory

See Also:

DBObject.extIsMandatory( DBField)

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

Additional business logic when a field is updated.

Overrides:

eventFieldUpdated in class Sale

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

See Also:

DBObject.eventFieldUpdated( DBField, Object, GlobalKey, FldParams)

updateStatus

public void updateStatus()
                  throws java.lang.Exception

Update status to reflect subscription status of associated Invoices

Throws:

java.lang.Exception - an error updating deliveries

extPreValidate

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

' OVERRIDE To add functionality to before validation is called.

THIS IS YOUR LAST CHANCE TO MAKE CHANGES BEFORE VALIDATIONS.

Overrides:

extPreValidate in class ChargeableTask

Throws:

java.lang.Exception - a serious problem

adjust

public void adjust()
            throws java.lang.Exception

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 Task

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

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. OVERRIDE this method to add additional validations to a record.
The MutableDataSource is in READONLY mode at this stage.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

updateSubscriptionEndDate

protected void updateSubscriptionEndDate()
                                  throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

adjSubscriptionDates

public void adjSubscriptionDates(Invoice afterInvoice)
                          throws java.lang.Exception

Parameters:

afterInvoice -

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 Sale

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

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 Sale

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

findLastInvoice

protected DBObject findLastInvoice()
                            throws java.lang.Exception

Returns:

the value

Throws:

java.lang.Exception - a serious problem

updateSubscriptionNumber

protected void updateSubscriptionNumber()
                                 throws java.lang.Exception

Throws:

java.lang.Exception - a serious problem

updateLastDelivery

public DBObject updateLastDelivery()
                            throws java.lang.Exception

Updates the current Invoice field

Returns:

last delivery

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 ChargeableTask

Throws:

java.lang.Exception - A serious problem