com.crm.businessobject.segments

Class CRMBOSegmentBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.segments.CRMBOSegmentBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOSegmentBean
extends CRMBO

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOSegmentBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a segment.
com.crm.framework.ql.TranslatedQuery	getQuery(com.crm.dataobject.segments.CRMDOSegment segment, java.lang.Boolean selectPrimaryKeyOnly) Creates a query from the segment.
com.crm.framework.ql.TranslatedQuery	getQuery(com.crm.dataobject.segments.CRMDOSegment segment, java.lang.Boolean selectPrimaryKeyOnly, java.lang.Boolean preview) Creates a query from the segment.
java.lang.Boolean	isInSegment(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable, com.crm.dataobject.segments.CRMDOSegment segment) Return a boolean indicates if the Accounts Receivable is in the segment
java.lang.Boolean	isInSegment(com.crm.dataobject.CRMDO crmdo, com.crm.dataobject.segments.CRMDOSegment segment) Return a boolean indicates if the object is in the segment
java.lang.Boolean	isUsedByEffectiveProcess(com.crm.dataobject.segments.CRMDOSegment segment) Checks if the segment is used by a effective process.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadAccountReceivableSegments() Loads the segments of Accounts Receivable entity type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadBillSegments() Loads all the segments of Bill entity type .
com.crm.dataobject.segments.CRMDOSegment	loadByAltCode(java.lang.String value, java.util.ArrayList<java.lang.String> associations) Loads a segment based on an alternative code.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadByEntity(java.lang.Integer numberOfResults, java.lang.Integer offset, java.lang.String entityType, java.util.ArrayList<java.lang.String> associations) Loads a list of segments that are of the given entity type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadByEntity(java.lang.Integer numberOfResults, java.lang.Integer offset, java.lang.String entityType, java.util.ArrayList<java.lang.String> associations, java.lang.String orderBy) Loads a list of segments that are of the given entity type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadByEntity(java.lang.String entityType, java.util.ArrayList<java.lang.String> associations) Loads a list of segments that are of the given entity type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadByEntity(java.lang.String entityType, java.util.ArrayList<java.lang.String> associations, java.lang.String orderBy) Loads a list of segments that are of the given entity type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadByEntity(java.lang.String entityType, com.crm.dataobject.segments.SegmentLifeCycleState lifeCycleState, java.util.ArrayList<java.lang.String> associations, java.lang.String orderBy)
com.crm.dataobject.segments.CRMDOSegment	loadByNumber(java.lang.String value, java.util.ArrayList<java.lang.String> associations) Loads a segment based on a number.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadContactInformationSegments() Loads the segments of contact information entity type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadSubscriptionSegments() Loads the segments of subscription entity type.
com.crm.dataobject.segments.CRMDOSegment	post(com.crm.dataobject.segments.CRMDOSegment segment) Posts a segment.
void	validateEntity(com.crm.dataobject.segments.CRMDOSegment segment) Validates that the entity type of a posted segment cannot change.
void	validateQuery(com.crm.dataobject.segments.CRMDOSegment segment) Validates the segment's query.

Methods inherited from class com.crm.businessobject.CRMBO

construct, construct, construct, construct, construct, construct, construct, construct, construct, createAndUpdate, delete, delete, delete, getDOName, getDOName, getNextSequenceNumber, getNextSequenceNumber, getNumberScheme, isAssignable, load, load, load, load, load, load, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, loadAllEntityStatusDO, loadAllEntityStatusDO, loadDataObject, loadDataObject, loadDataObject, loadDataObjects, loadDataObjects, loadEntityCategoryDO, loadEntityCategoryDO, loadEntityDO, loadEntityDO, loadEntityStatusDO, loadEntityStatusDO, parseAssociations, parseAssociations, parseAssociations, save, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateApprovalRequestEntity, validateFormatSettings, validateFormatSettings, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave, validateOnSave

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

Constructor Detail

CRMBOSegmentBean

public CRMBOSegmentBean()

Default constructor.

Method Detail

post

public com.crm.dataobject.segments.CRMDOSegment post(com.crm.dataobject.segments.CRMDOSegment segment)
                                              throws java.lang.Exception

Posts a segment.
- Changes the life cycle state of a segment from draft to posted

Parameters:

segment - - the segment to post

Returns:

the posted segment

Throws:

java.lang.Exception

validateEntity

public void validateEntity(com.crm.dataobject.segments.CRMDOSegment segment)
                    throws java.lang.Exception,
                           com.crm.exception.CannotModifyException

Validates that the entity type of a posted segment cannot change.

Parameters:

segment - - the segment to be validated

Throws:

java.lang.Exception

com.crm.exception.CannotModifyException

isUsedByEffectiveProcess

public java.lang.Boolean isUsedByEffectiveProcess(com.crm.dataobject.segments.CRMDOSegment segment)
                                           throws java.lang.Exception

Checks if the segment is used by a effective process.

Parameters:

segment - - the segment to check

Returns:

true if the segment is used by a effective process, false if not

Throws:

java.lang.Exception

getDefaultAssociations

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

Returns the default associated data objects of a segment.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the segment

loadByNumber

public com.crm.dataobject.segments.CRMDOSegment loadByNumber(java.lang.String value,
                                                             java.util.ArrayList<java.lang.String> associations)
                                                      throws java.lang.Exception

Loads a segment based on a number.

Parameters:

value - - the segment number

associations - - a list of related segment's association objects

Returns:

the loaded segment

Throws:

java.lang.Exception

loadByEntity

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadByEntity(java.lang.String entityType,
                                                                  java.util.ArrayList<java.lang.String> associations)
                                                           throws java.lang.Exception

