com.ibm.ecm.extension

Class ODPluginServiceCallbacks

java.lang.Object

com.ibm.ecm.extension.ODPluginServiceCallbacks

public class ODPluginServiceCallbacks
extends java.lang.Object

Provides a plug-in service with access to the application programming interface (API) of the underlying server and the location of the configuration information for the plug-in.

Method Summary

Modifier and Type	Method and Description
com.ibm.ecm.mediator.od.ODAnnotationMediator	addODNote(java.lang.String repositoryId, java.lang.String documentId, java.lang.String templateName, java.lang.String noteGroupName, java.lang.String noteText, boolean noteIsOKToCopy, boolean noteIsPublic) Adds a note for a document in a Content Manager OnDemand repository.
com.ibm.edms.od.ODHit	getODDocument(java.lang.String repositoryId, java.lang.String documentId, java.lang.String templateName) Retrieves a Content Manager OnDemand document.
java.util.Vector[]	getODNotes(java.lang.String repositoryId, java.lang.String documentId, java.lang.String templateName) Retrieves Notes for an OD document.
java.util.HashMap<com.ibm.edms.od.ODHit,java.lang.Long>	getODPrivilegeMasks(java.lang.String repositoryId, com.ibm.edms.od.ODFolder folder, java.util.List<com.ibm.edms.od.ODHit> items) Returns the privilege masks for the given OD Objects.
com.ibm.edms.od.ODServer	getODServer(java.lang.String repositoryId) Returns a connection to the IBM Content Manager OnDemand server for the given repository. The returned connection should only be used within a synchronized block using the object returned by: getSynchObject(String repositoryId, String repositoryType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getODServer

public com.ibm.edms.od.ODServer getODServer(java.lang.String repositoryId)

Returns a connection to the IBM Content Manager OnDemand server for the given repository.
The returned connection should only be used within a synchronized block using the object returned by:
getSynchObject(String repositoryId, String repositoryType)

Parameters:

repositoryId - The repository identifier, as defined in IBM Content Navigator.

Returns:

An com.ibm.edms.od.ODServer object that provides a connection to the IBM Content Manager OnDemand server. If the server is not found, this method returns null.

getODDocument

public com.ibm.edms.od.ODHit getODDocument(java.lang.String repositoryId,
                                           java.lang.String documentId,
                                           java.lang.String templateName)
                                    throws java.lang.Exception

Retrieves a Content Manager OnDemand document.

Access and use of this function and returned object must be placed with in a synchronized block, if getSynchObject returns non-null. Content can be retrieved from Content Manager, FileNet P8, Content Manager OnDemand, and CMIS repositories.

Parameters:

repositoryId - The repository identifier, as defined in IBM Content Navigator.

documentId - The document ID.

templateName -

Returns:

Throws:

java.lang.Exception

getODPrivilegeMasks

public java.util.HashMap<com.ibm.edms.od.ODHit,java.lang.Long> getODPrivilegeMasks(java.lang.String repositoryId,
                                                                                   com.ibm.edms.od.ODFolder folder,
                                                                                   java.util.List<com.ibm.edms.od.ODHit> items)
                                                                            throws java.lang.Exception

Returns the privilege masks for the given OD Objects.

Parameters:

repositoryId - The repository identifier, as defined in IBM Content Navigator.

folder - The ODFolder containing the ODHit items.

items - The list of ODHit items.

Returns:

Returns a mape of each ODHit to the associated privilege mask.

Throws:

java.lang.Exception

Since:

2.0.2.3

addODNote

public com.ibm.ecm.mediator.od.ODAnnotationMediator addODNote(java.lang.String repositoryId,
                                                              java.lang.String documentId,
                                                              java.lang.String templateName,
                                                              java.lang.String noteGroupName,
                                                              java.lang.String noteText,
                                                              boolean noteIsOKToCopy,
                                                              boolean noteIsPublic)

Adds a note for a document in a Content Manager OnDemand repository.

Access and use of this function and returned object must be placed with in a synchronized block, if getSynchObject returns non-null.

Parameters:

repositoryId - The repository identifier, as defined in IBM Content Navigator.

documentId - The document ID.

templateName - The folder name.

noteGroupName -

noteText -

noteIsOKToCopy -

noteIsPublic -

Returns:

getODNotes

public java.util.Vector[] getODNotes(java.lang.String repositoryId,
                                     java.lang.String documentId,
                                     java.lang.String templateName)
                              throws java.lang.Exception

Retrieves Notes for an OD document.

The Vector array returned will contain two entries. The first (index 0) contains a Vector containing an ODHit object representing the document itself. The second (index 1) contains a Vector containing all of the ODNote objects for the document.

Access and use of this function and returned object must be placed with in a synchronized block, if getSynchObject returns non-null.

Parameters:

repositoryId - The repository identifier, as defined in IBM Content Navigator.

documentId - The document ID.

templateName -

Returns:

Throws:

java.lang.Exception