com.crm.businessobject.jobs

Class CRMBOJobBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.CRMBOAssignableEntityBean

com.crm.businessobject.jobs.CRMBOJobBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOJobBean
extends CRMBOAssignableEntityBean

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
CRMBOJobBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
com.crm.dataobject.jobs.CRMDOJob	bill(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.billing.CRMDOBillingRun billingRun, com.crm.dataobject.billing.CRMDOBillingRunDefinition activeBRDefinition) Bills a job by a billing run and a billing run definition.
com.crm.dataobject.jobs.CRMDOJob	calculateEstimation(com.crm.dataobject.jobs.CRMDOJob job) Calculates the estimated completion time of a job.
com.crm.dataobject.jobs.CRMDOJob	calculateExpectedCompletionDate(com.crm.dataobject.jobs.CRMDOJob job) Calculates the expected completion date of a job.
com.crm.dataobject.jobs.CRMDOJob	calculateTimeOverdue(com.crm.dataobject.jobs.CRMDOJob job) Calculates the time passed from the job expected completion date.
com.crm.dataobject.jobs.CRMDOJob	calculateTimeToCompletion(com.crm.dataobject.jobs.CRMDOJob job) Calculates the time left until a job is completed.
com.crm.dataobject.contactinfo.CRMDOContactInfoAddress	copyContactInfoAddress(com.crm.dataobject.contactinfo.CRMDOContactInfoAddress contactInfoAddress, com.crm.dataobject.contactinfo.CRMDOContactInfoAddress requestedSubscriptionLocation) Copies the contact information address to a new contact info address or to an existing one
com.crm.dataobject.jobs.CRMDOJob	copyEstimation(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.jobs.CRMDOJobType jobType) Copies the estimated completion time from an job type to a job.
com.crm.dataobject.jobs.CRMDOJob	createRequestedActivities(com.crm.dataobject.jobs.CRMDOJob job) Creates pending activities for a job in start progress
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a job.
java.lang.Boolean	isBilled(com.crm.dataobject.jobs.CRMDOJob job) Checks if the job is billed.
java.lang.Boolean	isBillingAddressRuleCriterionValid(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.accounts.BillingAddressRules billingAddressRules) Checks if the Accounts Receivable is used by a job of a specific type and billing term scheme
java.lang.Boolean	isProductExists(com.crm.dataobject.products.CRMDOProduct product, java.util.Set<com.crm.dataobject.subscriptions.CRMDOSubscriptionService> existingServices) Checks if a product already exists in a list of subscription services.
java.lang.Boolean	isRated(com.crm.dataobject.jobs.CRMDOJob job) Checks if the job is already rated.
boolean	isRelatedWithNonCompleteJob(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.lang.Boolean isUsedForLocationChange) Checks if the subscription is used by a non completed job.
java.lang.Boolean	isSubscriptionTypeProductExists(com.crm.dataobject.products.CRMDOProduct product, java.util.ArrayList<com.crm.dataobject.CRMDO> existingServices) Checks if a product already exists in a list of subscription type services.
java.lang.Boolean	isUsedByActivity(com.crm.dataobject.jobs.CRMDOJob job) Checks if the job is used by an activity.
java.lang.Boolean	isUsedByDraftCommunication(com.crm.dataobject.jobs.CRMDOJob job) Checks if the job is used by a draft communication.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Loads a list of jobs by an account.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.util.ArrayList<java.lang.String> associations) Loads a list of jobs by an account.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInfoAddress location) Loads a list of jobs by a location.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.jobs.CRMDOJobCategory category) Loads a list of jobs by a category.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.jobs.CRMDOJobStatus status) Loads a list of jobs by a status.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.jobs.CRMDOJobType type) Loads a list of jobs by a type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.jobs.CRMDOJobType jobType, com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, java.util.ArrayList<java.lang.String> associations) Loads a list of jobs by a job type and an Accounts Receivable.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.servicerequests.CRMDOServiceRequest serviceRequest) Loads a list of jobs related to a service request.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.lang.Boolean isUsedForLocationChange, java.lang.Boolean isIncomplete, java.util.ArrayList<java.lang.String> associations) Loads a list of jobs based on a number of criteria.
com.crm.dataobject.jobs.CRMDOJob	loadAdditionalInformation(com.crm.dataobject.jobs.CRMDOJob job) Loads additional information of a job.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadBillable(com.crm.dataobject.accounts.CRMDOAccountReceivable account) Loads a list of billable jobs by an account.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadBillable(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.jobs.CRMDOJob job, java.util.Date billAsOfDate, java.util.ArrayList<java.lang.String> associations) Loads a list of billable jobs by an account.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadBillable(com.crm.dataobject.accounts.CRMDOAccountReceivable account, java.util.Date billAsOfDate) Loads a list of billable jobs by an account.
com.crm.dataobject.jobs.CRMDOJob	loadByNumber(java.lang.String number) Loads a job by a number.
com.crm.dataobject.jobs.CRMDOJob	loadByNumber(java.lang.String number, java.util.ArrayList<java.lang.String> associations) Loads a job by a number.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadCancelled(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.jobs.CRMDOJobType jobType, java.util.ArrayList<java.lang.String> associations) Loads a list of cancelled jobs.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadCompleted(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.jobs.CRMDOJobType jobType, java.util.ArrayList<java.lang.String> associations) Loads a list of jobs in progress.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadCompleted(com.crm.dataobject.contactinfo.CRMDOContactInformation contact) Loads a list of completed jobs related to a contact.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadDraft(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.jobs.CRMDOJobType jobType, java.util.ArrayList<java.lang.String> associations) Loads a list of draft jobs.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadIncomplete() Loads a list of incomplete jobs.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadIncomplete(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.jobs.CRMDOJobType jobType, java.lang.Integer totalTime, com.crm.framework.util.UnitOfTime totalTimeUOT) Loads a list of incomplete jobs by an account and a job type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadIncomplete(com.crm.dataobject.contactinfo.CRMDOContactInformation contact) Loads a list of incomplete jobs related to a contact.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadIncomplete(java.lang.Integer totalTime, com.crm.framework.util.UnitOfTime totalTimeUOT) Loads a list of jobs that are near to the expected completion date.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadInProgress(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.jobs.CRMDOJobType jobType, java.util.ArrayList<java.lang.String> associations) Loads a list of jobs in progress.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadOverdue() Loads a list of overdue jobs.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadOverdue(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.jobs.CRMDOJobType jobType) Loads a list of overdue jobs.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadOverdue(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.jobs.CRMDOJobType jobType, java.util.ArrayList<java.lang.String> associations) Loads a list of overdue jobs.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadOverdue(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.jobs.CRMDOJobType jobType, java.util.Date overdueDate) Loads a list of overdue jobs.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadOverdue(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.jobs.CRMDOJobType jobType, java.util.Date overdueDate, java.util.ArrayList<java.lang.String> associations) Loads a list of overdue jobs.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadOverdue(java.util.Date overdueDate) Loads a list of overdue jobs.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadPending(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.jobs.CRMDOJobType jobType, java.util.ArrayList<java.lang.String> associations) Loads a list of pending jobs.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadPending(com.crm.dataobject.contactinfo.CRMDOContactInformation contact) Loads a list of pending jobs related to a contact.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadPending(com.crm.dataobject.jobs.CRMDOJobStatus jobStatus) Loads a list of pending jobs related to a job status.
com.crm.dataobject.jobs.CRMDOJob	rate(com.crm.dataobject.jobs.CRMDOJob job) Rates a job.
com.crm.dataobject.jobs.CRMDOJob	rate(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.billing.CRMDONormalBillingRun billingRun, com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition, java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans) Rates a job by a list of price plans.
void	saveAccountReceivable(com.crm.dataobject.jobs.CRMDOJob job) Saves the account of a job.
com.crm.dataobject.jobs.CRMDOJob	setActualCompletedDate(com.crm.dataobject.jobs.CRMDOJob job) Sets the actual completed date of a job.
com.crm.dataobject.jobs.CRMDOJob	setInformationFromJobType(com.crm.dataobject.jobs.CRMDOJob job)
com.crm.dataobject.jobs.CRMDOJob	setJobBillingTerms(com.crm.dataobject.jobs.CRMDOJob job)
com.crm.dataobject.jobs.CRMDOJob	setLifeCycleState(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.jobs.CRMDOJobStatus jobStatus) Sets the job life cycle state.
com.crm.dataobject.jobs.CRMDOJob	stockInPhysicalGoods(com.crm.dataobject.jobs.CRMDOJob job) Stocks out physical goods from a warehouse.
com.crm.dataobject.jobs.CRMDOJob	stockOutPhysicalGoods(com.crm.dataobject.jobs.CRMDOJob job) Stocks out physical goods from a warehouse.
com.crm.dataobject.jobs.CRMDOJob	validateCompletion(com.crm.dataobject.jobs.CRMDOJob job) Validates the job during completion.
java.lang.Boolean	validateIfUsedByAcceptedOrPendingResourceRequest(com.crm.dataobject.jobs.CRMDOJob job) Checks if the job is used by a pending or accepted resource request.
java.lang.Boolean	validateIfUsedByNonCompleteServiceRequest(com.crm.dataobject.jobs.CRMDOJob job) Checks if the job is used by a non completed service request.
void	validateIfUsedByResourceRequest(com.crm.dataobject.jobs.CRMDOJob job) Validates if a job is being used by a resource request on delete.
java.lang.Boolean	validateJobLifeCycleStateAgainstDB(com.crm.dataobject.jobs.CRMDOJob job, java.util.ArrayList<com.crm.dataobject.jobs.JobLifeCycleState> validLifeCycleStates) Checks if a job exists with the given life cycle states
void	validateMaxNumberOfResourceRequests(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.jobs.CRMDOJobRequestedActivityService jobRequestedActivityService) Validates the max number of resource requests of the given job.
void	validateMaxNumberOfResourceRequests(com.crm.dataobject.jobs.CRMDOJob job, com.crm.dataobject.jobs.CRMDOJobRequestedActivityService jobRequestedActivityService, com.crm.dataobject.resourcescheduling.CRMDOResourceSchedulingDefinition activeResourceSchedulingDefinition) Validates the max number of resource requests of the given job.
com.crm.dataobject.jobs.CRMDOJob	validateSetAsPending(com.crm.dataobject.jobs.CRMDOJob job) Validates the draft Pending job.
com.crm.dataobject.jobs.CRMDOJob	validateSetInProgress(com.crm.dataobject.jobs.CRMDOJob job) Validates the draft In Progress job.

