com.crm.process.users

Class CRMUIUserBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.process.CRMUI

com.crm.process.users.CRMUIUserBean

All Implemented Interfaces:

java.io.Serializable

public class CRMUIUserBean
extends CRMUI

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMUIUserBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.ArrayList<com.crm.dataobject.CRMDO>	addUnitButton(com.crm.dataobject.users.CRMDOUser user, java.util.ArrayList<java.lang.String> unitIDs) Adds a list of units to a user.
com.crm.dataobject.users.CRMDOUser	changeDefaultUnit(com.crm.dataobject.users.CRMDOUser user, com.crm.dataobject.users.CRMDOUserUnit userUnit) Changes the default unit of a user.
com.crm.dataobject.users.CRMDOUser	createButton() Creates a user.
com.crm.dataobject.users.CRMDOUser	deleteButton(com.crm.dataobject.users.CRMDOUser user) Deletes a user.
com.crm.dataobject.users.CRMDOUser	editButton(com.crm.dataobject.users.CRMDOUser user) Loads a user form.
com.crm.dataobject.users.CRMDOUser	editPreferencesButton(com.crm.dataobject.users.CRMDOUser user)
com.crm.dataobject.users.CRMDOUser	initialize(com.crm.dataobject.users.CRMDOUser user, com.crm.dataobject.users.CRMDOUserTemplate userTemplate) Initialises a user from a user template.
com.crm.dataobject.users.CRMDOUser	loadForm(java.lang.String id) Loads a user form.
com.crm.dataobject.users.CRMDOUser	loadPreferencesForm() Loads the User preferences page.
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadUnitsTab(com.crm.dataobject.users.CRMDOUser user) Loads a list of units of a user.
UserSettingsForm	loadUserSettingsForm(java.util.ArrayList<java.lang.String> userIDs) Loads a user settings form.
UserStateForm	loadUserStateForm(java.util.ArrayList<java.lang.String> userIDs) Loads a user state form.
java.util.ArrayList<com.crm.dataobject.CRMDO>	removeUnitButton(java.util.ArrayList<com.crm.dataobject.CRMDO> dtoList) Removes a list of units from a user.
com.crm.dataobject.users.CRMDOUser	saveButton(com.crm.dataobject.users.CRMDOUser user) Saves a user.
com.crm.dataobject.users.CRMDOUser	savePreferencesButton(com.crm.dataobject.users.CRMDOUser user) Saves the user preferences.
java.lang.String	searchUsers(com.crm.dataobject.CRMDO mainDTO) Returns an SQL that returns the allowed users for a data object.
void	submitUserSettingsForm(UserSettingsForm userSettingsForm) Submits the user settings form.
void	submitUserStateForm(UserStateForm userStateForm) Submits the user state form.
com.crm.framework.util.ResultSetUtil	usersQuickSearch(com.crm.dataobject.CRMDO mainDTO, java.lang.String searchValue) Returns the allowed users based on a quick search value.

Methods inherited from class com.crm.process.CRMUI

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

Methods inherited from class com.crm.businessobject.CRMBase

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CRMUIUserBean

public CRMUIUserBean()

Default constructor.

Method Detail

createButton

public com.crm.dataobject.users.CRMDOUser createButton()
                                                throws java.lang.Exception

Creates a user.

Returns:

a user

Throws:

java.lang.Exception

saveButton

public com.crm.dataobject.users.CRMDOUser saveButton(com.crm.dataobject.users.CRMDOUser user)
                                              throws java.lang.Exception

Saves a user.

Parameters:

user - - the user to save

Returns:

the saved user

Throws:

java.lang.Exception

savePreferencesButton

public com.crm.dataobject.users.CRMDOUser savePreferencesButton(com.crm.dataobject.users.CRMDOUser user)
                                                         throws java.lang.Exception,
                                                                com.crm.exception.InvalidValueException

Saves the user preferences.

Parameters:

user - - the user to save the preferences for

Returns:

the updated user

Throws:

java.lang.Exception

com.crm.exception.InvalidValueException

editPreferencesButton

public com.crm.dataobject.users.CRMDOUser editPreferencesButton(com.crm.dataobject.users.CRMDOUser user)
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

editButton

public com.crm.dataobject.users.CRMDOUser editButton(com.crm.dataobject.users.CRMDOUser user)
                                              throws java.lang.Exception

Loads a user form.

Parameters:

user - - the user to load

Returns:

the loaded form

Throws:

java.lang.Exception

deleteButton

public com.crm.dataobject.users.CRMDOUser deleteButton(com.crm.dataobject.users.CRMDOUser user)
                                                throws java.lang.Exception

