SpaceAware (Atlassian Confluence 8.8.0 API)

All Superinterfaces:

Spaced

All Known Implementing Classes:

AbstractEditSpaceAction, AbstractLabelDisplayingAction, AbstractPaginatedListAction, AbstractSpaceAdminAction, AddLabelToSpaceAction, AddSpaceToFavouriteAjaxAction, AddTeamLabelToSpaceAction, AlphabeticalListLabelsAction, AlphabeticalListPagesAction, ChildrenAction, ChooseThemeAction, ConfigureSpaceLogoAction, CustomPageContentAction, DirectoryViewListPagesAction, EditNotificationsAction, EditorAction, EditSpaceAction, EditSpaceEntryAction, EditSpaceLabelAction, EditSpacePermissionDefaultsAction, EditSpacePermissionsAction, EmptyTrashAction, FindRestrictableEntitiesAction, GetPagePermissionsAction, ImportPagesAction, ListAttachmentsAction, ListLabelsBySpaceAction, ListPermissionPagesAction, ListUndefinedPagesAction, PageChildrenAction, RankListLabelsAction, RecentBlogPostsAction, RemoveSpaceAction, RemoveSpaceEntryAction, RemoveSpaceFromFavouriteAjaxAction, ReorderPageDialogAction, SpaceAdminAction, SpaceColourSchemeAction, SpaceEditDecoratorAction, SpaceEditStylesheetAction, SpaceLookAndFeelAction, ViewLabelAction, ViewSpacePermissionsAction, ViewTrashAction
```
public interface SpaceAware
extends Spaced
```
Indicates that an action may have a space set on it by the SpaceAwareInterceptor

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`isSpaceRequired()`	If the action requires that the space be set before being run, then it should return true to this method.
`boolean`	`isViewPermissionRequired()`
`void`	`setSpace(Space space)`	IOC method for setting the space on the action.

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

- Method Detail
  - setSpace
```
void setSpace(Space space)
```
    IOC method for setting the space on the action. This is called from the interceptor
    
    Parameters:
    
    space - the space that the action will be working on.
  - isSpaceRequired
```
boolean isSpaceRequired()
```
    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
    
    Returns:
    
    true if the action requires a space in order to execute
  - isViewPermissionRequired
```
boolean isViewPermissionRequired()
```
    Returns:
    
    true if the action requires view space permission