com.atlassian.crowd.console.action.pickers

Class SearchPicker

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.atlassian.crowd.console.action.BaseAction

com.atlassian.crowd.console.action.AbstractBrowser

com.atlassian.crowd.console.action.pickers.SearchPicker

All Implemented Interfaces:

com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable

public class SearchPicker
extends AbstractBrowser

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.crowd.console.action.AbstractBrowser

results, resultsPerPage, resultsStart

Fields inherited from class com.atlassian.crowd.console.action.BaseAction

actionHelper, actionMessageAlertColor, ALERT_BLUE, ALERT_GREEN, ALERT_RED, ALERT_YELLOW, applicationManager, applicationService, clientProperties, crowdLicenseManager, directoryManager, initialLoad, logger, propertyManager, rememberMeService, SMALL_AVATAR_SIZE, smallAvatarUrl, tab, tokenAuthenticationManager

Fields inherited from class com.opensymphony.xwork2.ActionSupport

container

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor and Description
SearchPicker()

Method Summary

Modifier and Type	Method and Description
String	getActiveFlag()
Long	getDirectoryID()
String	getEntityName()
List<String>	getExclusions()
String	getGroupMembershipsOfUser() Generates a collection of groups in a particular directory that the user is a member of.
String	getGroupMembersOfGroup() Generates a collection of groups that are members of a group in a particular directory.
String	getGroupNonMembershipsOfUser() Generates a collection of groups in a particular directory that the user is not a member of.
String	getGroupNonMembersOfGroup() Generates a collection of groups that are not members of a group in a particular directory.
String	getGroupsExcluding() Generates a collection of groups in a directory, removing groups that are specified as exclusions.
String	getResultEntityType()
String	getSearchString()
String	getUserMembersOfGroup() Generates a collection of users that are members of a group in a particular directory.
String	getUserNonMembersOfGroup() Generates a collection of users that are not members of a group in a particular directory.
void	setActiveFlag(String activeFlag)
void	setDirectoryID(Long directoryID)
void	setEntityName(String entityName)
void	setExclusions(List<String> exclusions)
void	setSearchString(String searchString)

Methods inherited from class com.atlassian.crowd.console.action.AbstractBrowser

getActiveOption, getFormattedDateTime, getFormattedDateTime, getNextResultsStart, getPreviousResultsStart, getResults, getResultsPerPage, getResultsPerPageOption, getResultsStart, setResults, setResultsPerPage, setResultsStart

Methods inherited from class com.atlassian.crowd.console.action.BaseAction

addActionError, addActionMessage, applyFieldError, applyFieldErrors, authorisedToAccessCrowdAdminConsole, authorisedToAccessCrowdConsole, containsActionMessages, containsErrorMessages, directory, execute, findAvatarUrl, getActionMessageAlertColor, getBootstrapManager, getCrowdApplication, getCurrentLicenseResourceTotal, getDisplayableLink, getHttpRequest, getImageLocation, getImageTitle, getLabel, getLicense, getLink, getLocaleProvider, getPasswordComplexityMessage, getRemoteUser, getSession, getSitemeshPageProperties, getSmallAvatarUrl, getTab, getText, getText, getTextProvider, getUserName, getWebFragmentsContextMap, getWebInterfaceManager, getWebItemsForSection, getWebResourceManager, getWebSectionsForLocation, getXsrfToken, getXsrfTokenName, isAtResourceLimit, isAuthenticated, isEvaluation, isGroupAdmin, isInitialLoad, isLicenseExpired, isRestartRequiredToEnableClustering, isSubscription, isSysAdmin, isWithinGracePeriod, renderFreemarkerTemplate, resolveAvatarUri, setActionHelper, setApplicationManager, setApplicationService, setClientProperties, setClusterService, setCrowdApplication, setCrowdLicenseManager, setDirectoryManager, setPropertyManager, setRememberMeService, setTab, setTokenAuthenticationManager, setWebInterfaceManager, setWebResourceManager, setXsrfTokenGenerator

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionError, addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getActionErrors, getActionMessages, getContainer, getFieldErrors, getFormatted, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchPicker

public SearchPicker()

Method Detail

getGroupsExcluding

public String getGroupsExcluding()
                          throws Exception

Generates a collection of groups in a directory, removing groups that are specified as exclusions.

Params:

• directoryID
• exclusions (optional)
• searchString (optional)
• active (optional)

Returns:

SUCCESS.

Throws:

Exception

getUserMembersOfGroup

public String getUserMembersOfGroup()
                             throws Exception

Generates a collection of users that are members of a group in a particular directory.

Params:

• directoryID
• entityName (group name)
• searchString (optional)
• active (optional)

Returns:

SUCCESS.

Throws:

Exception - error executing search.

getUserNonMembersOfGroup

public String getUserNonMembersOfGroup()
                                throws Exception

Generates a collection of users that are not members of a group in a particular directory.

Params:

• directoryID
• entityName (group name)
• searchString (optional)
• active (optional)

Returns:

SUCCESS.

Throws:

Exception - error executing search.

getGroupMembersOfGroup

public String getGroupMembersOfGroup()
                              throws Exception

Generates a collection of groups that are members of a group in a particular directory.

Params:

• directoryID
• entityName (group name)
• searchString (optional)
• active (optional)

Returns:

SUCCESS.

Throws:

Exception - error executing search.

getGroupNonMembersOfGroup

public String getGroupNonMembersOfGroup()
                                 throws Exception

Generates a collection of groups that are not members of a group in a particular directory.

Params:

• directoryID
• entityName (group name)
• searchString (optional)
• active (optional)

Returns:

SUCCESS.

Throws:

Exception - error executing search.

getGroupMembershipsOfUser

public String getGroupMembershipsOfUser()
                                 throws Exception

Generates a collection of groups in a particular directory that the user is a member of.

Params:

• directoryID
• entityName (user name)
• searchString (optional)
• active (optional)

Returns:

SUCCESS.

Throws:

Exception - error executing search.

getGroupNonMembershipsOfUser

public String getGroupNonMembershipsOfUser()
                                    throws Exception

Generates a collection of groups in a particular directory that the user is not a member of.

Params:

• directoryID
• entityName (user name)
• searchString (optional)
• active (optional)

Returns:

SUCCESS.

Throws:

Exception - error executing search.

getDirectoryID

public Long getDirectoryID()

setDirectoryID

public void setDirectoryID(Long directoryID)

getEntityName

public String getEntityName()

setEntityName

public void setEntityName(String entityName)

getExclusions

public List<String> getExclusions()

setExclusions

public void setExclusions(List<String> exclusions)

getResultEntityType

public String getResultEntityType()

getSearchString

public String getSearchString()

setSearchString

public void setSearchString(String searchString)

getActiveFlag

public String getActiveFlag()

setActiveFlag

public void setActiveFlag(String activeFlag)