atg.svc.ui.formhandlers
Class UserChooserListFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.droplet.TransactionalFormHandler
                      atg.web.formhandlers.ApplicationFormHandler
                          atg.svc.ui.formhandlers.test.TreeTableDelegatingFormHandler
                              atg.svc.ui.formhandlers.ListChooserFormHandler
                                  atg.svc.ui.formhandlers.UserChooserListFormHandler

All Implemented Interfaces:

atg.droplet.DropletFormHandler, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, TreeTableFormHandler, Listable, Pageable, Selectable, java.util.EventListener

Direct Known Subclasses:

GroupUserChooserListFormHandler

public class UserChooserListFormHandler
extends ListChooserFormHandler
implements Pageable

Delegating form Handler for User List Chooser tree table component for extracting list of users (applying filtering by login name with filterKeyword property) and selecting users from this list. Requires initialization of:

• profile property with current user profile component,
• profileRepository property with profile repository component.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	IS_CURRENT_USER
protected atg.userprofiling.Profile	mProfile
protected java.util.List	mSearchResultItems
protected SolutionMetadataService	mSolutionMetadataService

Fields inherited from class atg.svc.ui.formhandlers.ListChooserFormHandler

CONSTRAINT_LANGUAGE, CONSTRAINT_SELFSERVICE_AUDIENCE, editorField, mAdminField, mBaseValue, mFilterKeyword, mItemKey, mRepository, mRepositoryView, mSegmentService, mSelectedKeys, mSolutionService, mViewItems, PROPERTY_DISPLAY_NAME, PROPERTY_REPOSITORY_ID, STATUS_FILTER_RQL, STATUS_VIEW

Fields inherited from class atg.svc.ui.formhandlers.test.TreeTableDelegatingFormHandler

mOperation, mParameters, mState, mTreeTableId, mView

Fields inherited from class atg.web.formhandlers.ApplicationFormHandler

EQUALS, PARAM_DELIMITER, QUERY_DELIMITER, STATUS_ERROR_REDIRECT, STATUS_ERROR_STAY, STATUS_SUCCESS

Fields inherited from class atg.droplet.GenericFormHandler

PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.svc.ui.treetable.Selectable

SELECT_MULTIPLE, SELECT_NONE, SELECT_SINGLE

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

UserChooserListFormHandler()

Method Summary

static void	addCurrentUser(java.util.List pUsers) Adds fake user with ID='%' to the collection of users Used to display "Current User" value in user constraint editors
java.lang.String	getAllRQLWhere() Overriden to get all users ordered by first name.
java.lang.String	getFilterRQLWhere() Overriden to filter by login name.
atg.userprofiling.Profile	getProfile()
atg.repository.Repository	getProfileRepository() Alias to ListChooserFormHandler.getRepository()
SolutionMetadataService	getSolutionMetadataService()
int	getTotalItemCount() Create collection of visible user list items.
java.util.List	getViewItems() Create collection of visible list items.
void	page(int pStartIndex, int pPageSize)
void	select(java.lang.Object pItemKey, java.lang.String pMode) Implementation of Selectable interface.
void	setProfile(atg.userprofiling.Profile pProfile)
void	setProfileRepository(atg.repository.Repository mProfileRepository) Alias to #setRepository()
void	setSolutionMetadataService(SolutionMetadataService pSolutionMetadataService)
protected java.util.List	uploadViewItems() Retrieve items from canned list, or from SegmentService specified, or from repository.
protected java.util.Map	wrapGSAUser(atg.adapter.gsa.GSAItem user)
protected java.util.List	wrapGSAUsers(java.util.List src) Wraps list of GSAItem users into list of UI-compatible maps

Methods inherited from class atg.svc.ui.formhandlers.ListChooserFormHandler

doStartService, fillSelectedFromState, filterListValues, findStateContainer, getAdminField, getBaseValue, getEditorConstraintType, getEditorField, getFilterKeyword, getItemKey, getItemName, getLanguageProperty, getLanguages, getRepository, getRepositoryView, getSegmentItems, getSegmentService, getSelectedItemsList, getSelectedKeys, getSelectedKeysList, getSiteService, getSolutionService, getViewItemCount, handleList, isStatusField, prepareSelectedList, resetListValue, saveStateContainer, setAdminField, setBaseValue, setEditorConstraintType, setEditorField, setFilterKeyword, setItemKey, setLanguageProperty, setRepository, setRepositoryView, setSegmentService, setSiteService, setSolutionService, setState, setViewItems, uploadRepositoryItems, wrapArray, wrapCollection, wrapProfileGroups, wrapSelfServiceAudienceCollection

Methods inherited from class atg.svc.ui.formhandlers.test.TreeTableDelegatingFormHandler

