Package com.atlassian.confluence.labels.actions

Class ListLabelsBySpaceAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.spaces.actions.AbstractSpaceAction

com.atlassian.confluence.pages.actions.AbstractPaginatedListAction<Label>

com.atlassian.confluence.labels.actions.ListLabelsBySpaceAction

All Implemented Interfaces:

Evented<LabelListViewEvent>, PaginationServiceSupportActionAware, WebInterface, SpaceAware, Spaced, MessageHolderAware, com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable

public class ListLabelsBySpaceAction
extends AbstractPaginatedListAction<Label>
implements Evented<LabelListViewEvent>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.confluence.pages.actions.AbstractPaginatedListAction

ITEMS_PER_PAGE, paginationSupport

Fields inherited from class com.atlassian.confluence.spaces.actions.AbstractSpaceAction

key, notificationManager, space, spaceManager, themeManager, wikiStyleRenderer

Fields inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

accessModeService, CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, messageHolder, permissionManager, permitted, personService, pluginAccessor, PREVIEW, settingsManager, spacePermissionManager, userAccessor, webInterfaceManager

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	Description
ListLabelsBySpaceAction()

Method Summary

Modifier and Type	Method	Description
LabelListViewEvent	getEventToPublish(String result)	Gets the event to publish.
List	getItems()
long	getItemsCount()	Get total item of all pages
PageResponse<Label>	getPageResponse()	Will return pagination data in new form
int	getStartIndex()
boolean	isSupportPaginationService()	Indicate does sub class support new way of pagination or not
void	setApiPaginationService(PaginationService paginationService)
void	setLabelManager(LabelManagerInternal labelManager)
void	validate()

Methods inherited from class com.atlassian.confluence.pages.actions.AbstractPaginatedListAction

execute, getPaginationSupport, isSpaceRequired, isViewPermissionRequired, setStartIndex

Methods inherited from class com.atlassian.confluence.spaces.actions.AbstractSpaceAction

getKey, getPermissionTypes, getSpace, getSpaceKey, getSpaceManager, getSubscribableName, getThemeManager, hasSpaceIA, isPermitted, isPersonalSpace, isUserWatchingSpace, isValidSpaceKey, setKey, setNotificationManager, setSpace, setSpaceManager, setThemeManager, setWikiStyleRenderer

Methods inherited from class com.atlassian.confluence.core.ConfluenceActionSupport

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getAccessMode, getActionName, getActionName, getAuthenticatedUser, getBootstrapManager, getBootstrapStatusProvider, getCancel, getCancelResult, getConfluenceAccessManager, getContentUiSupport, getContext, getCurrentRequest, getCurrentSession, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDefaultTimeZone, getDocBean, getDocLink, getEventManager, getFriendlyDateFormatter, getFrontendServiceURL, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageJs, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionManager, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPersonService, getPreviousLoginDate, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUserAccessor, getUserByName, getUserFullName, getUserHasBrowseUsersPermission, getUserHasLicensedAccess, getUserInterfaceState, getUserLocaleDefaultDatePattern, getUserProfilePicUrl, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPrintableVersion, isSkipAccessCheck, isUserStatusPluginEnabled, isUsingH2, isUsingHSQL, setAccessModeService, setApiDateFormatService, setApiPersonService, setBootstrapManager, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setServletRequestSupplier, setSettingsManager, setSkipAccessCheck, setSpacePermissionManager, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager, withServletRequestSupplier

Methods inherited from class com.opensymphony.xwork2.ActionSupport

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opensymphony.xwork2.LocaleProvider

isValidLocale, isValidLocaleString

Methods inherited from interface com.atlassian.confluence.spaces.actions.SpaceAware

setSpace

Methods inherited from interface com.atlassian.confluence.spaces.Spaced

getSpace

Constructor Detail

ListLabelsBySpaceAction

public ListLabelsBySpaceAction()

Method Detail

setLabelManager

public void setLabelManager(LabelManagerInternal labelManager)

setApiPaginationService

public void setApiPaginationService(PaginationService paginationService)

getEventToPublish

public LabelListViewEvent getEventToPublish(String result)

Description copied from interface: Evented

Gets the event to publish.

Specified by:

getEventToPublish in interface Evented<LabelListViewEvent>

Parameters:

result - the result of the action executing.

Returns:

the event. Can be null, in which case no event will be published.

getItems

public List getItems()

Specified by:

getItems in class AbstractPaginatedListAction<Label>

isSupportPaginationService

public boolean isSupportPaginationService()

Description copied from interface: PaginationServiceSupportActionAware

Indicate does sub class support new way of pagination or not

Specified by:

isSupportPaginationService in interface PaginationServiceSupportActionAware

Returns:

getPageResponse

public PageResponse<Label> getPageResponse()

Description copied from interface: PaginationServiceSupportActionAware

Will return pagination data in new form

Specified by:

getPageResponse in interface PaginationServiceSupportActionAware

Returns:

optional of page response

getItemsCount

public long getItemsCount()

Description copied from interface: PaginationServiceSupportActionAware

Get total item of all pages

Specified by:

getItemsCount in interface PaginationServiceSupportActionAware

Returns:

total item

getStartIndex

public int getStartIndex()

validate

public void validate()

Specified by:

validate in interface MessageHolderAware

Specified by:

validate in interface com.opensymphony.xwork2.Validateable

Overrides:

validate in class com.opensymphony.xwork2.ActionSupport