Enterprise Information Portal APIs

com.ibm.mm.viewer.annotation
Class CMBAnnotationEngineCallbacks

java.lang.Object
  |
  +--com.ibm.mm.viewer.annotation.CMBAnnotationEngineCallbacks

public abstract class CMBAnnotationEngineCallbacks
extends java.lang.Object

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.

Since:
8.1
See Also:
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

CMBAnnotationEngineCallbacks

public CMBAnnotationEngineCallbacks()
Method Detail

getAnnotationPart

public 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.
Parameters:
hAnnotationSet - Annotation engine's handle to the set of annotations.
annotationNumber - the index of the annotation blob (zero is the first annotation blob)
Returns:
InputStream The inputstream to the annotation blob or null if that annotation doesn't exist.

getPrivilege

public abstract boolean getPrivilege(java.lang.Object hAnnotationSet,
                                     int privilegeID)
Gets the privileges for the annotation set.
Parameters:
hAnnotationSet - The handle of the set of annotations.
privilegeID - The privilege type
Returns:
boolean True if that privilege is allowed for this annotation set, False otherwise.

addAnnotationPart

public abstract int addAnnotationPart(java.lang.Object hAnnotationSet,
                                      byte[] annotationData)
Creates a new annotation set and saves it. Called by the CMBAnnotationEngine saveAnnotationSet() method to create a new annotation part.
Parameters:
hAnnotationSet - Annotation engine's handle to the set of annotations.
annotationData - The byte array representing the annotation blob.
Returns:
int The annotation part number of the annotation set that was created.

updateAnnotationPart

public abstract void updateAnnotationPart(java.lang.Object hAnnotationSet,
                                          byte[] annotationData,
                                          int annotationNumber)
Updates the entire annotation set. Called by the CMBAnnotationEngine saveAnnotationSet() method to update the annotation part that was loaded.
Parameters:
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.

removeAnnotationPart

public abstract void removeAnnotationPart(java.lang.Object hAnnotationSet,
                                          int annotationNumber)
Removes the specified annotation blob.
Parameters:
hAnnotationSet - Annotation engine's handle to the set of annotations.
annotationNumber - the index of the annotation blob (zero is the first annotation blob)

traceEnabled

public abstract boolean traceEnabled()
Checks if tracing is enabled.
Returns:
boolean true if tracing is enabled false otherwise.

trace

public abstract void trace(java.lang.String message)
Writes a trace message.
Parameters:
message - The message to be logged in the trace.

EIP JavaBeans

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.