Enterprise Information Portal APIs

com.ibm.mm.viewer.annotation
Class CMBAnnotationServicesCallbacks

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

public abstract class CMBAnnotationServicesCallbacks
extends java.lang.Object

CMBAnnotationServicesCallbacks defines methods that users of CMBAnnotationServices must implement to handle requests for retrieving additional annotation blobs and to handle tracing.

Since:
8.1
See Also:
com.ibm.mm.viewer.CMBAnnotationServices

Constructor Summary
CMBAnnotationServicesCallbacks()
           
 
Method Summary
abstract  int addAnnotationPart(CMBAnnotationSet annotationSet, byte[] annotationData)
          Creates a new annotation blob and saves the annotation data.
abstract  java.io.InputStream getAnnotationPart(CMBAnnotationSet annotationSet, int annotationNumber)
          Callback method to retrieve an annotation blob of a document.
abstract  boolean getPrivilege(CMBAnnotationSet annotationSet, int privilegeID)
          Callback method to retrieve the privilege for an annotation.
abstract  void removeAnnotationPart(CMBAnnotationSet annotationSet, int annotationNumber)
          Removes the annotation part.
abstract  void trace(java.lang.String message)
          Writes a trace message.
abstract  boolean traceEnabled()
          Checks if tracing is enabled.
abstract  void updateAnnotationPart(CMBAnnotationSet annotationSet, byte[] annotationData, int annotationNumber)
          Updates the annotation data back as the same part.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CMBAnnotationServicesCallbacks

public CMBAnnotationServicesCallbacks()
Method Detail

getAnnotationPart

public abstract java.io.InputStream getAnnotationPart(CMBAnnotationSet annotationSet,
                                                      int annotationNumber)
Callback method to retrieve an annotation blob of a document.
Parameters:
annotationSet - The annotationSet representing an annotation blob being retrieved.
annotationNumber - The sequential number of the annotation (first annotation being zero).

getPrivilege

public abstract boolean getPrivilege(CMBAnnotationSet annotationSet,
                                     int privilegeID)
Callback method to retrieve the privilege for an annotation.
Parameters:
annotationSet - The annotationSet representing the annotation blob whose privilege is retrieved.
privilegeID - The privilege id.
Returns:
boolean true if the current user has the specified privilege.

addAnnotationPart

public abstract int addAnnotationPart(CMBAnnotationSet annotationSet,
                                      byte[] annotationData)
Creates a new annotation blob and saves the annotation data.
Parameters:
annotationSet - the annotationSet representing an annotation blob being created.
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(CMBAnnotationSet annotationSet,
                                          byte[] annotationData,
                                          int annotationNumber)
Updates the annotation data back as the same part.
Parameters:
annotationSet - The annotationSet representing an annotation blob being updated.
annotationData - The byte array representing the annotation blob.
annotationNumber - The annotation part number.

removeAnnotationPart

public abstract void removeAnnotationPart(CMBAnnotationSet annotationSet,
                                          int annotationNumber)
Removes the annotation part.
Parameters:
annotationSet - The annotationSet representing an annotation blob being removed.
annotationNumber - The annotation part number.

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 trace message string.

EIP JavaBeans

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