|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Internal public interface CommentExtensionsSupport
An internal SPI to allow core comments to be extended by Atlassian
Field Summary | |
---|---|
static CommentExtensionsSupport |
NULL_OBJECT
|
Method Summary | |
---|---|
Iterable<ContentType> |
getCommentContainerType()
Get the comment container ContentType that we provide support for. |
Map<String,com.atlassian.fugue.Option<String>> |
getExpansions()
Get the map of expandable extension properties provided by this CommentExtensionSupport |
Map<ContentId,Map<String,Object>> |
getExtensions(Iterable<Comment> comments,
Expansions expansions)
Get the map of extension properties for each of the comment entities |
void |
updateExtensionsOnEntity(Comment comment,
Map<String,Object> extensions)
A creation hook, extension properties should be set on the passed in comment object. |
ValidationResult |
validateExtensionsForCreate(Map<String,Object> extensions,
SimpleValidationResult.Builder validationResultBuilder)
Validation hook for create operations. |
ValidationResult |
validateExtensionsForUpdate(Comment comment,
Map<String,Object> extensions,
SimpleValidationResult.Builder validationResultBuilder)
Validation hook for update operations. |
Field Detail |
---|
static final CommentExtensionsSupport NULL_OBJECT
Method Detail |
---|
Iterable<ContentType> getCommentContainerType()
Map<ContentId,Map<String,Object>> getExtensions(Iterable<Comment> comments, Expansions expansions)
comments
- the comments to get the additional extension properties forexpansions
- the expansions that have been requested
Map<String,com.atlassian.fugue.Option<String>> getExpansions()
ValidationResult validateExtensionsForCreate(Map<String,Object> extensions, SimpleValidationResult.Builder validationResultBuilder)
extensions
- validationResultBuilder
-
ValidationResult validateExtensionsForUpdate(Comment comment, Map<String,Object> extensions, SimpleValidationResult.Builder validationResultBuilder)
extensions
- validationResultBuilder
-
void updateExtensionsOnEntity(Comment comment, Map<String,Object> extensions)
comment
- - the newly created comment that needs properties set on itextensions
- - the extension properties to set
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |