com.atlassian.confluence.content.apisupport

Interface ContentTypeApiSupport<T extends ContentConvertible>

All Known Implementing Classes:

AttachmentContentTypeApiSupport, BaseContentTypeApiSupport, BlogPostContentTypeApiSupport, CommentContentTypeApiSupport, CustomContentTypeApiSupport, DummyAvailableContentTypeSupport, PageContentTypeApiSupport

@ExperimentalSpi
public interface ContentTypeApiSupport<T extends ContentConvertible>

Interface providing extensible content type support in the api

Implementors should extend BaseContentTypeApiSupport

Method Summary

Modifier and Type	Method and Description
default Optional<Object>	container(T contentEntity, Expansions expansions) The return type of this method is intentionally broad.
T	create(Content content) Create a new persistent entity for the given api content
PageResponse<Content>	getChildren(ContentConvertible content, LimitedRequest limitedRequest, Expansions expansions, Depth depth, com.google.common.base.Predicate<? super ContentEntityObject> predicate) Deprecated. since 7.0.1. Use getFilteredChildren(ContentConvertible, LimitedRequest, Expansions, Depth, Predicate)
com.atlassian.fugue.Option<Object>	getContainer(T contentEntity, Expansions expansions) Deprecated. since 7.0.1. Use container(ContentConvertible, Expansions)
Class<T>	getEntityClass() Get the class of the hibernate object used to persist the content type handled by this api support
Map<ContentId,Map<String,Object>>	getExtensions(Iterable<T> contentEntities, Expansions expansions) Get the set of extension properties for the collection of contentEntity Ids.
default PageResponse<Content>	getFilteredChildren(ContentConvertible content, LimitedRequest limitedRequest, Expansions expansions, Depth depth, Predicate<? super ContentEntityObject> predicate) Retrieve the children of an item of Content filtered by a predicate.
ContentType	getHandledType()
List<Link>	getLinks(T contentEntity) Get additional link properties for the _links map
boolean	supportsChildrenForParentType(ContentType parentType) Determines whether this ContentTypeApiSupport will provide children for other types.
boolean	supportsChildrenOfType(ContentType childType) Determines whether other ContentTypeApiSupports can provide children for this type.
T	update(Content content, T existingEntity) Updates an existing persistent entity from the given api content
ValidationResult	validateCreate(Content newContent) Validate the create operation
ValidationResult	validateUpdate(Content oldContent, T existingEntity) Validate the update operation

Method Detail

getHandledType

ContentType getHandledType()

Returns:

the ContentType of the Content that this service provides.

getChildren

@Deprecated
PageResponse<Content> getChildren(ContentConvertible content,
                                              LimitedRequest limitedRequest,
                                              Expansions expansions,
                                              Depth depth,
                                              com.google.common.base.Predicate<? super ContentEntityObject> predicate)

Deprecated. since 7.0.1. Use getFilteredChildren(ContentConvertible, LimitedRequest, Expansions, Depth, Predicate)

Retrieve the children of an item of Content filtered by a predicate.

getFilteredChildren

default PageResponse<Content> getFilteredChildren(ContentConvertible content,
                                                  LimitedRequest limitedRequest,
                                                  Expansions expansions,
                                                  Depth depth,
                                                  Predicate<? super ContentEntityObject> predicate)

Retrieve the children of an item of Content filtered by a predicate.

Since:

7.0.1

supportsChildrenOfType

boolean supportsChildrenOfType(ContentType childType)

Determines whether other ContentTypeApiSupports can provide children for this type.

For children of type childType to be allowed as children of this type, this type needs to return true for supportsChildrenOfType(childType), and childType needs to return true for supportsChildrenForParentType(thisType).

Parameters:

childType - the other Content type that wants to offer children below an instance of our type

Returns:

true if Content of otherType's ContentType should be allowed as children of this type (as far as this type is concerned: childType also gets a say via supportsChildrenForParentType(ContentType))

See Also:

supportsChildrenForParentType(ContentType)

supportsChildrenForParentType

boolean supportsChildrenForParentType(ContentType parentType)

Determines whether this ContentTypeApiSupport will provide children for other types.

For children of this type to be allowed as children of parentType, this type needs to return true for supportsChildrenForParentType(parentType), and parentType needs to return true for supportsChildrenOfType(thisType).

Parameters:

parentType - the other Content type that our type is offering children to

Returns:

true if Content of this type's ContentType should be allowed to be a child of parentType (as far as this type is concerned: parentType also gets a say via supportsChildrenOfType(ContentType))

See Also:

supportsChildrenOfType(ContentType)

getExtensions

Map<ContentId,Map<String,Object>> getExtensions(Iterable<T> contentEntities,
                                                Expansions expansions)

Get the set of extension properties for the collection of contentEntity Ids. Dealing with collections here may help reduce the number of db queries we need to execute.

Implementors should override to provide extensions for the given contentEntity.

getLinks

List<Link> getLinks(T contentEntity)

Get additional link properties for the _links map

Implementors should override and provide links for the given contentEntity

getContainer

@Deprecated
com.atlassian.fugue.Option<Object> getContainer(T contentEntity,
                                                            Expansions expansions)

Deprecated. since 7.0.1. Use container(ContentConvertible, Expansions)

The return type of this method is intentionally broad. Implementors can choose to return the commonly handled container hibernate entities, namely Space, Page or BlogPost, or can choose to provide a model object that implements the api Container interface, no further conversion of instances of Container objects will occur.

Parameters:

contentEntity - - the content entity to get the container object for

Returns:

either a Space, Page or BlogPost or an instance of Container

container

default Optional<Object> container(T contentEntity,
                                   Expansions expansions)

The return type of this method is intentionally broad. Implementors can choose to return the commonly handled container hibernate entities, namely Space, Page or BlogPost, or can choose to provide a model object that implements the api Container interface, no further conversion of instances of Container objects will occur.

Parameters:

contentEntity - - the content entity to get the container object for

Returns:

either a Space, Page or BlogPost or an instance of Container

Since:

7.0.1

getEntityClass

Class<T> getEntityClass()

Get the class of the hibernate object used to persist the content type handled by this api support

Returns:

the class of the entity used to persist changes

create

T create(Content content)

Create a new persistent entity for the given api content

Parameters:

content - the model object to create a persistent entity for

Returns:

the newly created persistent entity

update

T update(Content content,
         T existingEntity)

Updates an existing persistent entity from the given api content

Parameters:

content - the updated content

existingEntity - the existing entity

Returns:

the updated entity

validateCreate

ValidationResult validateCreate(Content newContent)

Validate the create operation

Parameters:

newContent - the content that will be used to create an entity

Returns:

a validation result wrapping any validation errors that were encountered

validateUpdate

ValidationResult validateUpdate(Content oldContent,
                                T existingEntity)

Validate the update operation

Parameters:

oldContent - the content that will be used to update the entity

existingEntity - the existing entity to be updated

Returns:

a validation result wrapping any validation errors that were encountered