getOperation, getParameters, getState, getTreeTableId, getView, handleResponse, setOperation, setParameters, setTreeTableId, setView, validate

Methods inherited from class atg.web.formhandlers.ApplicationFormHandler

addParameterToURLString, beforeGet, beforeSet, checkFormError, checkFormRedirect, checkFormSuccess, formHandlerBeforeGet, formHandlerBeforeSet, formHandlerInit, getErrorURL, getRedirectDelayMS, getString, getString, getString, getSuccessURL, getUserMessagesResourceBundle, handleCancel, processException, processException, processExceptionAndLog, processExceptionAndLog, redirect, setErrorURL, setRedirectDelayMS, setSuccessURL, setUserMessagesResourceBundle

Methods inherited from class atg.droplet.TransactionalFormHandler

afterSet, commitTransaction, getTransactionDemarcation, getTransactionStatus, isEnsureTransaction, isRollbackTransaction, isRollbackTransactionOnUnhandledException, isTransactionMarkedAsRollback, setEnsureTransaction, setRollbackTransaction, setRollbackTransactionOnUnhandledException, setTransactionDemarcation

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

IS_CURRENT_USER

public static final java.lang.String IS_CURRENT_USER

See Also:

Constant Field Values

mProfile

protected atg.userprofiling.Profile mProfile

mSearchResultItems

protected java.util.List mSearchResultItems

mSolutionMetadataService

protected SolutionMetadataService mSolutionMetadataService

Constructor Detail

UserChooserListFormHandler

public UserChooserListFormHandler()

Method Detail

getProfile

public atg.userprofiling.Profile getProfile()

Returns:

Current user profile

setProfile

public void setProfile(atg.userprofiling.Profile pProfile)

Parameters:

mProfile - profile of currently logged in user

getProfileRepository

public atg.repository.Repository getProfileRepository()

Alias to ListChooserFormHandler.getRepository()

Returns:

configured repository

setProfileRepository

public void setProfileRepository(atg.repository.Repository mProfileRepository)

Alias to #setRepository()

uploadViewItems

protected java.util.List uploadViewItems()

Description copied from class: ListChooserFormHandler

Retrieve items from canned list, or from SegmentService specified, or from repository.

Overrides:

uploadViewItems in class ListChooserFormHandler

Returns:

wrapped list of users with current user item as the first element of the list.

setSolutionMetadataService

public void setSolutionMetadataService(SolutionMetadataService pSolutionMetadataService)

getSolutionMetadataService

public SolutionMetadataService getSolutionMetadataService()

select

public void select(java.lang.Object pItemKey,
                   java.lang.String pMode)

Description copied from class: ListChooserFormHandler

Implementation of Selectable interface. Called when user selects some new item. Add this new key to List of already selected.

Specified by:

select in interface Selectable

Overrides:

select in class ListChooserFormHandler

Parameters:

pItemKey - key of the newly selected item

getTotalItemCount

public int getTotalItemCount()

Create collection of visible user list items.

Specified by:

getTotalItemCount in interface Listable

Overrides:

getTotalItemCount in class ListChooserFormHandler

Returns:

created collection of user list items.

getViewItems

public java.util.List getViewItems()

Description copied from class: ListChooserFormHandler

Create collection of visible list items.

Specified by:

getViewItems in interface Listable

Overrides:

getViewItems in class ListChooserFormHandler

Returns:

created collection of list items.

page

public void page(int pStartIndex,
                 int pPageSize)

Specified by:

page in interface Pageable

getFilterRQLWhere

public java.lang.String getFilterRQLWhere()

Overriden to filter by login name.

Overrides:

getFilterRQLWhere in class ListChooserFormHandler

Returns:

RQL query

getAllRQLWhere

public java.lang.String getAllRQLWhere()

Overriden to get all users ordered by first name.

Overrides:

getAllRQLWhere in class ListChooserFormHandler

Returns:

RQL query

wrapGSAUsers

protected java.util.List wrapGSAUsers(java.util.List src)

Wraps list of GSAItem users into list of UI-compatible maps

Parameters:

src - source list, should contain GSAItem objects

Returns:

list of UI-compatible maps, keys are: repositoryId, login, firstName, lastName

wrapGSAUser

protected java.util.Map wrapGSAUser(atg.adapter.gsa.GSAItem user)

Parameters:

user - GSAItem user with following properties: login, firstName, lastName

Returns:

UI-compatible map, keys are: repositoryId, login, firstName, lastName

addCurrentUser

public static void addCurrentUser(java.util.List pUsers)

Adds fake user with ID='%' to the collection of users Used to display "Current User" value in user constraint editors

Parameters:

pUsers - collection to add user