com.crm.process.jobs

Class CRMProcessJobBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.process.CRMProcess

com.crm.process.jobs.CRMProcessJobBean

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

CRMProcessJobGenericPurposeBean, CRMProcessJobReplacePhysicalGoodsBean, CRMProcessJobSubscriptionRelatedBean

public class CRMProcessJobBean
extends CRMProcess

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALIAS_MANDATORY_PRODUCT

Constructor Summary

Constructors

Constructor and Description
CRMProcessJobBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
com.crm.dataobject.jobs.CRMDOJob	amendBillingTerms(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan, com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme, java.util.Date agreementDate, java.lang.Integer removeConcurrentUsage, java.math.BigDecimal concurrentUsage, java.math.BigDecimal ratePercentage) Amends the billing terms of a job.
void	anonymizeContactJobs(com.crm.dataobject.contactinfo.CRMDOContactInformation contact) Anonymizes the given contact information jobs
com.crm.dataobject.billing.CRMDOBill	bill(com.crm.dataobject.jobs.CRMDOJob job, java.util.Date asOfDate) Bills a job as of a date.
com.crm.dataobject.billing.CRMDOBill	bill(com.crm.dataobject.jobs.CRMDOJob job, java.util.Date asOfDate, java.lang.Boolean billPreview) Bills a job as of a date by a normal billing run definition, a billing term definition and price plans.
BillPreviewRates	billPreviewRates(com.crm.dataobject.jobs.CRMDOJob job)
BillPreviewRates	billPreviewRates(com.crm.dataobject.jobs.CRMDOJob job, java.lang.Boolean isBillForQuotation)
com.crm.dataobject.jobs.CRMDOJob	calculateAmountAlreadyPaid(com.crm.dataobject.jobs.CRMDOJob job) Calculates the amount that was already paid for the given job by retrieving the total paid amount of all the posted payments that are referring to that job
com.crm.dataobject.jobs.CRMDOJob	calculateAvailableWalletBalanceToBeUsed(com.crm.dataobject.jobs.CRMDOJob job) Calculates the wallet balance that is available to be used for a specific job.
com.crm.dataobject.jobs.CRMDOJob	cancel(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.jobs.CRMDOJobStatus status, com.crm.dataobject.jobs.CRMDOJobCancelReason cancelReason) Cancels a job Validates that the job can be cancelled Removes the physical goods and activities of the job Sets the job life cycle state to CANCELLED job, sets the job status, the reason for the job cancellation
com.crm.dataobject.jobs.CRMDOJob	complete(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.jobs.CRMDOJobStatus status, java.util.Date performedDate, com.crm.dataobject.users.CRMDOUser performedByUser) Completes a job Validates that the job can be cancelled Sets the completed job status, the date that the completion was performed and the user that performed the completion Completes the service request of the job, if a service request exists and it should be completed Bills the job
com.crm.dataobject.jobs.CRMDOJob	consctructJobQuotation(com.crm.dataobject.jobs.CRMDOJob job) Constructs job quotation of a given job.
com.crm.dataobject.jobs.CRMDOJob	create(com.crm.dataobject.jobs.CRMDOJob job) Creates a job Sets the job location Saves the related account Saves the job Creates and sends communications based on the event-based communication definition
java.util.ArrayList<com.crm.dataobject.jobs.CRMDOJobProduct>	evaluateEventBasedConditionalExpensesFromSubscriptionAction(com.crm.dataobject.jobs.CRMDOJob job)
java.util.ArrayList<com.crm.dataobject.jobs.CRMDOJobProduct>	evaluateEventBasedConditionalExpensesFromSubscriptionAction(com.crm.dataobject.jobs.CRMDOJob job, java.util.Set<com.crm.dataobject.jobs.CRMDOJobProduct> jobProducts)
com.crm.dataobject.jobs.CRMDOJob	invoice(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.billing.CRMDOBill bill, java.util.Set<com.crm.dataobject.billing.CRMDORatedBillingItem> ratedBillingItems, com.crm.dataobject.products.CRMDOProduct milestoneProduct, java.util.Set<com.crm.dataobject.jobs.CRMDOJobProduct> physicalGoods, java.util.Set<com.crm.dataobject.jobs.CRMDOJobProduct> expenses, java.util.Set<com.crm.dataobject.activities.CRMDOActivity> activities, java.math.BigDecimal amountToInvoice, java.math.BigDecimal totalBilledAmount)
java.lang.Boolean	isVerifiedJobAddress(com.crm.dataobject.contactinfo.CRMDOContactInfoAddress jobAddress, com.crm.dataobject.jobs.CRMDOJobType type) Verifies a job's address against the generic geographical areas coverage rules
java.lang.Boolean	isVerifiedJobAddress(com.crm.dataobject.jobs.CRMDOJob job) Verifies a job's address against the generic geographical areas coverage rules
com.crm.dataobject.billing.CRMDOBill	previewBill(com.crm.dataobject.jobs.CRMDOJob job, java.util.Date asOfDate) Previews a bill of a job as of a date.
com.crm.dataobject.jobs.CRMDOJob	recalculatedKeyDatesOnStartingProgress(com.crm.dataobject.jobs.CRMDOJob job)
void	removePhysicalGoods(com.crm.dataobject.jobs.CRMDOJob job) Removes the related physical goods from a job that will be cancelled.
void	removeRelatedActivities(com.crm.dataobject.jobs.CRMDOJob job) Removes the related activities from a job that will be cancelled.
com.crm.dataobject.jobs.CRMDOJob	setBillingTermProductPreratePeriodsInformation(com.crm.dataobject.jobs.CRMDOJob job) Sets the billing term product prerate periods information on a job Applicable for new subscription, add subscription service, swap subscription service
com.crm.dataobject.jobs.CRMDOJob	startProgress(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.jobs.CRMDOJobStatus status) Starts the progress of the job Validates that the job progress can start Sets the job life cycle state to IN_PROGRESS, sets the job status Validates the pending job activities Creates the job items Validates and saves the job Creates and sends communications based on the event-based communication definition
com.crm.dataobject.jobs.CRMDOJob	update(com.crm.dataobject.jobs.CRMDOJob job) Updates a job Sets the job location Validates the job, the provided physical goods and the scheduled date of the update Saves the related account Saves the job Creates and sends communications based on the event-based communication definition
void	validateScheduledDate(com.crm.dataobject.jobs.CRMDOJob job) Validates the scheduled date
void	validateScheduledDate(com.crm.dataobject.jobs.CRMDOJob job, java.util.Date subscriptionActionScheduledDate) Validates the scheduled date
void	validateType(com.crm.dataobject.jobs.CRMDOJobType type, com.crm.dataobject.jobs.JobTypeFulfillmentScope jobTypeFulfillmentScope)

