com.crm.businessobject.subscriptions

Class CRMBOSubscriptionActionBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.subscriptions.CRMBOSubscriptionActionBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOSubscriptionActionBean
extends CRMBO

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	ADD_INSTALLED_ITEM_ACTION_TYPE
java.lang.String	ADD_SERVICE_ACTION_TYPE
java.lang.String	REMOVE_INSTALLED_ITEM_ACTION_TYPE
java.lang.String	REMOVE_SERVICE_ACTION_TYPE
java.lang.String	SUBSCRIPTION_ACTION_ENTITY_ID
java.lang.String	SUBSCRIPTION_ACTION_MAINTAIN_FEATURE_ID
java.lang.String	SUBSCRIPTION_ACTION_MODULE_ID
java.lang.String	SUBSCRIPTION_INSTALLED_ITEM_RELATED_ACTION
java.lang.String	SUBSCRIPTION_PROCESS_EXECUTION_OF_SCHEDULED_ACTION
java.lang.String	SUBSCRIPTION_SERVICES_RELATED_ACTION
java.lang.String	UPDATE_INSTALLED_ITEM_ACTION_TYPE

Constructor Summary

Constructors

Constructor and Description
CRMBOSubscriptionActionBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
com.crm.dataobject.subscriptions.CRMDOSubscriptionAction	amend(com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, java.util.Date newScheduledDate, java.util.Date newPerformedDate, com.crm.dataobject.users.CRMDOUser newPerformedByUser) Amend the given subscription action.
com.crm.dataobject.subscriptions.CRMDOSubscriptionAction	cancel(com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction) Cancels the given subscription action.
com.crm.dataobject.subscriptions.CRMDOSubscriptionAction	execute(com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction)
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, java.util.Date scheduledDate, java.util.ArrayList<com.crm.dataobject.subscriptions.SubscriptionActionBehaviorCode> behaviorCodes, com.crm.dataobject.subscriptions.SubscriptionActionLifeCycleState lifeCycleState)
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.SubscriptionActionBehaviorCode behaviorCode, com.crm.dataobject.subscriptions.SubscriptionActionClassificationCode classificationCode) Loads a list of subscription actions based on a number of criteria
com.crm.dataobject.subscriptions.CRMDOSubscriptionAction	load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription, com.crm.dataobject.subscriptions.SubscriptionActionBehaviorCode behaviorCode, com.crm.dataobject.subscriptions.SubscriptionActionClassificationCode classificationCode, java.lang.Boolean isScheduled)
com.crm.dataobject.subscriptions.CRMDOSubscriptionAction	loadByNumber(java.lang.String number) Loads a subscription action by a number.
com.crm.dataobject.subscriptions.CRMDOSubscriptionAction	loadByNumber(java.lang.String number, java.util.ArrayList<java.lang.String> associations) Loads a subscription action by a number.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadCancelled(com.crm.dataobject.subscriptions.CRMDOSubscriptionInstalledItem subscriptionInstalledItem)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadCancelled(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadCancelled(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService, java.util.Date scheduledDate)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadExecuted(com.crm.dataobject.subscriptions.CRMDOSubscriptionInstalledItem subscriptionInstalledItem)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadExecuted(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadExecuted(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService, java.util.Date scheduledDate)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadScheduled(com.crm.dataobject.subscriptions.CRMDOSubscriptionInstalledItem subscriptionInstalledItem)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadScheduled(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadScheduled(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService, java.util.Date scheduledDate)
com.crm.dataobject.subscriptions.CRMDOSubscriptionAction	reject(com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, com.crm.dataobject.subscriptions.SubscriptionActionLifeCycleState lifeCycleState, java.lang.Exception e)
com.crm.dataobject.subscriptions.CRMDOSubscriptionAction	schedule(com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction)
com.crm.dataobject.subscriptions.CRMDOSubscriptionAction	validateOnAmendment(com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction, java.util.Date newScheduledDate, java.util.Date newPerformDate, com.crm.dataobject.users.CRMDOUser newPerformByUser) Validates the subscription action on amendment
com.crm.dataobject.subscriptions.CRMDOSubscriptionAction	validateOnCancellation(com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction) Validates the subscription action on cancellation

Methods inherited from class com.crm.businessobject.CRMBO

construct, 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, 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

SUBSCRIPTION_ACTION_MODULE_ID

public final java.lang.String SUBSCRIPTION_ACTION_MODULE_ID

See Also:

Constant Field Values

SUBSCRIPTION_ACTION_MAINTAIN_FEATURE_ID

public final java.lang.String SUBSCRIPTION_ACTION_MAINTAIN_FEATURE_ID

See Also:

Constant Field Values

SUBSCRIPTION_ACTION_ENTITY_ID

public final java.lang.String SUBSCRIPTION_ACTION_ENTITY_ID

See Also:

Constant Field Values

SUBSCRIPTION_PROCESS_EXECUTION_OF_SCHEDULED_ACTION

public final java.lang.String SUBSCRIPTION_PROCESS_EXECUTION_OF_SCHEDULED_ACTION

See Also:

Constant Field Values

ADD_SERVICE_ACTION_TYPE

public final java.lang.String ADD_SERVICE_ACTION_TYPE

REMOVE_SERVICE_ACTION_TYPE

public final java.lang.String REMOVE_SERVICE_ACTION_TYPE

ADD_INSTALLED_ITEM_ACTION_TYPE

public final java.lang.String ADD_INSTALLED_ITEM_ACTION_TYPE

REMOVE_INSTALLED_ITEM_ACTION_TYPE

public final java.lang.String REMOVE_INSTALLED_ITEM_ACTION_TYPE

UPDATE_INSTALLED_ITEM_ACTION_TYPE

public final java.lang.String UPDATE_INSTALLED_ITEM_ACTION_TYPE

SUBSCRIPTION_INSTALLED_ITEM_RELATED_ACTION

public final java.lang.String SUBSCRIPTION_INSTALLED_ITEM_RELATED_ACTION

SUBSCRIPTION_SERVICES_RELATED_ACTION

public final java.lang.String SUBSCRIPTION_SERVICES_RELATED_ACTION

Constructor Detail

CRMBOSubscriptionActionBean

public CRMBOSubscriptionActionBean()

Default constructor.

Method Detail

reject

public com.crm.dataobject.subscriptions.CRMDOSubscriptionAction reject(com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                              com.crm.dataobject.subscriptions.SubscriptionActionLifeCycleState lifeCycleState,
                                                              java.lang.Exception e)
                                                                throws java.lang.Exception

Throws:

java.lang.Exception

execute

public com.crm.dataobject.subscriptions.CRMDOSubscriptionAction execute(com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction)
                                                                 throws java.lang.Exception

Throws:

java.lang.Exception

schedule

public com.crm.dataobject.subscriptions.CRMDOSubscriptionAction schedule(com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction)
                                                                  throws java.lang.Exception

Throws:

java.lang.Exception

getDefaultAssociations

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

Description copied from class: CRMBO

Returns the default associated data objects.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects

loadScheduled

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadScheduled(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService)
                                                            throws java.lang.Exception

Throws:

java.lang.Exception

loadScheduled

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadScheduled(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService,
                                                          java.util.Date scheduledDate)
                                                            throws java.lang.Exception

Throws:

java.lang.Exception

loadCancelled

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadCancelled(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService)
                                                            throws java.lang.Exception

Throws:

java.lang.Exception

loadCancelled

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadCancelled(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService,
                                                          java.util.Date scheduledDate)
                                                            throws java.lang.Exception

Throws:

java.lang.Exception

loadExecuted

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadExecuted(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService)
                                                           throws java.lang.Exception

Throws:

java.lang.Exception

loadExecuted

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadExecuted(com.crm.dataobject.subscriptions.CRMDOSubscriptionService subscriptionService,
                                                         java.util.Date scheduledDate)
                                                           throws java.lang.Exception

Throws:

java.lang.Exception

loadCancelled

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadCancelled(com.crm.dataobject.subscriptions.CRMDOSubscriptionInstalledItem subscriptionInstalledItem)
                                                            throws java.lang.Exception

Throws:

java.lang.Exception

loadScheduled

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadScheduled(com.crm.dataobject.subscriptions.CRMDOSubscriptionInstalledItem subscriptionInstalledItem)
                                                            throws java.lang.Exception

Throws:

java.lang.Exception

loadExecuted

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadExecuted(com.crm.dataobject.subscriptions.CRMDOSubscriptionInstalledItem subscriptionInstalledItem)
                                                           throws java.lang.Exception

Throws:

java.lang.Exception

load

public com.crm.dataobject.subscriptions.CRMDOSubscriptionAction load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                            com.crm.dataobject.subscriptions.SubscriptionActionBehaviorCode behaviorCode,
                                                            com.crm.dataobject.subscriptions.SubscriptionActionClassificationCode classificationCode,
                                                            java.lang.Boolean isScheduled)
                                                              throws java.lang.Exception

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                 java.util.Date scheduledDate,
                                                 java.util.ArrayList<com.crm.dataobject.subscriptions.SubscriptionActionBehaviorCode> behaviorCodes,
                                                 com.crm.dataobject.subscriptions.SubscriptionActionLifeCycleState lifeCycleState)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.subscriptions.CRMDOSubscription subscription,
                                                 com.crm.dataobject.subscriptions.SubscriptionActionBehaviorCode behaviorCode,
                                                 com.crm.dataobject.subscriptions.SubscriptionActionClassificationCode classificationCode)
                                                   throws java.lang.Exception

