com.crm.process.segments

Class CRMUISegmentBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.process.CRMUI

com.crm.process.segments.CRMUISegmentBean

All Implemented Interfaces:

java.io.Serializable

public class CRMUISegmentBean
extends CRMUI

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMUISegmentBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<com.crm.dataobject.CRMDO>	addExceptionalItemButton(com.crm.dataobject.segments.CRMDOSegment segment, java.util.ArrayList<java.lang.String> entityIDs, java.lang.String entityID) Adds an exceptional item to the segment.
com.crm.dataobject.segments.CRMDOSegment	createButton() Creates a segment.
com.crm.dataobject.segments.CRMDOSegment	deleteButton(com.crm.dataobject.segments.CRMDOSegment segment) Deletes a segment.
com.crm.dataobject.segments.CRMDOSegment	editButton(com.crm.dataobject.segments.CRMDOSegment segment) Loads a segment form.
com.crm.dataobject.segments.CRMDOSegment	exportButton(com.crm.dataobject.segments.CRMDOSegment segment) Creates a download link to export a segment.
com.crm.framework.main.LookupBuilder	getAccountReceivableSegmentOptions() Loads the segments of Accounts Receivable entity type.
com.crm.framework.main.LookupBuilder	getContactInformationSegmentOptions() Loads the segments of contact information entity type.
com.crm.framework.main.LookupBuilder	getEntityOptions(java.lang.String emptyValue) Loads the entity options.
com.crm.framework.main.LookupBuilder	getEntityTypeOptions() Loads the segment entity type options.
com.crm.framework.main.LookupBuilder	getLifeCycleStateOptions() Loads the segment life cycle state options.
com.crm.framework.main.LookupBuilder	getLifeCycleStateOptions(java.lang.String emptyValue) Loads the segment life cycle state options.
com.crm.framework.main.LookupBuilder	getRewardParticipantSegmentOptions() Loads the segments of Rewards Participant entity type.
com.crm.framework.main.LookupBuilder	getRewardParticipantSegmentOptions(java.lang.String lifeCycleState)
com.crm.framework.main.LookupBuilder	getSegmentOptions(java.lang.String segmentEntityType) Loads the segment entity type options.
com.crm.framework.main.LookupBuilder	getSegmentOptions(java.lang.String segmentEntityType, com.crm.dataobject.segments.SegmentLifeCycleState segmentLifeCycleState)
com.crm.framework.main.LookupBuilder	getSubscriptionSegmentOptions() Loads the segments of subscription entity type.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadExceptionalItemsTab(com.crm.dataobject.segments.CRMDOSegment segment) Loads the exceptional items of a segment.
com.crm.dataobject.segments.CRMDOSegment	loadExportForm(com.crm.dataobject.segments.CRMDOSegment segment) Loads an export form.
com.crm.dataobject.segments.CRMDOSegment	loadForm(java.lang.String id) Loads a segment form.
com.crm.dataobject.segments.CRMDOSegment	loadPreviewForm(com.crm.dataobject.segments.CRMDOSegment segment) Loads a preview form.
java.util.ArrayList<java.lang.Object>	previewSegment(java.util.ArrayList<java.lang.Object> parameterList) Returns a query to preview a segment.
java.util.ArrayList<com.crm.dataobject.CRMDO>	removeAllExceptionalItems(java.util.ArrayList<com.crm.dataobject.CRMDO> dtoList) Removes all the exceptional items from the segment.
java.util.ArrayList<com.crm.dataobject.CRMDO>	removeExceptionalItemButton(java.util.ArrayList<com.crm.dataobject.CRMDO> dtoList) Removes a list of exceptional items from the segment.
com.crm.dataobject.segments.CRMDOSegment	saveAsDraftButton(com.crm.dataobject.segments.CRMDOSegment segment) Saves a segment with draft life cycle state.
com.crm.dataobject.segments.CRMDOSegment	saveButton(com.crm.dataobject.segments.CRMDOSegment segment) Saves and posts a segment.

Methods inherited from class com.crm.process.CRMUI

