public class SaWsContentService extends AbstractService
configured
Constructor and Description |
---|
SaWsContentService()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
Annotations |
getAnnotations(int token,
String xhdoc,
int elementNumber)
Returns the annotations by the specified document in its current revision.
|
SaWsContent |
getContent(int token,
String xhdoc,
int elementNumber)
Loads a document in its current revision from the backend system.
|
String |
getFilename(int token,
String xhdoc,
int elementNumber)
Loads the filename for a document from the backend system.
|
long |
getSize(int token,
String xhdoc,
int elementNumber)
Returns the total document size in archive.
|
SaWsContentStructure |
getStructure(int token,
String xhdoc)
With the help of getStructure you are able to receive all informations about the
documents
content structure of the actual document version.
|
void |
setAnnotations(int token,
Annotations annotations,
String xhdoc,
int elementNumber)
Sets the annotations of a document.
|
addToRequest, getConnection, getSession, isConfigured
public SaWsContent getContent(int token, String xhdoc, int elementNumber) throws SaWsAuthenticationException, SaWsDBException, SaWsRepositoryException, SaWsException
token
- to identify the session.xhdoc
- The ID of the documentelementNumber
- The number of the structured element, starting with 1.SaWsDBException
- if a database error occurs.SaWsAuthenticationException
- if an authentication error occurs.SaWsRepositoryException
- if a repository error occurs.SaWsException
SaClassicConnector.readDocument(java.lang.String, boolean, int)
public String getFilename(int token, String xhdoc, int elementNumber) throws SaWsAuthenticationException, SaWsDBException, SaWsRepositoryException, SaWsException
token
- to identify the session.xhdoc
- The ID of the documentelementNumber
- Element numberSaWsDBException
- if a database error occurs.SaWsAuthenticationException
- if an authentication error occurs.SaWsRepositoryException
- if a repository error occurs.SaWsException
SaClassicConnector.readDocumentFilename(java.lang.String,
boolean, int)
public Annotations getAnnotations(int token, String xhdoc, int elementNumber) throws SaWsAuthenticationException, SaWsDBException, SaWsRepositoryException, SaWsException
token
- to identify the session.xhdoc
- the ID of the document.elementNumber
- position of the element in the structured document.SaWsDBException
- if a database error occurs.SaWsAuthenticationException
- if an authentication error occurs.SaWsRepositoryException
- if a repository error occurs.SaWsException
public void setAnnotations(int token, Annotations annotations, String xhdoc, int elementNumber) throws SaWsAuthenticationException, SaWsDBException, SaWsRepositoryException, SaWsException
token
- to identify the session.annotations
- the annotations to set.xhdoc
- the ID of the document.elementNumber
- position of the element in the structured document (starts by 1).SaWsDBException
- if a database error occurs.SaWsAuthenticationException
- if an authentication error occurs.SaWsRepositoryException
- if a repository error occurs.SaWsException
public long getSize(int token, String xhdoc, int elementNumber) throws SaWsAuthenticationException, SaWsRepositoryException, SaWsException
token
- to identify the session.xhdoc
- the ID of the document.elementNumber
- position of the element in the structured document.SaWsAuthenticationException
- if an authentication error occurs.SaWsRepositoryException
- if a repository error occurs.SaWsException
public SaWsContentStructure getStructure(int token, String xhdoc) throws SaWsAuthenticationException, SaWsRepositoryException, SaWsException
token
- to identify the session.xhdoc
- the version id of the document (doesn't matter if the latest)SaWsAuthenticationException
- if an authentication error occurs.SaWsRepositoryException
- if a repository error occurs.SaWsException
- if an unexpected error occursCopyright © 2020 Hyland Software Germany GmbH. All rights reserved.