Loads a list of subscription actions based on a number of criteria

Parameters:

subscription - - the subscription to load the actions for

behaviorCode - - the behavior code of the subscription actions to load

classificationCode - - the classification code of the subscription actions to load

Returns:

a list of subscription actions

Throws:

java.lang.Exception

loadByNumber

public com.crm.dataobject.subscriptions.CRMDOSubscriptionAction loadByNumber(java.lang.String number)
                                                                      throws java.lang.Exception

Loads a subscription action by a number.

Parameters:

number - - the number to load the subscription action for

Returns:

a subscription action with the given number

Throws:

java.lang.Exception

loadByNumber

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

Loads a subscription action by a number.

Parameters:

number - - the number to load the subscription action for

associations - - a list of associated data objects

Returns:

a subscription action with the given number

Throws:

java.lang.Exception

validateOnCancellation

public com.crm.dataobject.subscriptions.CRMDOSubscriptionAction validateOnCancellation(com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction)
                                                                                throws com.crm.exception.subscriptions.CannotCancelSubscriptionActionException,
                                                                                       java.lang.Exception

Validates the subscription action on cancellation

Parameters:

subscriptionAction - - the subscription action to validate

Returns:

the subscription action

Throws:

com.crm.exception.subscriptions.CannotCancelSubscriptionActionException