Loads a list of segments that are of the given entity type.

Parameters:

entityType - - the entity type of the segments to be loaded

associations - - a list of related segment's association objects

Returns:

the list of the loaded segments

Throws:

java.lang.Exception

loadByEntity

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadByEntity(java.lang.Integer numberOfResults,
                                                                  java.lang.Integer offset,
                                                                  java.lang.String entityType,
                                                                  java.util.ArrayList<java.lang.String> associations)
                                                           throws java.lang.Exception

Loads a list of segments that are of the given entity type.

Parameters:

numberOfResults - - The number of results that can be retrieved

offset - - It defines the number of entities that should be skipped from the results

entityType - - the entity type of the segments to be loaded

associations - - a list of related segment's association objects

Returns:

the list of the loaded segments

Throws:

java.lang.Exception

loadSubscriptionSegments

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

Loads the segments of subscription entity type.

Returns:

the segments of subscription entity type

Throws:

java.lang.Exception

loadAccountReceivableSegments

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

Loads the segments of Accounts Receivable entity type.

Returns:

the segments of Accounts Receivable entity type

Throws:

java.lang.Exception

loadContactInformationSegments

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

Loads the segments of contact information entity type.

Returns:

the segments of contact information entity type

Throws:

java.lang.Exception

loadBillSegments

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

Loads all the segments of Bill entity type .

Returns:

the segment entity type options

Throws:

java.lang.Exception

loadByEntity

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadByEntity(java.lang.String entityType,
                                                                  java.util.ArrayList<java.lang.String> associations,
                                                                  java.lang.String orderBy)
                                                           throws java.lang.Exception

Loads a list of segments that are of the given entity type.

Parameters:

entityType - - the entity type of the segments to be loaded

associations - - a list of related segment's association objects

orderBy - - the field that the list of the loaded segments is going to be ordered by

Returns:

the list of the loaded segments

Throws:

java.lang.Exception

loadByEntity

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadByEntity(java.lang.Integer numberOfResults,
                                                                  java.lang.Integer offset,
                                                                  java.lang.String entityType,
                                                                  java.util.ArrayList<java.lang.String> associations,
                                                                  java.lang.String orderBy)
                                                           throws java.lang.Exception

Loads a list of segments that are of the given entity type.

Parameters:

numberOfResults - - The number of results that can be retrieved

offset - - It defines the number of entities that should be skipped from the results

entityType - - the entity type of the segments to be loaded

associations - - a list of related segment's association objects

orderBy - - the field that the list of the loaded segments is going to be ordered by

Returns:

the list of the loaded segments

Throws:

java.lang.Exception

loadByEntity

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadByEntity(java.lang.String entityType,
                                                                  com.crm.dataobject.segments.SegmentLifeCycleState lifeCycleState,
                                                                  java.util.ArrayList<java.lang.String> associations,
                                                                  java.lang.String orderBy)
                                                           throws java.lang.Exception

Throws:

java.lang.Exception

getQuery

public com.crm.framework.ql.TranslatedQuery getQuery(com.crm.dataobject.segments.CRMDOSegment segment,
                                                     java.lang.Boolean selectPrimaryKeyOnly)
                                              throws java.lang.Exception

Creates a query from the segment.

Parameters:

segment - - the segment data object

selectPrimaryKeyOnly - indicates if the query should return only the primary key of the segment's entity

Returns:

an object containing the translated query

Throws:

java.lang.Exception

getQuery

public com.crm.framework.ql.TranslatedQuery getQuery(com.crm.dataobject.segments.CRMDOSegment segment,
                                                     java.lang.Boolean selectPrimaryKeyOnly,
                                                     java.lang.Boolean preview)
                                              throws java.lang.Exception

Creates a query from the segment.

Parameters:

segment - - the segment data object

selectPrimaryKeyOnly - indicates if the query should return only the primary key of the segment's entity

preview - indicates if the query will be create for preview the segment

Returns:

an object containing the translated query

Throws:

java.lang.Exception

validateQuery

public void validateQuery(com.crm.dataobject.segments.CRMDOSegment segment)
                   throws java.lang.Exception,
                          com.crm.exception.InvalidValueException

Validates the segment's query.

Parameters:

segment - - the segment data object

Throws:

java.lang.Exception

com.crm.exception.InvalidValueException

loadByAltCode

public com.crm.dataobject.segments.CRMDOSegment loadByAltCode(java.lang.String value,
                                                              java.util.ArrayList<java.lang.String> associations)
                                                       throws java.lang.Exception

Loads a segment based on an alternative code.

Parameters:

value - - the segment alternative code

associations - - a list of related segment's association objects

Returns:

the loaded segment

Throws:

java.lang.Exception

isInSegment

public java.lang.Boolean isInSegment(com.crm.dataobject.accounts.CRMDOAccountReceivable accountReceivable,
                                     com.crm.dataobject.segments.CRMDOSegment segment)
                              throws java.lang.Exception

Return a boolean indicates if the Accounts Receivable is in the segment

Parameters:

accountReceivable - - the Accounts Receivable to check if is included in the segment

segment - - the segment to check if the Accounts Receivable is in included in

Returns:

true if the Accounts Receivable is in the segment false otherwise

Throws:

java.lang.Exception

isInSegment

public java.lang.Boolean isInSegment(com.crm.dataobject.CRMDO crmdo,
                                     com.crm.dataobject.segments.CRMDOSegment segment)
                              throws java.lang.Exception

Return a boolean indicates if the object is in the segment

Parameters:

crmdo - - the object to check if is included in the segment

segment - - the segment to check if the object is in included in

Returns:

true if the object is in the segment false otherwise

Throws:

java.lang.Exception