Methods inherited from class com.crm.process.CRMProcess

createCronExpressionFromDate, createCronExpressionFromDate, setMandatoryField

Methods inherited from class com.crm.businessobject.CRMBase

deepCopy, dispatch, getCRMSession, getCRMSessionHandle, getCurrentDate, getEJBHomeInterface, getInitialContext, getSessionContext, invoke, setCRMSessionHandle, setInitialContext, setSessionContext

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALIAS_MANDATORY_PRODUCT

public static java.lang.String ALIAS_MANDATORY_PRODUCT

Constructor Detail

CRMProcessJobBean

public CRMProcessJobBean()

Default constructor.

Method Detail

create

public com.crm.dataobject.jobs.CRMDOJob create(com.crm.dataobject.jobs.CRMDOJob job)
                                        throws java.lang.Exception,
                                               com.crm.exception.CannotExecuteActionException

Creates a job Sets the job location Saves the related account Saves the job Creates and sends communications based on the event-based communication definition

Parameters:

job - - the job to create

Returns:

the created job

Throws:

java.lang.Exception

com.crm.exception.CannotExecuteActionException

validateScheduledDate

public void validateScheduledDate(com.crm.dataobject.jobs.CRMDOJob job)
                           throws java.lang.Exception

Validates the scheduled date