Deletes a user.

Parameters:

user - - the user to delete

Returns:

the deleted user

Throws:

java.lang.Exception

loadPreferencesForm

public com.crm.dataobject.users.CRMDOUser loadPreferencesForm()
                                                       throws java.lang.Exception

Loads the User preferences page.

Returns:

a User data object.

Throws:

java.lang.Exception

loadForm

public com.crm.dataobject.users.CRMDOUser loadForm(java.lang.String id)
                                            throws java.lang.Exception

Loads a user form.

Parameters:

user - - the user to load

Returns:

the loaded form

Throws:

java.lang.Exception

loadUserSettingsForm

public UserSettingsForm loadUserSettingsForm(java.util.ArrayList<java.lang.String> userIDs)
                                      throws java.lang.Exception,
                                             com.crm.exception.businessnetwork.SuperUserOperationException,
                                             com.crm.exception.AtLeastOneRecordException

Loads a user settings form.

Parameters:

userIDs - - a list of ids to load to the form

Returns:

the loaded form

Throws:

java.lang.Exception

com.crm.exception.businessnetwork.SuperUserOperationException

com.crm.exception.AtLeastOneRecordException

submitUserSettingsForm

public void submitUserSettingsForm(UserSettingsForm userSettingsForm)
                            throws java.lang.Exception

Submits the user settings form.

Parameters:

userSettingsForm - - the user settings form to submit

Throws:

java.lang.Exception

loadUserStateForm

public UserStateForm loadUserStateForm(java.util.ArrayList<java.lang.String> userIDs)
                                throws java.lang.Exception

Loads a user state form.

Parameters:

userIDs - - a list of ids to load to the form

Returns:

the loaded form

Throws:

java.lang.Exception

submitUserStateForm

public void submitUserStateForm(UserStateForm userStateForm)
                         throws java.lang.Exception

Submits the user state form.

Parameters:

userStateForm - - the user state form to submit

Throws:

java.lang.Exception

loadUnitsTab

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadUnitsTab(com.crm.dataobject.users.CRMDOUser user)
                                                           throws java.lang.Exception

Loads a list of units of a user.

Parameters:

user - - the user to load the units for

Returns:

a list of units of the given user

Throws:

java.lang.Exception

addUnitButton

public java.util.ArrayList<com.crm.dataobject.CRMDO> addUnitButton(com.crm.dataobject.users.CRMDOUser user,
                                                          java.util.ArrayList<java.lang.String> unitIDs)
                                                            throws java.lang.Exception

Adds a list of units to a user.

Parameters:

user - - the user to add the units to

unitIDs - - a list of units to add

Returns:

a list of units

Throws:

java.lang.Exception

removeUnitButton

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

Removes a list of units from a user.

Parameters:

dtoList - - a list of units to delete

Returns:

a list of deleted units

Throws:

java.lang.Exception

initialize

public com.crm.dataobject.users.CRMDOUser initialize(com.crm.dataobject.users.CRMDOUser user,
                                            com.crm.dataobject.users.CRMDOUserTemplate userTemplate)
                                              throws java.lang.Exception

Initialises a user from a user template.

Parameters:

user - - the user to initialise

userTemplate - - the user template to initialise from

Returns:

the updated user

Throws:

java.lang.Exception

changeDefaultUnit

public com.crm.dataobject.users.CRMDOUser changeDefaultUnit(com.crm.dataobject.users.CRMDOUser user,
                                                   com.crm.dataobject.users.CRMDOUserUnit userUnit)
                                                     throws java.lang.Exception

Changes the default unit of a user.

Parameters:

user - - the user to change the default unit to

userUnit - - the default unit to set

Returns:

the updated user

Throws:

java.lang.Exception

usersQuickSearch

public com.crm.framework.util.ResultSetUtil usersQuickSearch(com.crm.dataobject.CRMDO mainDTO,
                                                    java.lang.String searchValue)
                                                      throws java.lang.Exception

Returns the allowed users based on a quick search value.

Parameters:

mainDTO - - a data object to load the allowed users for

searchValue - - a quick search value

Returns:

the allowed users based on the given quick search value

Throws:

java.lang.Exception

searchUsers

public java.lang.String searchUsers(com.crm.dataobject.CRMDO mainDTO)
                             throws java.lang.Exception

Returns an SQL that returns the allowed users for a data object.

Parameters:

mainDTO - - a data object to load the allowed users for

Returns:

an SQL that returns the allowed users for a data object

Throws:

java.lang.Exception