java.lang.Exception

validateOnAmendment

public com.crm.dataobject.subscriptions.CRMDOSubscriptionAction validateOnAmendment(com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                                           java.util.Date newScheduledDate,
                                                                           java.util.Date newPerformDate,
                                                                           com.crm.dataobject.users.CRMDOUser newPerformByUser)
                                                                             throws com.crm.exception.subscriptions.CannotAmendSubscriptionActionException,
                                                                                    java.lang.Exception

Validates the subscription action on amendment

Parameters:

subscriptionAction - - the subscription action to validate

newScheduledDate - - the new scheduled date

newPerformedDate - - the new performed date

newPerformedByUser - - the new performed by user

Returns:

the subscription action

Throws:

com.crm.exception.subscriptions.CannotAmendSubscriptionActionException

java.lang.Exception

cancel

public com.crm.dataobject.subscriptions.CRMDOSubscriptionAction cancel(com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction)
                                                                throws java.lang.Exception

Cancels the given subscription action.

Parameters:

subscriptionAction - - the subscription action to cancel

Returns:

the cancelled subscription action

Throws:

java.lang.Exception

amend

public com.crm.dataobject.subscriptions.CRMDOSubscriptionAction amend(com.crm.dataobject.subscriptions.CRMDOSubscriptionAction subscriptionAction,
                                                             java.util.Date newScheduledDate,
                                                             java.util.Date newPerformedDate,
                                                             com.crm.dataobject.users.CRMDOUser newPerformedByUser)
                                                               throws java.lang.Exception

Amend the given subscription action.

Parameters:

subscriptionAction - - the subscription action to amend

newScheduledDate - - the new scheduled date

newPerformedDate - - the new performed date

newPerformedByUser - - the new performed by user

subscriptionAction - - the subscription action to amend

Returns:

the amended subscription action

Throws:

java.lang.Exception