atg.svc.ui.formhandlers
Class OrgChooserFormHandler

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

All Implemented Interfaces:

atg.droplet.DropletFormHandler, atg.naming.AbsoluteNameable, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameContextParentable, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.Configured, 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, Selectable, java.util.EventListener

Direct Known Subclasses:

AgentUserChooserFormHandler, OrgChooserNoDeleteFormHandler, UserChooserFormHandler

public class OrgChooserFormHandler
extends ListChooserFormHandler
implements Expandable

Use in Organization Groups 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.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected java.lang.String	mBaseExpValue
protected java.util.List	mExpanded List of expanded organizations in the tree table displayed.
protected FavoriteQueryService	mFavoriteQueryService
protected atg.repository.Repository	mProfileRepository
static java.lang.String	ORG_ROOT root organization
static java.lang.String	ORGANIZATION_VIEW Name of repository view to get organization items from.
static java.lang.String	TREE_TABLE_ID_INT_AUDIENCE id of tree table used to display internal audience in the Query Builder
static java.lang.String	TREE_TABLE_ID_OWN_GROUP id of tree table used to display organizations in the Query Builder

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

OrgChooserFormHandler()

Method Summary

java.util.Collection	expand(java.lang.Object pItemKey) Implementation of Expandable interface.
java.lang.String	getBaseExpValue() Semicolon-separated list of item repository Ids that are initially expanded
java.util.List	getExpandedKeysList()
FavoriteQueryService	getFavoriteQueryService()
int	getItemDepth(java.lang.Object pItem) Implementation of Expandable interface.
boolean	getItemHasChildren(java.lang.Object pItem) Implementation of Expandable interface.
java.util.List	getOwnGroupsOrIntAudiences()
atg.repository.Repository	getProfileRepository()
java.util.List	getSubOrganizations(java.lang.String pItemKey)
int	getTotalItemCount() Same as ListChooserFormHandler.getTotalItemCount().
int	getViewItemCount() Same as getTotalItemCount().
java.util.List	getViewItems() Create collection of visible organization items.
boolean	isPublicFavoriteQueryOrgChooser() Is the OrgChooserFormHandler being used to pick organizations for public favorite queries? If true, checks that the user has permission to publish the favorite query.
protected void	resetListValue(atg.servlet.DynamoHttpServletRequest pRequest) Called on reset and refresh operations Cleans up the selection and initializes selected keys from the base value
void	setBaseExpValue(java.lang.String pBaseExpValue) initially expanded items (saved in DB)
void	setFavoriteQueryService(FavoriteQueryService pFavoriteQueryService)
void	setProfileRepository(atg.repository.Repository profileRepository) Repository of organizations to take data from.
void	setPublicFavoriteQueryOrgChooser(boolean pPublicFavoriteQueryOrgChooser) Is the OrgChooserFormHandler being used to pick organizations for public favorite queries? If true, checks that the user has permission to publish the favorite query.
void	setState(java.lang.String pState) Remember treetable state, remember keys of already expanded items in the List.
protected void	sortBranch(java.util.List result) Orders provided organization list according to its names.

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

doStartService, fillSelectedFromState, filterListValues, findStateContainer, getAdminField, getAllRQLWhere, getBaseValue, getEditorConstraintType, getEditorField, getFilterKeyword, getFilterRQLWhere, getItemKey, getItemName, getLanguageProperty, getLanguages, getOptionService, getRepository, getRepositoryView, getSegmentItems, getSegmentService, getSelectedItemsList, getSelectedKeys, getSelectedKeysList, getSolutionService, handleList, isStatusField, prepareSelectedList, saveStateContainer, select, setAdminField, setBaseValue, setEditorConstraintType, setEditorField, setFilterKeyword, setItemKey, setLanguageProperty, setOptionService, setRepository, setRepositoryView, setSegmentService, 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, getDefaultLocale, getErrorURL, getRedirectDelayMS, getString, getString, getString, getSuccessURL, getUserLocale, getUserMessagesResourceBundle, handleCancel, isUseRequestLocale, processException, processException, processExceptionAndLog, processExceptionAndLog, redirect, setDefaultLocale, setErrorURL, setRedirectDelayMS, setSuccessURL, setUseRequestLocale, 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, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, 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

ORGANIZATION_VIEW

public static final java.lang.String ORGANIZATION_VIEW

Name of repository view to get organization items from.

See Also:

Constant Field Values

TREE_TABLE_ID_OWN_GROUP

public static final java.lang.String TREE_TABLE_ID_OWN_GROUP

id of tree table used to display organizations in the Query Builder

See Also:

Constant Field Values

TREE_TABLE_ID_INT_AUDIENCE