Parameters:

job - - the job to validate the scheduled date for

Throws:

java.lang.Exception

evaluateEventBasedConditionalExpensesFromSubscriptionAction

public java.util.ArrayList<com.crm.dataobject.jobs.CRMDOJobProduct> evaluateEventBasedConditionalExpensesFromSubscriptionAction(com.crm.dataobject.jobs.CRMDOJob job)
                                                                                                                         throws java.lang.Exception

Throws:

java.lang.Exception

evaluateEventBasedConditionalExpensesFromSubscriptionAction

public java.util.ArrayList<com.crm.dataobject.jobs.CRMDOJobProduct> evaluateEventBasedConditionalExpensesFromSubscriptionAction(com.crm.dataobject.jobs.CRMDOJob job,
                                                                                                                                java.util.Set<com.crm.dataobject.jobs.CRMDOJobProduct> jobProducts)
                                                                                                                         throws java.lang.Exception

Throws:

java.lang.Exception

validateScheduledDate

public void validateScheduledDate(com.crm.dataobject.jobs.CRMDOJob job,
                                  java.util.Date subscriptionActionScheduledDate)
                           throws java.lang.Exception

Validates the scheduled date

Parameters:

job - - the job to validate the scheduled date for

subscriptionActionScheduledDate - - the subscription action scheduled date to validate

Throws:

java.lang.Exception

update

public com.crm.dataobject.jobs.CRMDOJob update(com.crm.dataobject.jobs.CRMDOJob job)
                                        throws java.lang.Exception

Updates a job Sets the job location Validates the job, the provided physical goods and the scheduled date of the update Saves the related account Saves the job Creates and sends communications based on the event-based communication definition

Parameters:

job - - the job to update

Returns:

the updated job

Throws:

java.lang.Exception

setBillingTermProductPreratePeriodsInformation

public com.crm.dataobject.jobs.CRMDOJob setBillingTermProductPreratePeriodsInformation(com.crm.dataobject.jobs.CRMDOJob job)
                                                                                throws java.lang.Exception

Sets the billing term product prerate periods information on a job Applicable for new subscription, add subscription service, swap subscription service

Parameters:

job - - the job to set the billing term product prerate periods information

Returns:

the updated job

Throws:

java.lang.Exception

startProgress

public com.crm.dataobject.jobs.CRMDOJob startProgress(com.crm.dataobject.jobs.CRMDOJob job,
                                                      com.crm.dataobject.jobs.CRMDOJobStatus status)
                                               throws java.lang.Exception

Starts the progress of the job Validates that the job progress can start Sets the job life cycle state to IN_PROGRESS, sets the job status Validates the pending job activities Creates the job items Validates and saves the job Creates and sends communications based on the event-based communication definition

Parameters:

job - - the job to set in progress

status - - the status to be set on the job

Returns:

the in progress job

Throws:

java.lang.Exception

recalculatedKeyDatesOnStartingProgress

public com.crm.dataobject.jobs.CRMDOJob recalculatedKeyDatesOnStartingProgress(com.crm.dataobject.jobs.CRMDOJob job)
                                                                        throws java.lang.Exception

Throws:

java.lang.Exception

complete

public com.crm.dataobject.jobs.CRMDOJob complete(com.crm.dataobject.jobs.CRMDOJob job,
                                                 com.crm.dataobject.jobs.CRMDOJobStatus status,
                                                 java.util.Date performedDate,
                                                 com.crm.dataobject.users.CRMDOUser performedByUser)
                                          throws java.lang.Exception

Completes a job Validates that the job can be cancelled Sets the completed job status, the date that the completion was performed and the user that performed the completion Completes the service request of the job, if a service request exists and it should be completed Bills the job

Parameters:

job - - the job to complete

status - - the status to be set on the completed job

performedDate - - the date that the completion was performed

