com.crm.businessobject.communications

Class CRMBOCommunicationQueueBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.CRMBOConfigurationEntity

com.crm.businessobject.communications.CRMBOCommunicationQueueBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOCommunicationQueueBean
extends CRMBOConfigurationEntity

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOCommunicationQueueBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
com.crm.dataobject.communications.CRMDOCommunicationQueue	complete(com.crm.dataobject.communications.CRMDOCommunicationQueue communicationQueue) Sets a communication queue as complete.
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a communication queue.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.billing.CRMDOBill bill) Loads a list of communication queues of the given bill.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.communications.CRMDOCommunicationQueueExternalSystem cQExtSys, com.crm.dataobject.communications.CommunicationMedia media, com.crm.dataobject.contactinfo.CRMDOContactInformation contacInformation, com.crm.dataobject.communications.CommunicationQueueLifeCycleState lifeCycleState, java.util.ArrayList<java.lang.String> associations, java.lang.String orderBy, java.lang.Integer maxSize) Loads a list of communication queues by a number of criteria.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.communications.CRMDOCommunicationQueueExternalSystem cQExtSys, com.crm.dataobject.communications.CommunicationQueueLifeCycleState lifeCycleState) Loads a list of pending communication queues by an external system and life cycle state.
com.crm.dataobject.communications.CRMDOCommunicationQueue	loadByCommunication(com.crm.dataobject.communications.CRMDOCommunication communication) Loads a communication queue based on a communication.
com.crm.dataobject.communications.CRMDOCommunicationQueue	loadByCommunication(com.crm.dataobject.communications.CRMDOCommunication communication, java.util.ArrayList<java.lang.String> associations) Loads a communication queue based on a communication.
com.crm.dataobject.communications.CRMDOCommunicationQueue	loadByNumber(java.lang.String number, java.util.ArrayList<java.lang.String> associations) Loads a communication queue based on a number.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadPending(com.crm.dataobject.communications.CRMDOCommunicationQueueExternalSystem cQExtSys) Loads a list of pending communication queues by an external system.
com.crm.dataobject.communications.CRMDOCommunicationQueue	reject(com.crm.dataobject.communications.CRMDOCommunicationQueue communicationQueue, java.lang.String errorCode, java.lang.String errorDescription) Returns the rejected communication queue.

Methods inherited from class com.crm.businessobject.CRMBOConfigurationEntity

isDefault, loadDefault, setDefault

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

Constructor Detail

CRMBOCommunicationQueueBean

public CRMBOCommunicationQueueBean()

Default constructor.

Method Detail

getDefaultAssociations

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

Returns the default associated data objects of a communication queue.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the communication queue

loadPending

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadPending(com.crm.dataobject.communications.CRMDOCommunicationQueueExternalSystem cQExtSys)
                                                          throws java.lang.Exception

Loads a list of pending communication queues by an external system.

Parameters:

cQExtSys - - the external system to load the communication queues for

Returns:

a list of pending communication queues with the given external system

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.communications.CRMDOCommunicationQueueExternalSystem cQExtSys,
                                                 com.crm.dataobject.communications.CommunicationQueueLifeCycleState lifeCycleState)
                                                   throws java.lang.Exception

Loads a list of pending communication queues by an external system and life cycle state.

Parameters:

cQExtSys - - the external system to load the communication queues for

lifeCycleState - - the life cycle state to load by

Returns:

a list of pending communication queues with the given external system and life cycle state

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.communications.CRMDOCommunicationQueueExternalSystem cQExtSys,
                                                 com.crm.dataobject.communications.CommunicationMedia media,
                                                 com.crm.dataobject.contactinfo.CRMDOContactInformation contacInformation,
                                                 com.crm.dataobject.communications.CommunicationQueueLifeCycleState lifeCycleState,
                                                 java.util.ArrayList<java.lang.String> associations,
                                                 java.lang.String orderBy,
                                                 java.lang.Integer maxSize)
                                                   throws java.lang.Exception

Loads a list of communication queues by a number of criteria.

Parameters:

cQExtSys - - the external system to load by

media - - the media to load by

lifeCycleState - - the life cycle state to load by

associations - - a list of associated data objects

orderBy - - the order by field

maxSize - - the maximum amount of rows to return

Returns:

a list of communication queues with the given criteria

Throws:

java.lang.Exception

loadByNumber

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

Loads a communication queue based on a number.

Parameters:

value - - the communication queue number

associations - - a list of related communication queue's association objects

Returns:

the loaded communication queue

Throws:

java.lang.Exception

complete

public com.crm.dataobject.communications.CRMDOCommunicationQueue complete(com.crm.dataobject.communications.CRMDOCommunicationQueue communicationQueue)

Sets a communication queue as complete.

Parameters:

communicationQueue - - the communication queue to set as complete

Returns:

the completed communication queue

Throws:

java.lang.Exception

reject

public com.crm.dataobject.communications.CRMDOCommunicationQueue reject(com.crm.dataobject.communications.CRMDOCommunicationQueue communicationQueue,
                                                               java.lang.String errorCode,
                                                               java.lang.String errorDescription)

Returns the rejected communication queue.

Parameters:

communicationQueue - - the communication queue to be rejected

Returns:

the rejected communication queue

Throws:

java.lang.Exception

loadByCommunication

public com.crm.dataobject.communications.CRMDOCommunicationQueue loadByCommunication(com.crm.dataobject.communications.CRMDOCommunication communication)
                                                                              throws java.lang.Exception

Loads a communication queue based on a communication.

Parameters:

communication - - the communication queue communication

Returns:

the loaded communication queue

Throws:

java.lang.Exception

loadByCommunication

public com.crm.dataobject.communications.CRMDOCommunicationQueue loadByCommunication(com.crm.dataobject.communications.CRMDOCommunication communication,
                                                                            java.util.ArrayList<java.lang.String> associations)
                                                                              throws java.lang.Exception

Loads a communication queue based on a communication.

Parameters:

communication - - the communication queue communication

associations - - a list of related communication queue's association objects

Returns:

the loaded communication queue

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.billing.CRMDOBill bill)
                                                   throws java.lang.Exception

Loads a list of communication queues of the given bill.

Parameters:

bill - - the bill to load the communication queues

Returns:

a list of communication queues with the given bill

Throws:

java.lang.Exception