public static final java.lang.String TREE_TABLE_ID_INT_AUDIENCE

id of tree table used to display internal audience in the Query Builder

See Also:

Constant Field Values

ORG_ROOT

public static final java.lang.String ORG_ROOT

root organization

See Also:

Constant Field Values

mExpanded

protected java.util.List mExpanded

List of expanded organizations in the tree table displayed.

mBaseExpValue

protected java.lang.String mBaseExpValue

mProfileRepository

protected atg.repository.Repository mProfileRepository

mFavoriteQueryService

protected FavoriteQueryService mFavoriteQueryService

Constructor Detail

OrgChooserFormHandler

public OrgChooserFormHandler()

Method Detail

getExpandedKeysList

public java.util.List getExpandedKeysList()

Returns:

keys of all expanded items to allow iteration.

getBaseExpValue

public java.lang.String getBaseExpValue()

Semicolon-separated list of item repository Ids that are initially expanded

setBaseExpValue

public void setBaseExpValue(java.lang.String pBaseExpValue)

initially expanded items (saved in DB)

Parameters:

pBaseExpValue - Semicolon-separated list of item repository Ids

getProfileRepository

public atg.repository.Repository getProfileRepository()

Returns:

Repository of profiles to show organizations from it.

setProfileRepository

public void setProfileRepository(atg.repository.Repository profileRepository)

Repository of organizations to take data from.

getFavoriteQueryService

public FavoriteQueryService getFavoriteQueryService()

See Also:

FavoriteQueryService

setFavoriteQueryService

public void setFavoriteQueryService(FavoriteQueryService pFavoriteQueryService)

See Also:

FavoriteQueryService

isPublicFavoriteQueryOrgChooser

public boolean isPublicFavoriteQueryOrgChooser()

Is the OrgChooserFormHandler being used to pick organizations for public favorite queries? If true, checks that the user has permission to publish the favorite query.

setPublicFavoriteQueryOrgChooser

public void setPublicFavoriteQueryOrgChooser(boolean pPublicFavoriteQueryOrgChooser)

Is the OrgChooserFormHandler being used to pick organizations for public favorite queries? If true, checks that the user has permission to publish the favorite query.

setState

public void setState(java.lang.String pState)

Remember treetable state, remember keys of already expanded items in the List. This expanded list will be used to re-construct whole viewItems collection.

Specified by:

setState in interface TreeTableFormHandler

Overrides:

setState in class ListChooserFormHandler

Parameters:

pState - serialized string for TreeTable component state stored on client

resetListValue

protected void resetListValue(atg.servlet.DynamoHttpServletRequest pRequest)

Description copied from class: ListChooserFormHandler

Called on reset and refresh operations Cleans up the selection and initializes selected keys from the base value

Overrides:

resetListValue in class ListChooserFormHandler

expand

public java.util.Collection expand(java.lang.Object pItemKey)

Implementation of Expandable interface. Called when user expanded some new item. Add this new key to List of already expanded.

Specified by:

expand in interface Expandable

Parameters:

pItemKey - key of the newly expanded item

Returns:

children of expanded items

getItemDepth

public int getItemDepth(java.lang.Object pItem)

Implementation of Expandable interface.

Specified by:

getItemDepth in interface Expandable

Parameters:

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

Returns:

Level of this org.item in overall organizational hierarchy.

getItemHasChildren

public boolean getItemHasChildren(java.lang.Object pItem)

Implementation of Expandable interface.

Specified by:

getItemHasChildren in interface Expandable

Parameters:

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

Returns:

true if organization has suborganizations; false otherwise.

getTotalItemCount

public int getTotalItemCount()

Description copied from class: ListChooserFormHandler

Same as ListChooserFormHandler.getTotalItemCount().

Specified by:

getTotalItemCount in interface Listable

Overrides:

getTotalItemCount in class ListChooserFormHandler

Returns:

Number of all organizations visible to user at this time (taking into account expanded items).

getViewItemCount

public int getViewItemCount()

Same as getTotalItemCount().

Specified by:

getViewItemCount in interface Listable

Overrides:

getViewItemCount in class ListChooserFormHandler

Returns:

Number of all organizations visible to user at this time (taking into account expanded items).

getViewItems

public java.util.List getViewItems()

Create collection of visible organization items.

Specified by:

getViewItems in interface Listable

Overrides:

getViewItems in class ListChooserFormHandler

Returns:

created collection of organization.

getOwnGroupsOrIntAudiences

public java.util.List getOwnGroupsOrIntAudiences()

getSubOrganizations

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

Parameters:

pItemKey - ID of organization

Returns:

List of children organizations

sortBranch

protected void sortBranch(java.util.List result)

Orders provided organization list according to its names.

Parameters:

result -