Comment Service

Unable to render {include} The included page could not be found.

Name Version

CommentService
Dev	Release Notes

#References

#Operations

#Capabilities

Description

The Comment Service manages user comments associated with any object.This service is to allow comments and tags to be created for objects across the system. There is no expectation that the Objects no about these at all, and therefore objects can be deleted while there were still tags or comments.

We're using "objects" in a different way than elsewhere, so we need a better name.
How much threading do we need

Operations

Unable to render {include} The included page could not be found.

Setup

Dictionary Operations
#findObjectTypes
#fetchObjectStructure
#fetchEnumeration

Search Operations
#findSearchTypes
#fetchSearchType
#findSearchTypesByResult
#findSearchTypesByCriteria
#findSearchResultTypes
#fetchSearchResultType
#findSearchCriteriaTypes
#fetchSearchCriteriaType

Domain Operations
#getReferenceTypes
getCommentTypes – Do we need these? Separate Personal from Official etc
getTagTypes – Do we need these?

Read

getTagsForReference
getCommentsForReference

getComments

getReferencesByTag
getReferencesOfTypeByTag

getTags

Search

#searchForResults

Maintenance

addTag
removeTag

addComment

removeComment

removeAllTags
removeAllComments

Unable to render {include} The included page could not be found.

Setup

Method Description Parameters Return Errors Capabilities Use Cases Comments/Feedback

getReferenceTypes
Retrieves the list of types which can be tagged or commented.
None	None	No parameters
referenceTypeInfoList		the list of types which can be tagged or commented
OPERATION_FAILED		unable to complete request

Back to Operations