com.atlassian.confluence.plugins.createcontent.services

Interface PromotedBlueprintService

All Known Implementing Classes:

DefaultPromotedBlueprintService

public interface PromotedBlueprintService

Method Summary

Modifier and Type	Method and Description
boolean	demoteBlueprint(String blueprintId, String spaceKey) Unpromote a blueprint
Collection<ContentBlueprint>	getPromotedBlueprints(Collection<ContentBlueprint> blueprints, com.atlassian.confluence.spaces.Space space) Takes in a list of blueprints and returns the ones that are promoted in the specified space.
boolean	promoteBlueprint(String blueprintId, String spaceKey) Promote a blueprint.
void	promoteBlueprints(List<String> blueprintIds, com.atlassian.confluence.spaces.Space space) Promote a list of blueprints

Method Detail

getPromotedBlueprints

@Nonnull
Collection<ContentBlueprint> getPromotedBlueprints(@Nonnull
                                                            Collection<ContentBlueprint> blueprints,
                                                            @Nullable
                                                            com.atlassian.confluence.spaces.Space space)

Takes in a list of blueprints and returns the ones that are promoted in the specified space. Please note, the blueprints may be enabled or disabled in the context.

Filtering out enabled and disabled <blueprint>s are a separate concern.

Returns:

a collection of promoted blueprint entities.

promoteBlueprint

boolean promoteBlueprint(@Nonnull
                         String blueprintId,
                         @Nonnull
                         String spaceKey)
                  throws BlueprintIllegalArgumentException

Promote a blueprint.

Parameters:

blueprintId - blueprint UUID string

spaceKey - space in which the blueprint is to be promoted or demoted

Returns:

true if the Blueprint was promoted (i.e. if it wasn't already promoted)

Throws:

BlueprintIllegalArgumentException

demoteBlueprint

boolean demoteBlueprint(@Nonnull
                        String blueprintId,
                        @Nonnull
                        String spaceKey)
                 throws BlueprintIllegalArgumentException

Unpromote a blueprint

Parameters:

blueprintId - blueprint UUID string

spaceKey - space in which the blueprint is to be promoted or demoted

Returns:

true if the Blueprint was unpromoted (i.e. if it was previously promoted)

Throws:

BlueprintIllegalArgumentException

promoteBlueprints

void promoteBlueprints(@Nonnull
                       List<String> blueprintIds,
                       @Nonnull
                       com.atlassian.confluence.spaces.Space space)

Promote a list of blueprints

Parameters:

blueprintIds - List of blueprint UUID strings

space - space in which the blueprints are to be promoted