atg.svc.ui.formhandlers
Class AgentUserChooserFormHandler

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.OrgChooserFormHandler
                                      atg.svc.ui.formhandlers.AgentUserChooserFormHandler

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, Expandable, Listable, PartialSelectable, Selectable, java.util.EventListener

public class AgentUserChooserFormHandler
extends OrgChooserFormHandler
implements PartialSelectable

Use in Agent Chooser TreeTable component as data retrieval, tree expansion, selection by delegating. Requires profileRepository property setting into /atg/userprofiling/ProfileAdapterRepository value and retrieves data from it. Allows displaying organization tree along with members of the selected organization.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected static java.util.Comparator	userSortInstance

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

mBaseExpValue, mExpanded, mProfileRepository, ORG_ROOT, ORGANIZATION_VIEW

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

AgentUserChooserFormHandler()

Method Summary

boolean	getItemHasChildren(java.lang.Object pItem) Implementation of Expandable interface.
static java.util.Comparator	getLoginComparatorInstance()
protected java.util.List	getOrgUsers(java.lang.String pParentOrg, java.lang.String pUserType)
protected java.lang.String	getParentGroupRqlWhere()
java.util.List	getSubOrganizations(java.lang.String pItemKey) Overriden to add organization's 'members' (users) with filtering by user type if necessary.
java.lang.String	getUserType() Returns agent user type value for users in list
protected java.lang.String	getUserTypeWhere()
boolean	isIncludeCurrent() whether include current user in list or not
boolean	isSelectable(java.lang.Object pItemKey)
void	setIncludeCurrent(boolean pIncludeCurrent) Sets whether include current user in list or not
void	setUserType(java.lang.String pUserType) Sets agent user type value for users in list
protected void	sortBranch(java.util.List result) Orders provided organization list according to its names.

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

expand, getBaseExpValue, getExpandedKeysList, getItemDepth, getProfileRepository, getTotalItemCount, getViewItemCount, getViewItems, resetListValue, setBaseExpValue, setProfileRepository, setState

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

doStartService, fillSelectedFromState, filterListValues, findStateContainer, getAdminField, getAllRQLWhere, getBaseValue, getEditorConstraintType, getEditorField, getFilterKeyword, getFilterRQLWhere, getItemKey, getItemName, getLanguageProperty, getLanguages, getRepository, getRepositoryView, getSegmentItems, getSegmentService, getSelectedItemsList, getSelectedKeys, getSelectedKeysList, getSiteService, getSolutionService, handleList, isStatusField, prepareSelectedList, saveStateContainer, select, setAdminField, setBaseValue, setEditorConstraintType, setEditorField, setFilterKeyword, setItemKey, setLanguageProperty, setRepository, setRepositoryView, setSegmentService, setSiteService, setSolutionService, setViewItems, uploadRepositoryItems, uploadViewItems, 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

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

select

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

userSortInstance

protected static java.util.Comparator userSortInstance

Constructor Detail

AgentUserChooserFormHandler

public AgentUserChooserFormHandler()

Method Detail

getLoginComparatorInstance

public static java.util.Comparator getLoginComparatorInstance()

getUserType

public java.lang.String getUserType()

Returns agent user type value for users in list

Returns:

parent group id for users in list

setUserType

public void setUserType(java.lang.String pUserType)

Sets agent user type value for users in list

Parameters:

pUserType -

isIncludeCurrent

public boolean isIncludeCurrent()

whether include current user in list or not

Returns:

parent group id for users in list

setIncludeCurrent

public void setIncludeCurrent(boolean pIncludeCurrent)

Sets whether include current user in list or not

Parameters:

pIncludeCurrent -

getSubOrganizations

public java.util.List getSubOrganizations(java.lang.String pItemKey)

Overriden to add organization's 'members' (users) with filtering by user type if necessary.

Overrides:

getSubOrganizations in class OrgChooserFormHandler

Parameters:

pItemKey -

Returns:

list of sub orgs

getItemHasChildren

public boolean getItemHasChildren(java.lang.Object pItem)

Description copied from class: OrgChooserFormHandler

Implementation of Expandable interface.

Specified by:

getItemHasChildren in interface Expandable

Overrides:

getItemHasChildren in class OrgChooserFormHandler

Parameters:

pItem - Item object of "items" collection of tree table.

Returns:

true if organization has suborganizations; false otherwise.

isSelectable

public boolean isSelectable(java.lang.Object pItemKey)

Specified by:

isSelectable in interface PartialSelectable

Parameters:

pItemKey - item key

Returns:

false for items that shouldn't be selected, like organizations in user chooser

sortBranch

protected void sortBranch(java.util.List result)

Description copied from class: OrgChooserFormHandler

Orders provided organization list according to its names.

Overrides:

sortBranch in class OrgChooserFormHandler

getOrgUsers

protected java.util.List getOrgUsers(java.lang.String pParentOrg,
                                     java.lang.String pUserType)
                              throws atg.repository.RepositoryException

Throws:

atg.repository.RepositoryException

getParentGroupRqlWhere

protected java.lang.String getParentGroupRqlWhere()

getUserTypeWhere

protected java.lang.String getUserTypeWhere()