|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.viewer.annotation.CMBAnnotationEngineCallbacks
CMBAnnotationEngineCallbacks defines callback methods that allow annotation engines to retrieve additional parts. An instance of this class is given to an annotation engine when it is initialized.
CMBAnnotationEngine
Constructor Summary | |
CMBAnnotationEngineCallbacks()
|
Method Summary | |
abstract int |
addAnnotationPart(java.lang.Object hAnnotationSet,
byte[] annotationData)
Creates a new annotation set and saves it. |
abstract java.io.InputStream |
getAnnotationPart(java.lang.Object hAnnotationSet,
int annotationNumber)
Retrieves an additional annotation blob for documents that store each annotation in a separate blob. |
abstract boolean |
getPrivilege(java.lang.Object hAnnotationSet,
int privilegeID)
Gets the privileges for the annotation set. |
abstract void |
removeAnnotationPart(java.lang.Object hAnnotationSet,
int annotationNumber)
Removes the specified annotation blob. |
abstract void |
trace(java.lang.String message)
Writes a trace message. |
abstract boolean |
traceEnabled()
Checks if tracing is enabled. |
abstract void |
updateAnnotationPart(java.lang.Object hAnnotationSet,
byte[] annotationData,
int annotationNumber)
Updates the entire annotation set. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CMBAnnotationEngineCallbacks()
Method Detail |
public abstract java.io.InputStream getAnnotationPart(java.lang.Object hAnnotationSet, int annotationNumber)
hAnnotationSet
- Annotation engine's handle to the set of annotations.annotationNumber
- the index of the annotation blob
(zero is the first annotation blob)public abstract boolean getPrivilege(java.lang.Object hAnnotationSet, int privilegeID)
hAnnotationSet
- The handle of the set of annotations.privilegeID
- The privilege typepublic abstract int addAnnotationPart(java.lang.Object hAnnotationSet, byte[] annotationData)
hAnnotationSet
- Annotation engine's handle to the set of annotations.annotationData
- The byte array representing the annotation blob.public abstract void updateAnnotationPart(java.lang.Object hAnnotationSet, byte[] annotationData, int annotationNumber)
hAnnotationSet
- Annotation engine's handle to the set of annotations.annotationData
- The byte array representing the annotation set.annotationNumber
- The index of the annotation blob.public abstract void removeAnnotationPart(java.lang.Object hAnnotationSet, int annotationNumber)
hAnnotationSet
- Annotation engine's handle to the set of annotations.annotationNumber
- the index of the annotation blob
(zero is the first annotation blob)public abstract boolean traceEnabled()
public abstract void trace(java.lang.String message)
message
- The message to be logged in the trace.
|
EIP JavaBeans | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |