Package com.atlassian.confluence.pages.actions

Class ListUndefinedPagesAction

java.lang.Object

org.apache.struts2.ActionSupport

com.atlassian.confluence.core.AbstractI18nActionSupport

com.atlassian.confluence.core.ConfluenceActionSupport

com.atlassian.confluence.spaces.actions.AbstractSpaceAction

com.atlassian.confluence.pages.actions.AbstractPaginatedListAction<ListUndefinedPagesAction.UndefinedPage>

com.atlassian.confluence.pages.actions.ListUndefinedPagesAction

All Implemented Interfaces:

Evented<PageListViewEvent>, PaginationServiceSupportActionAware, WebInterface, SpaceAware, Spaced, MessageHolderAware, Serializable, org.apache.struts2.action.Action, org.apache.struts2.interceptor.ValidationAware, org.apache.struts2.locale.LocaleProvider, org.apache.struts2.text.TextProvider, org.apache.struts2.Validateable

public class ListUndefinedPagesAction
extends AbstractPaginatedListAction<ListUndefinedPagesAction.UndefinedPage>
implements Evented<PageListViewEvent>

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListUndefinedPagesAction.UndefinedPage

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, confluenceAccessManager, contentUiSupport, eventPublisher, formatSettingsManager, globalSettingsManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, localeManager, loginManager, messageHolder, permissionManager, pluginAccessor, PREVIEW, request, response, spacePermissionManager, strutsHelper, systemInformationService, userAccessor, webInterfaceManager

Fields inherited from class org.apache.struts2.ActionSupport

container

Fields inherited from interface org.apache.struts2.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
ListUndefinedPagesAction()

Method Summary

Modifier and Type	Method	Description
String	execute()
PageListViewEvent	getEventToPublish(String result)	Gets the event to publish.
List	getItems()
long	getItemsCount()	Get total item of all pages
int	getMaxReferencesPerUndefinedPage()
PageResponse<ListUndefinedPagesAction.UndefinedPage>	getPageResponse()	Will return pagination data in new form
List	getUndefinedPages()
boolean	isSupportPaginationService()	Indicate does sub class support new way of pagination or not
void	setApiPaginationService(PaginationService paginationService)
void	setPageManager(PageManagerInternal pageManager)

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

getPaginationSupport, isSpaceRequired, isViewPermissionRequired, setStartIndex

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

getActionSpaceKey, 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, getActionErrors, getActionMessages, getActionName, getActiveRequest, getActiveResponse, getAuthenticatedUser, getBootstrapStatusProvider, getCancelResult, getDateFormatter, getDefaultTimeZone, getFieldErrors, getGlobalSettings, getHelper, getI18n, getLocale, getMessageHolder, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getTimeZone, getUserByName, getUserInterfaceState, getWebInterfaceContext, isAnonymousUser, isEmailVisible, setAccessModeService, setBootstrapStatusProvider, setCancel, setConfluenceAccessManager, setContentUiSupport, setEventPublisher, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setStrutsHelper, setSystemInformationService, setTimeZoneManager, setUserAccessor, setWebInterfaceManager

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

getText, getText, getText, getText, getText, getText, getText, getText, getTextStrict

Methods inherited from class org.apache.struts2.ActionSupport

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.validation.MessageHolderAware

validate

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

setSpace

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

getSpace

Constructor Details

ListUndefinedPagesAction

public ListUndefinedPagesAction()

Method Details

execute

public String execute()
               throws Exception

Specified by:

execute in interface org.apache.struts2.action.Action

Overrides:

execute in class AbstractPaginatedListAction<ListUndefinedPagesAction.UndefinedPage>

Throws:

Exception

setApiPaginationService

public void setApiPaginationService(PaginationService paginationService)

setPageManager

public void setPageManager(PageManagerInternal pageManager)

getUndefinedPages

public List getUndefinedPages()

getEventToPublish

public PageListViewEvent getEventToPublish(String result)

Description copied from interface: Evented

Gets the event to publish.

Specified by:

getEventToPublish in interface Evented<PageListViewEvent>

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<ListUndefinedPagesAction.UndefinedPage>

getPageResponse

public PageResponse<ListUndefinedPagesAction.UndefinedPage> getPageResponse()

Description copied from interface: PaginationServiceSupportActionAware

Will return pagination data in new form

Specified by:

getPageResponse in interface PaginationServiceSupportActionAware

Returns:

optional of page response

getMaxReferencesPerUndefinedPage

public int getMaxReferencesPerUndefinedPage()

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:

getItemsCount

public long getItemsCount()

Description copied from interface: PaginationServiceSupportActionAware

Get total item of all pages

Specified by:

getItemsCount in interface PaginationServiceSupportActionAware

Returns:

total item