com.atlassian.confluence.plugins.createcontent.rest

Class BlueprintResource

java.lang.Object

com.atlassian.confluence.plugins.createcontent.rest.AbstractRestResource

com.atlassian.confluence.plugins.createcontent.rest.BlueprintResource

public class BlueprintResource
extends AbstractRestResource

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_BP_MODULE_COMPLETE_KEY
static String	PARAM_CONTENT_BLUEPRINT_ID
static String	PARAM_ID
static String	PARAM_KEY
static String	PARAM_PAGE_TITLE
static String	PARAM_SKIP
static String	PARAM_SPACE_KEY

Constructor Summary

Constructors

Constructor and Description

BlueprintResource(com.atlassian.confluence.spaces.SpaceManager spaceManager, com.atlassian.confluence.security.PermissionManager permissionManager, com.atlassian.confluence.pages.PageManager pageManager, com.atlassian.confluence.languages.LocaleManager localeManager, com.atlassian.confluence.util.i18n.I18NBeanFactory i18NBeanFactory, com.atlassian.confluence.util.i18n.DocumentationBeanFactory documentationBeanFactory, UserBlueprintConfigManager userBlueprintConfigManager, ContentBlueprintManager contentBlueprintManager, BlueprintWebItemService webItemService, com.atlassian.confluence.security.SpacePermissionManager spacePermissionManager)

Method Summary

Modifier and Type	Method and Description
Boolean	canCreatePage(String spaceKey, String pageTitle)
ContentBlueprint	create(ContentBlueprint blueprint)
Integer	deleteAll()
ContentBlueprint	get(String blueprintModuleCompleteKey)
ContentBlueprint	get(UUID id)
List<ContentBlueprint>	getAllContentBlueprints()
ContentBlueprint	getByModuleCompleteKey(String moduleCompleteKey)
List<CreateDialogWebItemEntity>	getWebItems(String spaceKey)
void	skipHowToUse(UUID contentBlueprintId, Boolean skip) Called when the User indicates via checkbox that they don't want to see the How-to-Use Blueprint dialog page again.

Methods inherited from class com.atlassian.confluence.plugins.createcontent.rest.AbstractRestResource

checkAdminPermission, checkEmptyParameter, checkNullEntity, checkNullParameter, checkSpaceAdminPermission, getAndCheckSpace, getUser

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARAM_SPACE_KEY

public static final String PARAM_SPACE_KEY

See Also:

Constant Field Values

PARAM_PAGE_TITLE

public static final String PARAM_PAGE_TITLE

See Also:

Constant Field Values

PARAM_CONTENT_BLUEPRINT_ID

public static final String PARAM_CONTENT_BLUEPRINT_ID

See Also:

Constant Field Values

PARAM_SKIP

public static final String PARAM_SKIP

See Also:

Constant Field Values

PARAM_ID

public static final String PARAM_ID

See Also:

Constant Field Values

PARAM_BP_MODULE_COMPLETE_KEY

public static final String PARAM_BP_MODULE_COMPLETE_KEY

See Also:

Constant Field Values

PARAM_KEY

public static final String PARAM_KEY

See Also:

Constant Field Values

Constructor Detail

BlueprintResource

public BlueprintResource(com.atlassian.confluence.spaces.SpaceManager spaceManager,
                         com.atlassian.confluence.security.PermissionManager permissionManager,
                         com.atlassian.confluence.pages.PageManager pageManager,
                         com.atlassian.confluence.languages.LocaleManager localeManager,
                         com.atlassian.confluence.util.i18n.I18NBeanFactory i18NBeanFactory,
                         com.atlassian.confluence.util.i18n.DocumentationBeanFactory documentationBeanFactory,
                         UserBlueprintConfigManager userBlueprintConfigManager,
                         ContentBlueprintManager contentBlueprintManager,
                         BlueprintWebItemService webItemService,
                         com.atlassian.confluence.security.SpacePermissionManager spacePermissionManager)

Method Detail

getWebItems

public List<CreateDialogWebItemEntity> getWebItems(String spaceKey)

canCreatePage

public Boolean canCreatePage(String spaceKey,
                             String pageTitle)

Returns:

true if the user can create a page with the given title in the given space, false if not.

skipHowToUse

public void skipHowToUse(UUID contentBlueprintId,
                         Boolean skip)

Called when the User indicates via checkbox that they don't want to see the How-to-Use Blueprint dialog page again.

get

public ContentBlueprint get(UUID id)

get

public ContentBlueprint get(String blueprintModuleCompleteKey)

getAllContentBlueprints

public List<ContentBlueprint> getAllContentBlueprints()

create

public ContentBlueprint create(ContentBlueprint blueprint)

getByModuleCompleteKey

public ContentBlueprint getByModuleCompleteKey(String moduleCompleteKey)

deleteAll

public Integer deleteAll()