Interface IDocumentManager

All Superinterfaces:

IDisposable, IEntity

public interface IDocumentManager
extends IEntity

Manages the documents.

Method Summary

Modifier and Type	Method	Description
int	createDocument(String name, String description, String fileName, byte[] content, String comment)	Creates a document.
int	createDocumentRevision(int documentId, String fileName, byte[] content, String comment)	Creates a document revision.
void	deleteDocument(int documentId)	Deletes a document.
void	deleteDocumentRevision(int documentId, int documentRevisionNumber)	Deletes a document revision.
DocumentData	getDocument(int documentId)	Gets the last revision of the specified document.
byte[]	getDocumentContent(int documentId)	Gets the contents of the last revision of the document.
DocumentInfo	getDocumentInfo(int documentId)	Gets the document information of the specified document.
DocumentData	getDocumentRevision(int documentId, int documentRevisionNumber)	Gets a specific revision of the specified document.
byte[]	getDocumentRevisionContent(int documentId, int documentRevisionNumber)	Gets the contents of the specified revision of the document.
DocumentRevisionInfo	getDocumentRevisionInfo(int documentId, int documentRevisionNumber)	Gets the document revision information.
DocumentRevisionInfo[]	getDocumentRevisions(int documentId)	Gets information about the document revisions.
IInstance	getInstance()	The instance.
DocumentInfo	getRevisionDocumentInfo(int documentId, int documentRevisionNumber)	Gets the document information of the specified document revision.
void	setActiveRevision(int documentId, int documentRevisionNumber)	Set the active revision in a document.
void	updateDocument(int documentId, String name, String description)	Updates a document.

Methods inherited from interface IDisposable

addDisposedListener, removeDisposedListener

Methods inherited from interface IEntity

getUserContext, setUserContext

Method Details

createDocument

int createDocument(String name,
 String description,
 String fileName,
 byte[] content,
 String comment)
            throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a document.

Parameters:

name - Name of the document.

description - Description.

fileName - File name of the document.

content - The content of the document.

comment - Comment.

Returns:

Identifier of the document.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

createDocumentRevision

int createDocumentRevision(int documentId,
 String fileName,
 byte[] content,
 String comment)
                    throws Exception,
altitude.integrationServer.exceptions.ISException

Creates a document revision.

Parameters:

documentId - Identifier of the document.

fileName - File name of the document.

content - The content of the document revision.

comment - Comment.

Returns:

The document revision Number.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteDocument

void deleteDocument(int documentId)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a document.

Parameters:

documentId - Identifier of the document.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

deleteDocumentRevision

void deleteDocumentRevision(int documentId,
 int documentRevisionNumber)
                     throws Exception,
altitude.integrationServer.exceptions.ISException

Deletes a document revision.

Parameters:

documentId - Identifier of the document.

documentRevisionNumber - Number of the document revision.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDocument

DocumentData getDocument(int documentId)
                  throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the last revision of the specified document.

Parameters:

documentId - Identifier of the document.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDocumentContent

byte[] getDocumentContent(int documentId)
                   throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the contents of the last revision of the document.

Parameters:

documentId - Identifier of the document.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDocumentInfo

DocumentInfo getDocumentInfo(int documentId)
                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the document information of the specified document.

Parameters:

documentId - Identifier of the document.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDocumentRevision

DocumentData getDocumentRevision(int documentId,
 int documentRevisionNumber)
                          throws Exception,
altitude.integrationServer.exceptions.ISException

Gets a specific revision of the specified document.

Parameters:

documentId - Identifier of the document.

documentRevisionNumber - Number of the document revision.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDocumentRevisionContent

byte[] getDocumentRevisionContent(int documentId,
 int documentRevisionNumber)
                           throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the contents of the specified revision of the document.

Parameters:

documentId - Identifier of the document.

documentRevisionNumber - Number of the document revision.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDocumentRevisionInfo

DocumentRevisionInfo getDocumentRevisionInfo(int documentId,
 int documentRevisionNumber)
                                      throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the document revision information.

Parameters:

documentId - Identifier of the document.

documentRevisionNumber - Number of the document revision.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getDocumentRevisions

DocumentRevisionInfo[] getDocumentRevisions(int documentId)
                                     throws Exception,
altitude.integrationServer.exceptions.ISException

Gets information about the document revisions.

Parameters:

documentId - Identifier of the document.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getInstance

IInstance getInstance()
               throws Exception,
altitude.integrationServer.exceptions.ISException

The instance.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

getRevisionDocumentInfo

DocumentInfo getRevisionDocumentInfo(int documentId,
 int documentRevisionNumber)
                              throws Exception,
altitude.integrationServer.exceptions.ISException

Gets the document information of the specified document revision.

Parameters:

documentId - Identifier of the document.

documentRevisionNumber - Number of the document revision.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

setActiveRevision

void setActiveRevision(int documentId,
 int documentRevisionNumber)
                throws Exception,
altitude.integrationServer.exceptions.ISException

Set the active revision in a document.

Parameters:

documentId - Identifier of the document.

documentRevisionNumber - Number of the document revision.

Throws:

Exception

altitude.integrationServer.exceptions.ISException

updateDocument

void updateDocument(int documentId,
 String name,
 String description)
             throws Exception,
altitude.integrationServer.exceptions.ISException

Updates a document.

Parameters:

documentId - Identifier of the document.

name - Name of the document.

description - Description.

Throws:

Exception

altitude.integrationServer.exceptions.ISException