com.atlassian.confluence.pages.actions
Class ChildrenAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.atlassian.confluence.core.ConfluenceActionSupport
          com.atlassian.confluence.pages.actions.AbstractPageAwareAction
              com.atlassian.confluence.pages.actions.ChildrenAction

All Implemented Interfaces:

JSONAction, PageAware, WebInterface, SpaceAware, Spaced, MessageHolderAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, Serializable

Direct Known Subclasses:

PageChildrenAction

public class ChildrenAction
extends AbstractPageAwareAction
implements SpaceAware, JSONAction

See Also:

Serialized Form

Field Summary

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

contentPermissionManager, spaceManager

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

CANCEL, DEVMODE, eventManager, i18NBeanFactory, labelManager, languageManager, LICENSE_EXPIRED, LICENSE_USERS_EXCEEDED, log, messageHolder, permissionManager, permitted, pluginAccessor, 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

Constructor Summary

ChildrenAction()

Method Summary

String	execute()
String	getJSONString()
List<Page>	getPermittedChildren()
Space	getSpace()
boolean	hasPermittedChildren(Page page)
boolean	isPageRequired() If the action requires that the page be set before being run, then it should return true to this method.
boolean	isPermitted()
boolean	isSpaceRequired() If the action requires that the space be set before being run, then it should return true to this method.
void	setNode(String node)
void	setPageManager(PageManager pageManager)
void	setPermissionCheckExemptions(PermissionCheckExemptions permissionCheckExemptions)
void	setSpace(Space space) IOC method for setting the space on the action.

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

getPage, getPageId, getSpaceKey, getTitle, hasViewPagePermission, isLatestVersionRequired, isViewPermissionRequired, setContentPermissionManager, setPage, setSpaceManager

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

addActionError, addActionMessage, addFieldError, addPermissionTypeTo, addToHistory, doDefault, formatFriendlyDate, getActionName, getActionName, getBootstrapManager, getCancel, getCancelResult, getContext, getDateFormatSetting, getDateFormatter, getDefaultResourceBundle, getDocLink, getEventManager, getFriendlyDateFormatter, getGlobalSettings, getHelper, getI18n, getInstalledLanguages, getLabelManager, getLanguageManager, getLanguageUserFriendly, getLocale, getLocaleManager, getLocaleString, getMessageHolder, getNiceContentType, getPermissionTypes, getPermittedEntitiesOf, getPermittedEntitiesOf, getPermittedEntitiesOf, getPreviousLoginDate, getRandom, getRemoteUser, getSession, getSystemInformationService, getText, getText, getText, getText, getTextStatic, getTextStatic, getTextStrict, getTimeZone, getUser, getUserAccessor, getUserFullName, getUserInterfaceState, getWebInterfaceContext, getWebInterfaceManager, hasPermissionForSpace, isAnonymousUser, isCanceled, isDevMode, isEmailVisible, isExternalUserManagementEnabled, isLabelable, isPermissionCheck, isPermittedAsString, isPrintableVersion, isSharedMode, isUserStatusPluginEnabled, isUsingHSQL, setBootstrapManager, setCancel, setContentUiSupport, setEventManager, setFormatSettingsManager, setI18NBean, setI18NBeanFactory, setLabelManager, setLanguageManager, setLocaleManager, setLoginManager, setMessageHolder, setPermissionCheck, setPermissionManager, setPluginAccessor, setPreviousLoginDate, setSettingsManager, setSpacePermissionManager, setSystemInformationService, 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, validate

Methods inherited from class java.lang.Object

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

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

isViewPermissionRequired

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

validate

Constructor Detail

ChildrenAction

public ChildrenAction()

Method Detail

setPageManager

public void setPageManager(PageManager pageManager)

getPermittedChildren

public List<Page> getPermittedChildren()

hasPermittedChildren

public boolean hasPermittedChildren(Page page)

setPermissionCheckExemptions

public void setPermissionCheckExemptions(PermissionCheckExemptions permissionCheckExemptions)

execute

public String execute()
               throws Exception

Specified by:

execute in interface com.opensymphony.xwork.Action

Overrides:

execute in class com.opensymphony.xwork.ActionSupport

Throws:

Exception

setNode

public void setNode(String node)

isPageRequired

public boolean isPageRequired()

Description copied from interface: PageAware

If the action requires that the page be set before being run, then it should return true to this method. If the action requires a page, but no page is available, then the interceptor will automatically redirect to the 'pagenotfound' result

Specified by:

isPageRequired in interface PageAware

Overrides:

isPageRequired in class AbstractPageAwareAction

Returns:

true if the action requires a page in order to execute

getSpace

public Space getSpace()

Specified by:

getSpace in interface Spaced

Overrides:

getSpace in class AbstractPageAwareAction

setSpace

public void setSpace(Space space)

Description copied from interface: SpaceAware

IOC method for setting the space on the action. This is called from the interceptor

Specified by:

setSpace in interface SpaceAware

Parameters:

space - the space that the action will be working on.

isSpaceRequired

public boolean isSpaceRequired()

Description copied from interface: SpaceAware

If the action requires that the space be set before being run, then it should return true to this method. If the action requires a space, but no space is available, then the interceptor will automatically redirect to the 'pagenotfound' result

Specified by:

isSpaceRequired in interface SpaceAware

Returns:

true if the action requires a space in order to execute

getJSONString

public String getJSONString()

Specified by:

getJSONString in interface JSONAction

isPermitted

public boolean isPermitted()

Overrides:

isPermitted in class AbstractPageAwareAction