com.atlassian.confluence.spaces.actions
Interface SpaceAware

All Superinterfaces:

Spaced

All Known Implementing Classes:

AbstractLabelDisplayingAction, AlphabeticalListLabelsAction, ConfigureSpaceLogoAction, RankListLabelsAction, RecentBlogPostsAction, ViewLabelAction

public interface SpaceAware
extends Spaced

Indicates that an action may have a space set on it by the SpaceAwareInterceptor

Method Summary

boolean	isSpaceRequired() If the action requires that the space be set before being run, then it should return true to this method.
boolean	isViewPermissionRequired() If the action requires that the user needs viewPagePermissions, then it should return true to this method.
void	setSpace(Space space) IOC method for setting the space on the action.

Methods inherited from interface com.atlassian.confluence.spaces.actions.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()

If the action requires that the user needs viewPagePermissions, then it should return true to this method. If the action requires viewPagePermissions, but the user does not have the viewPermission, the interceptor will redirect to 'pagenotpermitted' result

Returns:

true if the action requires viewPagePermissions to execute