Methods inherited from class com.crm.businessobject.CRMBOAssignableEntityBean

accept, construct, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBO

construct, construct, construct, construct, construct, construct, construct, createAndUpdate, delete, delete, delete, getDOName, getDOName, getNextSequenceNumber, getNextSequenceNumber, getNumberScheme, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, parseAssociations, save, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBase

dispatch, getCRMSession, getCRMSessionHandle, 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_ACTIVITY_TYPE

public static java.lang.String ALIAS_MANDATORY_ACTIVITY_TYPE

ALIAS_MANDATORY_PRODUCT

public static java.lang.String ALIAS_MANDATORY_PRODUCT

Constructor Detail

CRMBOJobBean

public CRMBOJobBean()

Default constructor.

Method Detail

saveAccountReceivable

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

Saves the account of a job.

Parameters:

job - - the job to save the account for

Throws:

java.lang.Exception

isBillingAddressRuleCriterionValid

public java.lang.Boolean isBillingAddressRuleCriterionValid(com.crm.dataobject.jobs.CRMDOJob job,
                                                   com.crm.dataobject.accounts.BillingAddressRules billingAddressRules)
                                                     throws java.lang.Exception

Checks if the Accounts Receivable is used by a job of a specific type and billing term scheme

Parameters:

accountReceivable - - the Accounts Receivable to check