addAttachmentButton, addTrace, assignEntity, echoDto, echoDto, echoDto, echoDtos, getAccountsReceivableEntityOptions, getActiveInactiveOptions, getActiveInactiveOptions, getAllowedDeniedOptions, getAllowedDeniedOptions, getApplicationOptions, getArchiveDataEntityOptions, getArchiveDataEntityOptions, getArchiveEntityOptions, getArchiveEntityOptions, getAssignableEntityOptions, getCurrentDateString, getCurrentDay, getCurrentMonth, getCurrentYear, getDayOfWeekOptions, getDayOfWeekOptions, getDtoFromCollection, getEntityCategoryOptions, getEntityFieldOptions, getEntityOptions, getEntityStateOptions, getEntityStatusOptions, getEntityTypeOptions, getExplicitViewingAccessEntityOptions, getHourOptions, getHourOptions, getImplicitViewingAccessEntityOptions, getModuleOptions, getModulePrintoutOptions, getModuleProcessOptions, getMonthEndDate, getMonthStartDate, getOperatorOptions, getOperatorOptions, getStateOptions, getStringFormattingOptions, getStringFormattingOptions, getTimeOfDayOptions, getTimeOfDayOptions, getTrueFalseOptions, getTrueFalseOptions, getUnitOfTimeOptions, getUnitOfTimeOptions, getWeekEndDate, getWeekStartDate, getYesNoOptions, getYesNoOptions, invoke, load, loadAchivedData, loadAttachmentsTab, loadDaysOfMonthOptions, loadMonthNumberOptions, loadMonthNumberOptions, loadMonthOptions, loadMonthOptions, readFileContent, removeAttachmentButton, setDtoAsNotEditable, setMandatoryField, setMandatoryFields, setOwnerGroup

Methods inherited from class com.crm.businessobject.CRMBase

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CRMUISegmentBean

public CRMUISegmentBean()

Default constructor.

Method Detail

loadForm

public com.crm.dataobject.segments.CRMDOSegment loadForm(java.lang.String id)
                                                  throws java.lang.Exception

Loads a segment form.

Parameters:

id - - the segment id to load

Returns:

the loaded form

Throws:

java.lang.Exception

createButton

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

Creates a segment.

Returns:

a segment

Throws:

java.lang.Exception

saveButton

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

Saves and posts a segment.

Parameters:

segment - - the segment to save and post

Returns:

the saved segment

Throws:

java.lang.Exception

saveAsDraftButton

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

Saves a segment with draft life cycle state.

Parameters:

segment - - the segment to save

Returns:

the saved segment

Throws:

java.lang.Exception

editButton

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

Loads a segment form.

Parameters:

segment - - the segment to load

Returns:

the loaded form

Throws:

java.lang.Exception

deleteButton

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

Deletes a segment.

Parameters:

segment - - the segment to delete

Returns:

the deleted segment

Throws:

java.lang.Exception

loadExceptionalItemsTab

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadExceptionalItemsTab(com.crm.dataobject.segments.CRMDOSegment segment)
                                                                      throws java.lang.Exception

Loads the exceptional items of a segment.

Parameters:

segment - - the segment to load the exceptional items from

Returns:

a list of exceptional items of the given segment

Throws:

java.lang.Exception

addExceptionalItemButton

public java.util.ArrayList<com.crm.dataobject.CRMDO> addExceptionalItemButton(com.crm.dataobject.segments.CRMDOSegment segment,
                                                                              java.util.ArrayList<java.lang.String> entityIDs,
                                                                              java.lang.String entityID)
                                                                       throws java.lang.Exception

Adds an exceptional item to the segment.

Parameters:

segment - - the segment to add the exceptional item to

entityIDs - - a list of segment exceptional item IDs to add

entityID - - the entity type of the segment

Returns:

a list of segment exceptional items

Throws:

java.lang.Exception

removeExceptionalItemButton

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

Removes a list of exceptional items from the segment.

Parameters:

dtoList - - a list of exceptional items to delete

Returns:

the updated list

Throws:

java.lang.Exception

removeAllExceptionalItems

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

Removes all the exceptional items from the segment.

Parameters:

dtoList - - a list of exceptional items to delete

