com.atlassian.confluence.search.actions
Class SearchSiteAction
java.lang.Object
com.opensymphony.xwork.ActionSupport
com.atlassian.confluence.core.ConfluenceActionSupport
com.atlassian.confluence.search.actions.SearchSiteAction
- All Implemented Interfaces:
- com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, Serializable, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware
- public class SearchSiteAction
- extends ConfluenceActionSupport
- See Also:
- Serialized Form
Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport |
CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, log, permissionManager, permitted, PREVIEW, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager |
Fields inherited from class com.opensymphony.xwork.ActionSupport |
LOG |
Fields inherited from interface com.opensymphony.xwork.Action |
ERROR, INPUT, LOGIN, NONE, SUCCESS |
Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport |
addActionError, addPermissionTypeTo, addToHistory, doDefault, getActionName, getBootstrapManager, getCancelResult, getDateFormatter, getDefaultResourceBundle, getEditorLanguage, getEventManager, getGlobalHelper, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getSpaceHelper, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserFullName, getUserInterfaceState, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermitted, isPermittedAsString, isPrintableVersion, setBootstrapManager, setCancel, setEventManager, setFormatSettingsManager, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setPermissionCheck, setPermissionManager, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setUserAccessor, setWebInterfaceManager |
Methods inherited from class com.opensymphony.xwork.ActionSupport |
addActionError, addActionMessage, addFieldError, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SearchSiteAction
public SearchSiteAction()
setSearcher
public void setSearcher(Searcher searcher)
validate
public void validate()
execute
public String execute()
throws Exception
- Throws:
Exception
getResults
public List getResults()
- returns paginated results
getExcludedMailCount
public int getExcludedMailCount()
getExcludedGlobalResult
public int getExcludedGlobalResult()
getResultsForSpace
public List getResultsForSpace(String spaceKey)
getResultsForType
public List getResultsForType(String type)
getSearchQuery
public SearchQueryBean getSearchQuery()
resetSearchQueryBean
protected void resetSearchQueryBean()
getAvailableSpaces
public List getAvailableSpaces()
- Find all spaces that user has permission to view, but that aren't favourites
- Returns:
- List
getAvailableGlobalSpaces
public List getAvailableGlobalSpaces()
- Find all global spaces that user has permission to view, but that aren't favourites
- Returns:
- List
getAggregateOptions
public List getAggregateOptions()
getFavouriteSpaces
public List getFavouriteSpaces()
setSpaceManager
public void setSpaceManager(SpaceManager spaceManager)
getContentEntityTypes
public List getContentEntityTypes()
getMatchingLabels
public List getMatchingLabels()
- Returns the labels matching the current search query.
Only if a term of the query matches exactly the labelname, the label will be added to the list.
To search for personal labels the query string has to contain a term like my:labelname.
- Returns:
- List of matching labels
getRelatedLabels
public List getRelatedLabels()
- Returns a list of related labels to the labels matching the search result
Currently it takes the 5 most related labels
- Returns:
- List of related lables
getLabelNames
public String getLabelNames(Labelable obj)
- Retrieve a comma separated string of label names.
- Returns:
- a comma separated string
getContentLabels
public List getContentLabels(ContentEntityObject content,
int amount)
getReset
public String getReset()
setReset
public void setReset(String reset)
getSpace
public Space getSpace(String spaceKey)
getSearchBean
public SearchBean getSearchBean()
setSearchBean
public void setSearchBean(SearchBean searchBean)
getTypeName
public String getTypeName(String type)
setStartIndex
public void setStartIndex(int startIndex)
isQuickSearch
public boolean isQuickSearch()
setQuickSearch
public void setQuickSearch(boolean quickSearch)
isSpaceSearch
public boolean isSpaceSearch()
getQuery
public Query getQuery()
getSearcher
public Searcher getSearcher()
isExplain
public boolean isExplain()
setExplain
public void setExplain(boolean explain)
getTimer
public Timer getTimer()