billingAddressRules - - the billing address rule object that will define the types and schemes to be checked

Returns:

true if the Accounts Receivable is used by a job of a specific type and scheme, false if not

Throws:

java.lang.Exception

validateSetAsPending

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

Validates the draft Pending job.

Parameters:

job - - the job to validate

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

validateSetInProgress

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

Validates the draft In Progress job.

Parameters:

job - - the job to validate

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

validateCompletion

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

Validates the job during completion.

Parameters:

job - - the job to validate

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

isUsedByActivity

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

Checks if the job is used by an activity.

Parameters:

job - - the job to check

Returns:

true if the job is used by an activity, false if not

Throws:

java.lang.Exception

getDefaultAssociations

public java.util.ArrayList<java.lang.String> getDefaultAssociations()

Returns the default associated data objects of a job.

Overrides:

getDefaultAssociations in class CRMBOAssignableEntityBean

Returns:

the default associated data objects of the job

loadAdditionalInformation

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

Loads additional information of a job. - calculates the time to completion - calculates the time overdue - loads the the effective billing term

Parameters:

job - - the job to load the additional information for

Returns:

the updated job

Throws:

java.lang.Exception

setLifeCycleState

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

Sets the job life cycle state.

Parameters:

job - - a job to set the life cycle state of

jobStatus - - a job status to get the life cycle state from