performedByUser - - the user that performed the completion

Returns:

the completed job

Throws:

java.lang.Exception

amendBillingTerms

public com.crm.dataobject.jobs.CRMDOJob amendBillingTerms(com.crm.dataobject.jobs.CRMDOJob job,
                                                          com.crm.dataobject.priceplan.CRMDOPricePlan pricePlan,
                                                          com.crm.dataobject.billing.CRMDOBillingTermScheme billingTermScheme,
                                                          java.util.Date agreementDate,
                                                          java.lang.Integer removeConcurrentUsage,
                                                          java.math.BigDecimal concurrentUsage,
                                                          java.math.BigDecimal ratePercentage)
                                                   throws java.lang.Exception,
                                                          com.crm.exception.AtLeastOneFieldException,
                                                          com.crm.exception.billing.BillingTermMissingException

Amends the billing terms of a job.

Parameters:

job - - the job to amend the billing terms for

pricePlan - - the price plan to set

billingTermScheme - - the billing term scheme code to set

agreementDate - - the agreement date to set

Returns:

the updated job

Throws:

java.lang.Exception

com.crm.exception.AtLeastOneFieldException

com.crm.exception.billing.BillingTermMissingException

previewBill

public com.crm.dataobject.billing.CRMDOBill previewBill(com.crm.dataobject.jobs.CRMDOJob job,
                                                        java.util.Date asOfDate)
                                                 throws java.lang.Exception

Previews a bill of a job as of a date.

Parameters:

job - - the job to preview a bill for

asOfDate - - the as of date to preview a bill from

Returns:

the updated bill

Throws:

java.lang.Exception

bill

public com.crm.dataobject.billing.CRMDOBill bill(com.crm.dataobject.jobs.CRMDOJob job,
                                                 java.util.Date asOfDate)
                                          throws java.lang.Exception

Bills a job as of a date.

Parameters:

job - - the job to bill

asOfDate - - the as of date to bill from

Returns:

the updated bill

Throws:

java.lang.Exception

bill

public com.crm.dataobject.billing.CRMDOBill bill(com.crm.dataobject.jobs.CRMDOJob job,
                                                 java.util.Date asOfDate,
                                                 java.lang.Boolean billPreview)
                                          throws java.lang.Exception,
                                                 com.crm.exception.billing.InvalidBillingDirectiveException

Bills a job as of a date by a normal billing run definition, a billing term definition and price plans. A subscription which requires prepayment can be billed on complete job action even if is the job is not billable

Parameters:

job - - the job to preview a bill for

asOfDate - - the as of date to preview a bill from

billPreview - - a boolean indicating if the bill is to be previewed

Returns:

the updated bill

Throws:

java.lang.Exception

com.crm.exception.billing.InvalidBillingDirectiveException

cancel

public com.crm.dataobject.jobs.CRMDOJob cancel(com.crm.dataobject.jobs.CRMDOJob job,
                                               com.crm.dataobject.jobs.CRMDOJobStatus status,
                                               com.crm.dataobject.jobs.CRMDOJobCancelReason cancelReason)
                                        throws java.lang.Exception

Cancels a job Validates that the job can be cancelled Removes the physical goods and activities of the job Sets the job life cycle state to CANCELLED job, sets the job status, the reason for the job cancellation

Parameters:

job - - the job to cancel

status - - the status to set on the cancelled job

cancelReason - - the cancellation reason

Returns:

the cancelled job

Throws:

java.lang.Exception

validateType

public void validateType(com.crm.dataobject.jobs.CRMDOJobType type,
                         com.crm.dataobject.jobs.JobTypeFulfillmentScope jobTypeFulfillmentScope)
                  throws com.crm.exception.InvalidValueException,
                         java.lang.Exception

Throws:

com.crm.exception.InvalidValueException

java.lang.Exception

billPreviewRates

public BillPreviewRates billPreviewRates(com.crm.dataobject.jobs.CRMDOJob job)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

billPreviewRates