Returns:

the updated list

Throws:

java.lang.Exception

getLifeCycleStateOptions

public com.crm.framework.main.LookupBuilder getLifeCycleStateOptions()
                                                              throws java.lang.Exception

Loads the segment life cycle state options.

Returns:

the life cycle state options

Throws:

java.lang.Exception

getLifeCycleStateOptions

public com.crm.framework.main.LookupBuilder getLifeCycleStateOptions(java.lang.String emptyValue)
                                                              throws java.lang.Exception

Loads the segment life cycle state options.

Parameters:

emptyValue - - an empty value for a segment

Returns:

the life cycle state options

Throws:

java.lang.Exception

getEntityTypeOptions

public com.crm.framework.main.LookupBuilder getEntityTypeOptions()
                                                          throws java.lang.Exception

Loads the segment entity type options.

Returns:

the segment entity type options

Throws:

java.lang.Exception

getSubscriptionSegmentOptions

public com.crm.framework.main.LookupBuilder getSubscriptionSegmentOptions()
                                                                   throws java.lang.Exception

Loads the segments of subscription entity type.

Returns:

the segments of subscription entity type

Throws:

java.lang.Exception

getAccountReceivableSegmentOptions

public com.crm.framework.main.LookupBuilder getAccountReceivableSegmentOptions()
                                                                        throws java.lang.Exception

Loads the segments of Accounts Receivable entity type.

Returns:

the segments of Accounts Receivable entity type

Throws:

java.lang.Exception

getContactInformationSegmentOptions

public com.crm.framework.main.LookupBuilder getContactInformationSegmentOptions()
                                                                         throws java.lang.Exception

Loads the segments of contact information entity type.

Returns:

the segments of contact information entity type

Throws:

java.lang.Exception

getRewardParticipantSegmentOptions

public com.crm.framework.main.LookupBuilder getRewardParticipantSegmentOptions()
                                                                        throws java.lang.Exception

Loads the segments of Rewards Participant entity type.

Returns:

the segments of contact information entity type

Throws:

java.lang.Exception

getRewardParticipantSegmentOptions

public com.crm.framework.main.LookupBuilder getRewardParticipantSegmentOptions(java.lang.String lifeCycleState)
                                                                        throws java.lang.Exception

Throws:

java.lang.Exception

getSegmentOptions

public com.crm.framework.main.LookupBuilder getSegmentOptions(java.lang.String segmentEntityType)
                                                       throws java.lang.Exception

Loads the segment entity type options.

Parameters:

segmentEntityType - - an empty value for an entity type

Returns:

the segment entity type options

Throws:

java.lang.Exception

getSegmentOptions

public com.crm.framework.main.LookupBuilder getSegmentOptions(java.lang.String segmentEntityType,
                                                              com.crm.dataobject.segments.SegmentLifeCycleState segmentLifeCycleState)
                                                       throws java.lang.Exception

Throws:

java.lang.Exception

loadPreviewForm

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

Loads a preview form.

Parameters:

segment - - the segment to validate

Returns:

the validated segment

Throws:

java.lang.Exception

loadExportForm

public com.crm.dataobject.segments.CRMDOSegment loadExportForm(com.crm.dataobject.segments.CRMDOSegment segment)

Loads an export form.

Parameters:

segment - - the segment to load

Returns:

the loaded segment

previewSegment

public java.util.ArrayList<java.lang.Object> previewSegment(java.util.ArrayList<java.lang.Object> parameterList)
                                                     throws java.lang.Exception

Returns a query to preview a segment.

Parameters:

parameterList - - a list of parameters to retrieve the segment from

Returns:

the query to preview a segment

Throws:

java.lang.Exception

getEntityOptions

public com.crm.framework.main.LookupBuilder getEntityOptions(java.lang.String emptyValue)
                                                      throws java.lang.Exception

Loads the entity options.

Parameters:

emptyValue - - an empty value for an entity

Returns:

the entity options

Throws:

java.lang.Exception

exportButton

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

Creates a download link to export a segment.

Parameters:

segment - - the segment to export

Returns:

the download link to export a segment

Throws:

java.lang.Exception