Returns:

the updated job

Throws:

java.lang.Exception

setActualCompletedDate

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

Sets the actual completed date of a job.

Parameters:

job - - the job to set the actual completion date

Returns:

the updated job

Throws:

java.lang.Exception

copyEstimation

public com.crm.dataobject.jobs.CRMDOJob copyEstimation(com.crm.dataobject.jobs.CRMDOJob job,
                                              com.crm.dataobject.jobs.CRMDOJobType jobType)
                                                throws java.lang.Exception

Copies the estimated completion time from an job type to a job.

Parameters:

job - - a job to copy the estimated completion time from

jobType - - a job type to get the default estimated completion time from

Returns:

the update job

Throws:

java.lang.Exception

calculateExpectedCompletionDate

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

Calculates the expected completion date of a job.

Parameters:

job - - the job to calculate the estimate completion date for

Returns:

the updated job

Throws:

java.lang.Exception

calculateEstimation

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

Calculates the estimated completion time of a job.

Parameters:

job - - the job to calculate the estimated completion time for

Returns:

the updated job

Throws:

java.lang.Exception

calculateTimeToCompletion

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

Calculates the time left until a job is completed.

Parameters:

job - - the job to calculate the time of completion for

Returns:

the updated job

Throws:

java.lang.Exception

calculateTimeOverdue

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

Calculates the time passed from the job expected completion date.

Parameters:

job - - the job to calculate the overdue time for

Returns:

the updated job

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.jobs.CRMDOJobType type)
                                                   throws java.lang.Exception

Loads a list of jobs by a type.

Parameters:

type - - the type to load the jobs for

Returns:

a list of jobs by the given type

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.jobs.CRMDOJobStatus status)
                                                   throws java.lang.Exception

Loads a list of jobs by a status.

Parameters:

status - - the status to load the jobs for

Returns:

a list of jobs by the given category

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.jobs.CRMDOJobCategory category)
                                                   throws java.lang.Exception

Loads a list of jobs by a category.

Parameters:

category - - the category to load the jobs for

Returns:

a list of jobs by the given category

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.contactinfo.CRMDOContactInfoAddress location)
                                                   throws java.lang.Exception

Loads a list of jobs by a location.

Parameters:

location - - the location to load the jobs for

Returns:

a list of jobs by the given location

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                                   throws java.lang.Exception

Loads a list of jobs by an account.

Parameters:

account - - the account to load the jobs for

Returns:

a list of jobs by the given account

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                 java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of jobs by an account.

Parameters:

account - - the account to load the jobs for

associations - - a list of associated data objects

Returns:

a list of jobs by the given account

Throws:

java.lang.Exception

loadCompleted

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadCompleted(com.crm.dataobject.contactinfo.CRMDOContactInformation contact)
                                                            throws java.lang.Exception

Loads a list of completed jobs related to a contact.

Parameters:

contact - - the contact to load the related jobs for

Returns:

a list of completed jobs related to the given contact

Throws:

java.lang.Exception