public BillPreviewRates billPreviewRates(com.crm.dataobject.jobs.CRMDOJob job,
                                         java.lang.Boolean isBillForQuotation)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

isVerifiedJobAddress

public java.lang.Boolean isVerifiedJobAddress(com.crm.dataobject.jobs.CRMDOJob job)
                                       throws java.lang.Exception

Verifies a job's address against the generic geographical areas coverage rules

Parameters:

job - the job to verify its address

Returns:

true, if address is verified, false if not

Throws:

java.lang.Exception

isVerifiedJobAddress

public java.lang.Boolean isVerifiedJobAddress(com.crm.dataobject.contactinfo.CRMDOContactInfoAddress jobAddress,
                                              com.crm.dataobject.jobs.CRMDOJobType type)
                                       throws java.lang.Exception

Verifies a job's address against the generic geographical areas coverage rules

Parameters:

jobAddress - the job Address to verify

type - the type of the job to verify its job address

Returns:

true, if address is verified, false if not

Throws:

java.lang.Exception

removePhysicalGoods

public void removePhysicalGoods(com.crm.dataobject.jobs.CRMDOJob job)
                         throws java.lang.Exception

Removes the related physical goods from a job that will be cancelled.

Parameters:

job - - the job to remove the related physical goods for

Throws:

java.lang.Exception

removeRelatedActivities

public void removeRelatedActivities(com.crm.dataobject.jobs.CRMDOJob job)
                             throws java.lang.Exception

Removes the related activities from a job that will be cancelled.

Parameters:

job - - the job to remove the related activities for

Throws:

java.lang.Exception

consctructJobQuotation

public com.crm.dataobject.jobs.CRMDOJob consctructJobQuotation(com.crm.dataobject.jobs.CRMDOJob job)
                                                        throws java.lang.Exception

Constructs job quotation of a given job.

Parameters:

job - - the job to create the job quotation

Returns:

the updated job

Throws:

java.lang.Exception

anonymizeContactJobs

public void anonymizeContactJobs(com.crm.dataobject.contactinfo.CRMDOContactInformation contact)
                          throws java.lang.Exception

Anonymizes the given contact information jobs

Parameters:

contact - - the contact information to anonymize its jobs

Throws:

java.lang.Exception

invoice

public com.crm.dataobject.jobs.CRMDOJob invoice(com.crm.dataobject.jobs.CRMDOJob job,
                                                com.crm.dataobject.billing.CRMDOBill bill,
                                                java.util.Set<com.crm.dataobject.billing.CRMDORatedBillingItem> ratedBillingItems,
                                                com.crm.dataobject.products.CRMDOProduct milestoneProduct,
                                                java.util.Set<com.crm.dataobject.jobs.CRMDOJobProduct> physicalGoods,
                                                java.util.Set<com.crm.dataobject.jobs.CRMDOJobProduct> expenses,
                                                java.util.Set<com.crm.dataobject.activities.CRMDOActivity> activities,
                                                java.math.BigDecimal amountToInvoice,
                                                java.math.BigDecimal totalBilledAmount)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

calculateAmountAlreadyPaid

public com.crm.dataobject.jobs.CRMDOJob calculateAmountAlreadyPaid(com.crm.dataobject.jobs.CRMDOJob job)
                                                            throws java.lang.Exception

Calculates the amount that was already paid for the given job by retrieving the total paid amount of all the posted payments that are referring to that job

Parameters:

job - - the job to calculate the amount that was already paid for

Returns:

the updated job

Throws:

java.lang.Exception

calculateAvailableWalletBalanceToBeUsed

public com.crm.dataobject.jobs.CRMDOJob calculateAvailableWalletBalanceToBeUsed(com.crm.dataobject.jobs.CRMDOJob job)
                                                                         throws java.lang.Exception

Calculates the wallet balance that is available to be used for a specific job.

Parameters:

job - - the job to calculate the available Wallet Balance to be used for

Returns:

the updated job

Throws:

java.lang.Exception