com.atlassian.confluence.plugins.createcontent

Interface ContentBlueprintManager

All Superinterfaces:

AoBackedManager<ContentBlueprint,ContentBlueprintAo>

All Known Implementing Classes:

DefaultContentBlueprintManager

public interface ContentBlueprintManager
extends AoBackedManager<ContentBlueprint,ContentBlueprintAo>

Stores and retrieves ContentBlueprints for use with the ContentBlueprintService.

Since:

1.6

Method Summary

Modifier and Type	Method and Description
List<ContentBlueprint>	getAll(com.atlassian.confluence.spaces.Space space) Gets all objects for this manager
ContentBlueprint	getOrCreateCustomBlueprint(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey, com.atlassian.confluence.spaces.Space space) Returns the ContentBlueprint customised for the given space and having the specified module complete key.
ContentBlueprint	getPluginBackedContentBlueprint(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey, String spaceKey) Returns a ContentBlueprint that originally came from a Plugin (and hence has a module complete key) but may have a customised version for the given space.
ContentBlueprint	getPluginBlueprint(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey) Gets or creates a content blueprint clone in AO if its enabled, given its module complete moduleCompleteKey.

Methods inherited from interface com.atlassian.confluence.plugins.createcontent.AoBackedManager

create, createAo, delete, delete, deleteAll, getAll, getAoById, getById, getCloneByModuleCompleteKey, getNonClonesByModuleCompleteKey, update, updateAo

Method Detail

getPluginBlueprint

@Nullable
ContentBlueprint getPluginBlueprint(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey)

Gets or creates a content blueprint clone in AO if its enabled, given its module complete moduleCompleteKey.

Parameters:

moduleCompleteKey - module complete key of the blueprint module

Returns:

a cloned content blueprint, null if blueprint module is disabled

getAll

@Nonnull
List<ContentBlueprint> getAll(com.atlassian.confluence.spaces.Space space)

Gets all objects for this manager

Returns:

a list with all the objects for this manager

getPluginBackedContentBlueprint

@Nullable
ContentBlueprint getPluginBackedContentBlueprint(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey,
                                                           String spaceKey)

Returns a ContentBlueprint that originally came from a Plugin (and hence has a module complete key) but may have a customised version for the given space.

getOrCreateCustomBlueprint

ContentBlueprint getOrCreateCustomBlueprint(com.atlassian.plugin.ModuleCompleteKey moduleCompleteKey,
                                            com.atlassian.confluence.spaces.Space space)

Returns the ContentBlueprint customised for the given space and having the specified module complete key. If no customised Bp exists yet, it will be created. Note that if the space passed is null, a custom global Blueprint will be retrieved.

Parameters:

moduleCompleteKey - key of original plugin Blueprint to be customised

space - space to look for overridden Blueprint - may be null for global

Returns:

the new or existing Blueprint