loadCompleted

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadCompleted(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          com.crm.dataobject.jobs.CRMDOJobType jobType,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                            throws java.lang.Exception

Loads a list of jobs in progress.

Parameters:

accountReceivable - - the account related to the job

jobType - - the job type

associations - - a list of associated data objects

Returns:

a list of jobs in progress

Throws:

java.lang.Exception

loadPending

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadPending(com.crm.dataobject.contactinfo.CRMDOContactInformation contact)
                                                          throws java.lang.Exception

Loads a list of pending jobs related to a contact.

Parameters:

contact - - the contact to load the related jobs for

Returns:

a list of pending jobs related to the given contact

Throws:

java.lang.Exception

loadPending

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadPending(com.crm.dataobject.jobs.CRMDOJobStatus jobStatus)
                                                          throws java.lang.Exception

Loads a list of pending jobs related to a job status.

Parameters:

jobStatus - - the job status to load the related jobs for

Returns:

a list of pending jobs related to the given contact

Throws:

java.lang.Exception

loadPending

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadPending(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                        com.crm.dataobject.jobs.CRMDOJobType jobType,
                                                        java.util.ArrayList<java.lang.String> associations)
                                                          throws java.lang.Exception

Loads a list of pending jobs.

Parameters:

accountReceivable - - the account related to the job

jobType - - the job type

associations - - a list of associated data objects

Returns:

a list of pending jobs

Throws:

java.lang.Exception

loadInProgress

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadInProgress(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                           com.crm.dataobject.jobs.CRMDOJobType jobType,
                                                           java.util.ArrayList<java.lang.String> associations)
                                                             throws java.lang.Exception

Loads a list of jobs in progress.

Parameters:

accountReceivable - - the account related to the job

jobType - - the job type

associations - - a list of associated data objects

Returns:

a list of jobs in progress

Throws:

java.lang.Exception

loadCancelled

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadCancelled(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                          com.crm.dataobject.jobs.CRMDOJobType jobType,
                                                          java.util.ArrayList<java.lang.String> associations)
                                                            throws java.lang.Exception

Loads a list of cancelled jobs.

Parameters:

accountReceivable - - the account related to the job

jobType - - the job type

associations - - a list of associated data objects

Returns:

a list of cancelled jobs

Throws:

java.lang.Exception

loadDraft

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadDraft(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                      com.crm.dataobject.jobs.CRMDOJobType jobType,
                                                      java.util.ArrayList<java.lang.String> associations)
                                                        throws java.lang.Exception

Loads a list of draft jobs.

Parameters:

accountReceivable - - the account related to the job

jobType - - the job type

associations - - a list of associated data objects

Returns:

a list of draft jobs

Throws:

java.lang.Exception

loadOverdue

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadOverdue()
                                                          throws java.lang.Exception

Loads a list of overdue jobs.

Returns:

a list of overdue jobs

Throws:

java.lang.Exception

loadOverdue

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadOverdue(java.util.Date overdueDate)
                                                          throws java.lang.Exception

Loads a list of overdue jobs.

Parameters:

overdueDate - - the overdue date

Returns:

a list of overdue jobs

Throws:

java.lang.Exception

loadOverdue

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadOverdue(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                        com.crm.dataobject.jobs.CRMDOJobType jobType)
                                                          throws java.lang.Exception

Loads a list of overdue jobs.

Parameters:

accountReceivable - - the account related to the job

jobType - - the job type

Returns:

a list of overdue jobs

Throws:

java.lang.Exception

loadOverdue

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadOverdue(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                        com.crm.dataobject.jobs.CRMDOJobType jobType,
                                                        java.util.ArrayList<java.lang.String> associations)
                                                          throws java.lang.Exception

Loads a list of overdue jobs.

Parameters:

accountReceivable - - the account related to the job

jobType - - the job type

associations - - a list of associated data objects

Returns:

a list of overdue jobs

Throws:

java.lang.Exception

loadOverdue

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadOverdue(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                        com.crm.dataobject.jobs.CRMDOJobType jobType,
                                                        java.util.Date overdueDate)
                                                          throws java.lang.Exception

Loads a list of overdue jobs.

Parameters:

accountReceivable - - the account related to the job

jobType - - the job type

overdueDate - - the overdue date

Returns:

a list of overdue jobs

Throws:

java.lang.Exception

loadOverdue

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadOverdue(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                        com.crm.dataobject.jobs.CRMDOJobType jobType,
                                                        java.util.Date overdueDate,
                                                        java.util.ArrayList<java.lang.String> associations)
                                                          throws java.lang.Exception

Loads a list of overdue jobs.

Parameters:

accountReceivable - - the account related to the job

jobType - - the job type

overdueDate - - the overdue date

associations - - a list of associated data objects

Returns:

a list of overdue jobs

Throws:

java.lang.Exception

loadIncomplete

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadIncomplete()
                                                             throws java.lang.Exception

Loads a list of incomplete jobs.

Returns:

a list of incomplete jobs

Throws:

java.lang.Exception

loadIncomplete

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadIncomplete(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                           com.crm.dataobject.jobs.CRMDOJobType jobType,
                                                           java.lang.Integer totalTime,
                                                           com.crm.framework.util.UnitOfTime totalTimeUOT)
                                                             throws java.lang.Exception

Loads a list of incomplete jobs by an account and a job type.

Parameters:

accountReceivable - - the account related to the job

jobType - - the job type

totalTime - - the time until the completion date

totalTimeUOT - - the unit of time of the time until the completion date

Returns:

a list of incomplete jobs by the given account and job type

Throws:

java.lang.Exception

loadIncomplete

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadIncomplete(com.crm.dataobject.contactinfo.CRMDOContactInformation contact)
                                                             throws java.lang.Exception

Loads a list of incomplete jobs related to a contact.

Parameters:

contact - - the contact related to the job

Returns:

a list of incomplete jobs related to the given contact

Throws:

java.lang.Exception

loadIncomplete

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadIncomplete(java.lang.Integer totalTime,
                                                           com.crm.framework.util.UnitOfTime totalTimeUOT)
                                                             throws java.lang.Exception

Loads a list of jobs that are near to the expected completion date.

Parameters:

totalTime - - the time until the completion date

totalTimeUOT - - the unit of time of the time until the completion date

Returns:

a list of jobs that are near to the expected completion date

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                 java.lang.Boolean isUsedForLocationChange,
                                                 java.lang.Boolean isIncomplete,
                                                 java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of jobs based on a number of criteria.

Parameters:

subscription - - the related subscription

isUsedForLocationChange - - a flag for subscription change location action

isIncomplete - - boolean for incomplete jobs(exclude complete and cancelled)

associations - - a list of associated data objects

Returns:

a list of jobs based on the given criteria

Throws:

java.lang.Exception

isBilled

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

Checks if the job is billed.

Parameters:

job - - the job to check

Returns:

true if the job is billed, false if not

Throws:

java.lang.Exception

isRated

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

Checks if the job is already rated.

Parameters:

job - - the job to check

Returns:

true if the job is already rated, false if not

Throws:

java.lang.Exception

loadBillable

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadBillable(com.crm.dataobject.accounts.CRMDOAccountReceivable account)
                                                           throws java.lang.Exception

Loads a list of billable jobs by an account.

Parameters:

account - - the account to load the billable jobs for

Returns:

a list of billable jobs by the given account

Throws:

java.lang.Exception

loadBillable

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadBillable(com.crm.dataobject.accounts.CRMDOAccountReceivable account,
                                                         java.util.Date billAsOfDate)
                                                           throws java.lang.Exception

Loads a list of billable jobs by an account.

Parameters:

account - - the account to load the billable jobs for

billAsOfDate - - The date to consider job products and activity services based on billingEffectiveDate

Returns:

a list of billable jobs by the given account

Throws:

java.lang.Exception

loadBillable

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadBillable(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                         com.crm.dataobject.jobs.CRMDOJob job,
                                                         java.util.Date billAsOfDate,
                                                         java.util.ArrayList<java.lang.String> associations)
                                                           throws java.lang.Exception

Loads a list of billable jobs by an account.

Parameters:

account - - the account to load the billable jobs for

billAsOfDate - - The date to consider job products and activity services based on billingEffectiveDate

associations - - a list of associated data objects

Returns:

a list of billable jobs by the given account

Throws:

java.lang.Exception

rate

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

Rates a job.

Parameters:

job - - the job to rate

Returns:

the updated job

Throws:

java.lang.Exception

rate

public com.crm.dataobject.jobs.CRMDOJob rate(com.crm.dataobject.jobs.CRMDOJob job,
                                    com.crm.dataobject.billing.CRMDONormalBillingRun billingRun,
                                    com.crm.dataobject.billing.CRMDOBillingTermDefinition billingTermDefinition,
                                    java.util.ArrayList<com.crm.dataobject.priceplan.CRMDOPricePlan> pricePlans)
                                      throws java.lang.Exception,
                                             com.crm.exception.MandatoryFieldException

Rates a job by a list of price plans.

Parameters:

job - - the job to rate

billingTermDefinition - - the active billing term definition of jobs

billingRun - - the billing run to rate and bill the job with

pricePlans - - a list of price plans to use

Returns:

the updated job

Throws:

java.lang.Exception

com.crm.exception.MandatoryFieldException

bill

public com.crm.dataobject.jobs.CRMDOJob bill(com.crm.dataobject.jobs.CRMDOJob job,
                                    com.crm.dataobject.billing.CRMDOBillingRun billingRun,
                                    com.crm.dataobject.billing.CRMDOBillingRunDefinition activeBRDefinition)
                                      throws java.lang.Exception

Bills a job by a billing run and a billing run definition.

Parameters:

job - - the job to bill

billingRun - - the billing run to use

activeBRDefinition - - the billing run definition to use

Returns:

the updated job

Throws:

java.lang.Exception

stockOutPhysicalGoods

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

Stocks out physical goods from a warehouse. (If the inventory directive, as specified in the related job type, is set to update stock automatically then for traceable physical goods, if the physical goods that were specified on the job are still in a warehouse, then a stock out warehouse transaction is performed. For non traceable physical goods, a stock out warehouse transaction is performed. The movements are done based on the rules specified in inventory management)

Parameters:

job - - the job to stock out physical goods

Returns:

the updated job

Throws:

java.lang.Exception

stockInPhysicalGoods

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

Stocks out physical goods from a warehouse. (If the inventory directive, as specified in the related job type, is set to update stock automatically then for traceable physical goods, if the physical goods that were specified on the job are still in a warehouse, then a stock out warehouse transaction is performed. For non traceable physical goods, a stock out warehouse transaction is performed. The movements are done based on the rules specified in inventory management)

Parameters:

job - - the job to stock out physical goods

Returns:

the updated job

Throws:

java.lang.Exception

loadByNumber

public com.crm.dataobject.jobs.CRMDOJob loadByNumber(java.lang.String number)
                                              throws java.lang.Exception

Loads a job by a number.

Parameters:

number - - the number to job the job for

Returns:

a job with the given number

Throws:

java.lang.Exception

loadByNumber

public com.crm.dataobject.jobs.CRMDOJob loadByNumber(java.lang.String number,
                                            java.util.ArrayList<java.lang.String> associations)
                                              throws java.lang.Exception

Loads a job by a number.

Parameters:

number - - the number to job the job for

associations - - a list of associated data objects

Returns:

a job with the given number

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.jobs.CRMDOJobType jobType,
                                                 com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                                 java.util.ArrayList<java.lang.String> associations)
                                                   throws java.lang.Exception

