com.atlassian.confluence.plugins.createcontent

Interface BlueprintStateController

All Known Implementing Classes:

BandanaBlueprintStateController

public interface BlueprintStateController

Manages the state (enabled/disabled) of Content Blueprint content blueprint plugin modules on a per space basis. This is similar to PluginController which manages this state on a global level.

Method Summary

Modifier and Type	Method and Description
void	disableBlueprint(UUID blueprintId, com.atlassian.confluence.spaces.Space space) Disable a content blueprint plugin by its id for a particular space, or globally if space is null.
void	disableBlueprints(Set<UUID> blueprintIds, com.atlassian.confluence.spaces.Space space) Disable a set of content blueprint plugin ids for a particular space, or globally if space is null.
void	enableBlueprint(UUID blueprintId, com.atlassian.confluence.spaces.Space space) Enable a content blueprint plugin id for a particular space, or globally if space is null.
Map<UUID,BlueprintState>	getAllContentBlueprintState(String section, com.atlassian.confluence.user.ConfluenceUser user, com.atlassian.confluence.spaces.Space space) Returns a set of blueprint keys that are available to a user in a given space.
Set<UUID>	getDisabledBlueprintIds(com.atlassian.confluence.spaces.Space space) Returns a set of disabled blueprints UUIDs.
Set<String>	getDisabledBlueprintModuleCompleteKeys(com.atlassian.confluence.spaces.Space space) Returns a set of disabled blueprints module complete keys.

Method Detail

enableBlueprint

void enableBlueprint(UUID blueprintId,
                     com.atlassian.confluence.spaces.Space space)

Enable a content blueprint plugin id for a particular space, or globally if space is null.

Parameters:

blueprintId - id of the blueprint to be enabled

space - the space to enable this module in

disableBlueprint

void disableBlueprint(UUID blueprintId,
                      com.atlassian.confluence.spaces.Space space)

Disable a content blueprint plugin by its id for a particular space, or globally if space is null.

Parameters:

blueprintId - id of the blueprint to be disabled

space - the space to disable this module in

disableBlueprints

void disableBlueprints(Set<UUID> blueprintIds,
                       com.atlassian.confluence.spaces.Space space)

Disable a set of content blueprint plugin ids for a particular space, or globally if space is null.

Parameters:

blueprintIds - set of blueprint ids to be disabled

space - the space to disable this module in

getDisabledBlueprintIds

Set<UUID> getDisabledBlueprintIds(com.atlassian.confluence.spaces.Space space)

Returns a set of disabled blueprints UUIDs.

Parameters:

space - (required) the space

Returns:

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

getDisabledBlueprintModuleCompleteKeys

Set<String> getDisabledBlueprintModuleCompleteKeys(com.atlassian.confluence.spaces.Space space)

Returns a set of disabled blueprints module complete keys.

Parameters:

space - (required) the space

Returns:

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

getAllContentBlueprintState

Map<UUID,BlueprintState> getAllContentBlueprintState(@Nonnull
                                                     String section,
                                                     @Nullable
                                                     com.atlassian.confluence.user.ConfluenceUser user,
                                                     @Nullable
                                                     com.atlassian.confluence.spaces.Space space)

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

Parameters:

user - (optional) the user. null for anonymous

space - (optional) the space. If null is specified, disabled in space state will be false for all results

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