@Role
public interface IOService
Modifier and Type | Method and Description |
---|---|
void |
addAnnotation(String target,
Annotation annotation)
Adds annotation on the specified target.
|
Annotation |
getAnnotation(String target,
String annotationID) |
Collection<Annotation> |
getAnnotations(String target)
Returns all the annotations on the passed content.
|
void |
removeAnnotation(String target,
String annotationID)
Removes an annotation given by its identifier, which should be unique among all annotations on the same target.
|
void |
updateAnnotations(String target,
Collection<Annotation> annotations)
Updates the set of annotations in the annotations store.
|
Collection<Annotation> getAnnotations(String target) throws IOServiceException
target
- the string serialized reference to the content for which to get the annotationsIOServiceException
- if any exception occurs while manipulating annotations storeAnnotation getAnnotation(String target, String annotationID) throws IOServiceException
target
- the string serialized reference to the content for which the annotation is addedannotationID
- the identifier of the annotationIOServiceException
- if any exception occurs while manipulating annotations storevoid addAnnotation(String target, Annotation annotation) throws IOServiceException
target
- serialized reference of the target of the annotationannotation
- annotation to add on the targetIOServiceException
- can be thrown if any exception occurs while manipulating annotations storevoid removeAnnotation(String target, String annotationID) throws IOServiceException
target
- serialized reference of the target of the annotationannotationID
- annotation identifierIOServiceException
- can be thrown if any exception occurs while manipulating annotations storevoid updateAnnotations(String target, Collection<Annotation> annotations) throws IOServiceException
Annotation.getId()
, and updated each to match the fields in the Annotation objects.target
- serialized reference of the target of the annotationannotations
- collection of annotations to updateIOServiceException
- can be thrown if any exception occurs while manipulating annotations storeCopyright © 2004–2022 XWiki. All rights reserved.