Loads a list of jobs by a job type and an Accounts Receivable.

Parameters:

jobType - - the job type to load by

accountReceivable - - the account to load by

associations - - a list of associated data objects

Returns:

a list of jobs with the given job type and Accounts Receivable

Throws:

java.lang.Exception

isUsedByDraftCommunication

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

Checks if the job is used by a draft communication.

Parameters:

job - - the job to check

Returns:

true if the job is used by a draft communication, false if not

Throws:

java.lang.Exception

validateIfUsedByNonCompleteServiceRequest

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

Checks if the job is used by a non completed service request.

Parameters:

job - - the job to check

Returns:

true if the job is used by a non completed service request, false if not

Throws:

java.lang.Exception

validateIfUsedByResourceRequest

public void validateIfUsedByResourceRequest(com.crm.dataobject.jobs.CRMDOJob job)
                                     throws java.lang.Exception,
                                            com.crm.exception.CannotDeleteException

Validates if a job is being used by a resource request on delete.

Parameters:

contact - - the job to validate

Throws:

java.lang.Exception

com.crm.exception.CannotDeleteException

validateIfUsedByAcceptedOrPendingResourceRequest

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

Checks if the job is used by a pending or accepted resource request.

Parameters:

job - - the job to check

Returns:

true if the job is used by a pending or accepted resource request, false if not

