com.atlassian.confluence.plugins.createcontent

Interface SpaceBlueprintStateController

All Known Implementing Classes:

BandanaSpaceBlueprintStateController

public interface SpaceBlueprintStateController

Method Summary

Modifier and Type	Method and Description
void	disableSpaceBlueprint(UUID blueprintId) Disable a space blueprint plugin by its id.
void	disableSpaceBlueprints(Set<UUID> blueprintIds) Disable a set of space blueprint plugin ids.
void	enableSpaceBlueprint(UUID blueprintId) Enable a space blueprint plugin by its id.
Map<UUID,BlueprintState>	getAllSpaceBlueprintState(String section, com.atlassian.confluence.user.ConfluenceUser user) Returns a set of space blueprint keys that are available to a user.
Set<UUID>	getDisabledSpaceBlueprintIds() Returns a set of disabled space blueprints UUIDs.
Set<String>	getDisabledSpaceBlueprintModuleCompleteKeys() Returns a set of space disabled blueprints module complete keys.

Method Detail

enableSpaceBlueprint

void enableSpaceBlueprint(UUID blueprintId)

Enable a space blueprint plugin by its id.

Parameters:

blueprintId - id of the blueprint to be enabled

disableSpaceBlueprint

void disableSpaceBlueprint(UUID blueprintId)

Disable a space blueprint plugin by its id.

Parameters:

blueprintId - id of the blueprint to be disabled

disableSpaceBlueprints

void disableSpaceBlueprints(Set<UUID> blueprintIds)

Disable a set of space blueprint plugin ids.

Parameters:

blueprintIds - set of blueprint ids to be disabled

getDisabledSpaceBlueprintIds

Set<UUID> getDisabledSpaceBlueprintIds()

Returns a set of disabled space blueprints UUIDs.

Returns:

all keys of disabled space blueprint plugin modules, an empty set if none is found

getDisabledSpaceBlueprintModuleCompleteKeys

Set<String> getDisabledSpaceBlueprintModuleCompleteKeys()

Returns a set of space disabled blueprints module complete keys.

Returns:

all keys of disabled plugin modules, an empty set if none is found

getAllSpaceBlueprintState

Map<UUID,BlueprintState> getAllSpaceBlueprintState(@Nonnull
                                                   String section,
                                                   @Nullable
                                                   com.atlassian.confluence.user.ConfluenceUser user)

Returns a set of space blueprint keys that are available to a user. If a blueprint is plugin backed, it is only returned if its Condition evaluates to true and if the plugin module is enabled.

Parameters:

user - (optional) the user. null for anonymous

Returns:

all the keys of blueprints that are available to a user in the space, an empty set if none is found

Since:

2.1.16