Throws:

java.lang.Exception

com.crm.exception.CannotExecuteActionException

isRelatedWithNonCompleteJob

public boolean isRelatedWithNonCompleteJob(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                  java.lang.Boolean isUsedForLocationChange)
                                    throws java.lang.Exception

Checks if the subscription is used by a non completed job.

Parameters:

subscription - - the subscription to check

isUsedForLocationChange - - a flag for subscription change location action

Returns:

true if the subscription is used by a non completed job, false if not

Throws:

java.lang.Exception

setInformationFromJobType

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

Throws:

com.crm.exception.DAOException

java.lang.Exception

setJobBillingTerms

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

Throws:

java.lang.Exception

validateJobLifeCycleStateAgainstDB

public java.lang.Boolean validateJobLifeCycleStateAgainstDB(com.crm.dataobject.jobs.CRMDOJob job,
                                                   java.util.ArrayList<com.crm.dataobject.jobs.JobLifeCycleState> validLifeCycleStates)
                                                     throws java.lang.Exception

Checks if a job exists with the given life cycle states

Parameters:

job - - the job to check

Returns:

true if the job exist in database with given life cycle states, false if not

Throws:

java.lang.Exception

createRequestedActivities

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

Creates pending activities for a job in start progress

Parameters:

job - - the job to create pending activities

Returns:

the updated job

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.servicerequests.CRMDOServiceRequest serviceRequest)
                                                   throws java.lang.Exception

Loads a list of jobs related to a service request.

Parameters:

serviceRequest - - the service request to load the related jobs for

Returns:

a list of jobs related to the given service request

Throws:

java.lang.Exception

isProductExists

public java.lang.Boolean isProductExists(com.crm.dataobject.products.CRMDOProduct product,
                                java.util.Set<com.crm.dataobject.subscriptions.CRMDOSubscriptionService> existingServices)

Checks if a product already exists in a list of subscription services.

Parameters:

product - - the product to validate

Returns:

true if the product exists in the list, else false

isSubscriptionTypeProductExists

public java.lang.Boolean isSubscriptionTypeProductExists(com.crm.dataobject.products.CRMDOProduct product,
                                                java.util.ArrayList<com.crm.dataobject.CRMDO> existingServices)

Checks if a product already exists in a list of subscription type services.

Parameters:

product - - the product to validate

Returns:

true if the product exists in the list, else false

validateMaxNumberOfResourceRequests

public void validateMaxNumberOfResourceRequests(com.crm.dataobject.jobs.CRMDOJob job,
                                       com.crm.dataobject.jobs.CRMDOJobRequestedActivityService jobRequestedActivityService)
                                         throws com.crm.exception.CannotExecuteActionException,
                                                java.lang.Exception

Validates the max number of resource requests of the given job.

Parameters:

activity - - the activity to validate

activityService - - the activity service to validate in case of scope per activity service

Throws:

java.lang.Exception

com.crm.exception.CannotExecuteActionException

validateMaxNumberOfResourceRequests

public void validateMaxNumberOfResourceRequests(com.crm.dataobject.jobs.CRMDOJob job,
                                       com.crm.dataobject.jobs.CRMDOJobRequestedActivityService jobRequestedActivityService,
                                       com.crm.dataobject.resourcescheduling.CRMDOResourceSchedulingDefinition activeResourceSchedulingDefinition)
                                         throws java.lang.Exception

Validates the max number of resource requests of the given job.

Parameters:

activity - - the activity to validate

activityService - - the activity service to validate in case of scope per activity service

activeResourceSchedulingDefinition - - the max number of resource requests

Throws:

java.lang.Exception

copyContactInfoAddress

public com.crm.dataobject.contactinfo.CRMDOContactInfoAddress copyContactInfoAddress(com.crm.dataobject.contactinfo.CRMDOContactInfoAddress contactInfoAddress,
                                                                            com.crm.dataobject.contactinfo.CRMDOContactInfoAddress requestedSubscriptionLocation)
                                                                              throws java.lang.Exception

Copies the contact information address to a new contact info address or to an existing one

Parameters:

contactInfoAddress - - the contact info address to copy to validate

requestedSubscriptionLocation - - the contact info address to update

Returns:

the copied contact info address

Throws:

java.lang.Exception