Package com.saperion.ngc.model.document

Class DocClassicConnectorService

java.lang.Object

com.saperion.ngc.model.ClassicConnectorService

com.saperion.ngc.model.document.DocClassicConnectorService

All Implemented Interfaces:

DocumentService, Service

public class DocClassicConnectorService
extends ClassicConnectorService
implements DocumentService

Service presenting document access methods provided by the classic connector.

Author:

mak

Nested Class Summary

Nested classes/interfaces inherited from interface com.saperion.ngc.model.document.DocumentService

DocumentService.AuditEvent

Field Summary

Fields inherited from class com.saperion.ngc.model.ClassicConnectorService

ddcCache

Fields inherited from interface com.saperion.ngc.model.document.DocumentService

COMP_ID, COMP_TYPE, IXOS_ANNO, NEEDED_COMP_ID, NEEDED_COMP_TYPE, NOTES_NAME

Constructor Summary

Constructors

Constructor	Description
DocClassicConnectorService()	Constructor.
DocClassicConnectorService(ConnectionProvider<com.saperion.connector.SaClassicConnector> connectionProvider)	Creates a new DocClassicConnectorService.
DocClassicConnectorService(jakarta.servlet.http.HttpSession session)	Creates a new DocClassicConnectorService.

Method Summary

Modifier and Type	Method	Description
final DocumentId	addDocument(List<FieldResultBean> properties, com.saperion.rmi.SaContentStream[] content, String comment, String ddcName, String acls)	Adds a new document to the archive.
DocumentId	addDocument(List<FieldResultBean> properties, com.saperion.rmi.SaContentStream[] content, String comment, String ddcName, String acls, Map<String,DocumentVariable> variables)	Adds a new document to the archive.
DocumentId	addDocument(Map<String,Object> properties, com.saperion.bean.ContentStream[] content, String comment, String ddcName, String acls, Map<String,DocumentVariable> variables)	Adds a new document to the archive.
final DocumentId	addDocument(Properties properties, com.saperion.rmi.SaContentStream[] content, String comment, String ddcName, String acls)	Deprecated. use addDocument(Map, ContentStream[], String, String, String, Map) instead
void	checkoutDocument(DocumentId id)	Checkout a document.
void	checkoutDocument(DocumentId id, boolean withShareBase, int[] shareBaseDocIds)	Checkout a document.
com.saperion.connector.service.RmiClientExtendedLookupEntryService	createLookupEntryService(com.saperion.connector.SaClassicConnector connector)
final DocumentId	createLookupItem(List<FieldResultBean> properties, String ddcName)	Create a new lookup entry.
final boolean	deleteDocument(DocumentId id)	Delete a document.
boolean	deleteDocument(DocumentId id, boolean finalDelete)	Delete a document.
void	discardCheckout(DocumentId id)	Discards checkout of a document.
ResultAccessData	getAccessData(DocumentId id)	Retrieves the access data for the specified document.
ResultAccessData	getAccessData(String revisionId)	Retrieves the access data fot the specified document.
String	getAcl(DocumentId docId)	Deprecated. use getAclNames(DocumentId) instead.
List<String>	getAclNames(DocumentId id)	Retrieves the ACLs for the specified document or lookup entry.
org.zkoss.image.Image	getActualImage(DocumentId id)	Reads the actual document image from backend.
final List<String>	getAllAcls()	Gets all ACL names.
final String	getAnnotations(String hDoc, int element)	Deprecated. use getAnnotations(String, int, boolean) instead
final String	getAnnotations(String hDoc, int element, boolean currentRevision)	Retrieves the annotations of a document.
DocumentArchiveMetaInfo	getArchiveMetaInfo(DocumentId documentId, boolean currentRevision)	Retrieves the meta information of a document that is stored on the archive.
DocumentArchiveMetaInfo	getArchiveMetaInfo(DocumentId documentId, boolean currentRevision, boolean previewMode)	Retrieves the meta information of a document that is stored on the archive.
ResultProperties	getDocumentInfo(DocumentId id)	Reads the document properties.
ResultProperties	getDocumentInfo(DocumentId id, boolean isDeleted)	Reads the document properties.
com.saperion.intf.SaPropertyValue[]	getDocumentMetadataFromArchive(DocumentId id, boolean currentRevision)	Returns the metadata of the document as read from the archive.
DocumentVersionInfo	getDocumentVersion(String versionId)	Returns the metadata of the specified version.
List<String>	getDocumentVersionIds(DocumentId id)	Returns a list of all version IDs for the specified document.
List<DocumentVersionInfo>	getDocumentVersions(DocumentId id)	Retrieves information about a document's versions.
List<DocumentVersionInfo>	getDocumentVersions(String ddcName, String objectId)	Retrieves information about a document's versions.
long	getElementSize(String hDoc, int element)	Retrieves the size of the specified element (in bytes).
Map<Integer,Long>	getElementSizes(String hDoc, List<Integer> elementsWithoutSize)	Retrieves a map with the sizes (in bytes) of elements for a given hDoc.
Set<Map.Entry<String,String>>	getFullTextFields(String ddcName, List<String> fullTextFields, String hdoc)	See DocumentService.getFullTextFields(String, List, String)
DocumentImageInfo	getImageInfo(DocumentId id)	Reads the document image informations from backend.
String	getIXOSAnnotation(String hdoc)	Reads the IXOS annotation for this document.
ResultLockData	getLockData(DocumentId id)	Returns the lock data for the specified document.
ResultLockData	getLockData(DocumentId id, boolean isDeleted)	Returns the lock data for the specified document.
ResultAccessData	getLookupEntryAccessData(DocumentId id)	Retrieves the access data for the specified lookup table entry.
int	getNextCounterValue(String ddcName, String fieldName, String dbFieldName)	Deprecated. Counter fields cannot be set by API any more.
String	getNotesContent(String hDoc)	Reads notes element.
PageList	getPageList(String hDoc, int element, boolean currentRevision)
InputStream	getPageListStream(DocumentId documentId, List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements)
final InputStream	getReleasedStream(String hDoc, int element, boolean currentRevision)	Retrieves the content of a document.
String	getReleaseHdoc(String hDoc)	Gets the last released hdoc.
List<com.saperion.connector.renditions.Rendition>	getRenderedDocument(DocumentId documentId, com.saperion.connector.formats.TargetFormat format, boolean currentRevision)	Renders the specified document to the target format.
ResultProperties	getRevisionInfo(DocumentId id)	Reads the properties of the specified revision.
Set<DocumentId>	getSessionLocks()	Returns a set of document IDs that are locked by this session.
final InputStream	getStream(String hDoc, int element)	Retrieves the content of a document.
final InputStream	getStream(String hDoc, int element, boolean currentRevision)	Retrieves the content of a document.
final InputStream	getStream(String hDoc, int element, boolean currentRevision, boolean withAnnotations)	Retrieves the content of a document.
InputStream	getStream(String hDoc, int element, boolean currentRevision, long start, long size)	Retrieves the content of a document.
BufferedImage	getThumbnail(DocumentId id, int height, int width, boolean color)	Retrieves a thumbnail for the specified document or null if no thumbnail is available.
String	getVariable(Properties variables, String key)	Reads the variable with the given case insensitive name.
boolean	hasBlackmarkers(DocumentId docId)	Checks for blackmarkers.
boolean	hasVariable(Properties variables, String key)	Checks, if the variable with the given case insensitive name exists.
final boolean	lockDocument(DocumentId id, DocumentService.AuditEvent event)	Lock document.
void	releaseDocument(DocumentId id, String comment)	Release a document.
final void	removeIXOSAnno(DocumentId docId)	Remove the IXOS annotation from content list.
String	resolveLatestHdoc(String oldHdoc)	Deprecated. use resolveLatestRevision(String) instead
String	resolveLatestRevision(String oldHdoc)	Resolve latest revision for the given hdoc.
com.saperion.bean.SapDocInfo	resolveSapURL(String url)	Resolves the given SAP URL and returns the SapDocInfo.
void	setAcl(DocumentId docId, String acl, String comment)	Deprecated. use setAclNames(DocumentId, List, String) instead.
void	setAclNames(DocumentId id, List<String> acls, String comment)	Sets the ACL for the specified document or lookup table entry.
final void	setAnnotations(String hDoc, int element, String annotations)	Sets the annotations of a document.
void	setDocumentRead(DocumentId id)	Sets the specified document's state to 'read' without creating a new revision.
void	setDocumentUnread(DocumentId id)	Sets the specified document's state to 'unread' without creating a new revision.
void	setNotesContent(String hDoc, String ddc, String content)	Writes the notes element.
final boolean	unlockDocument(DocumentId id)	Unlock document.
DocumentId	updateDocument(DocumentId docId, DataToUpdate data, UpdateSettings settings)	Updates the document identfied by docId using the specified data and settings.
final com.saperion.intf.SaSaveInfo	updateDocument(List<FieldResultBean> properties, com.saperion.bean.ContentStream[] content, String comment, DocumentId docId, boolean checkin, boolean lookup, int selectedImage)	Deprecated. Use updateDocument(DocumentId, DataToUpdate, UpdateSettings) instead
final com.saperion.intf.SaSaveInfo	updateDocument(Properties properties, com.saperion.bean.ContentStream[] content, String comment, DocumentId docId, boolean checkin, boolean lookup, int selectedImage)	Deprecated. Use updateDocument(DocumentId, DataToUpdate, UpdateSettings) instead
void	updateLookupItem(String sysRowId, List<FieldResultBean> properties, String ddcName)	Update a lookup entry.
void	updateLookupItem(String sysRowId, List<FieldResultBean> properties, String ddcName, boolean isDeleted)	Update a lookup entry.
void	writeAuditEvent(String hdoc, DocumentService.AuditEvent event, String remark)	Write audit event.

Methods inherited from class com.saperion.ngc.model.ClassicConnectorService

convertAuthenticationException, getCachedDDC, getConnectionProvider, getCurrentUserFromSession, getSession, getWfConnectionProvider, isActive

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.saperion.ngc.model.Service

isActive

Constructor Details

DocClassicConnectorService

public DocClassicConnectorService()

Constructor.

DocClassicConnectorService

public DocClassicConnectorService(jakarta.servlet.http.HttpSession session)

Creates a new DocClassicConnectorService.

Parameters:

session - HTTP session

DocClassicConnectorService

public DocClassicConnectorService(ConnectionProvider<com.saperion.connector.SaClassicConnector> connectionProvider)

Creates a new DocClassicConnectorService.

Parameters:

connectionProvider - connection provider

Method Details

getReleasedStream

public final InputStream getReleasedStream(String hDoc,
 int element,
 boolean currentRevision)
                                    throws BinaryUnavailableException,
AuthenticationException

Retrieves the content of a document. For use in servlets.

If the release feature is configured, and the logged in user doesn't have write permissions on the Document the last released document is returned, otherwise the current revision content stream is returned.

Specified by:

getReleasedStream in interface DocumentService

Parameters:

hDoc - document HDOC

element - sub document

currentRevision - the current revision

Returns:

InputStream with content

Throws:

BinaryUnavailableException - when the binary content could not be accessed.

AuthenticationException - when the user is not authenticated

See Also:

• DocumentService.getReleasedStream(java.lang.String, int, boolean)

getStream

public final InputStream getStream(String hDoc,
 int element,
 boolean currentRevision)
                            throws BinaryUnavailableException,
AuthenticationException

Retrieves the content of a document. For use in servlets.

Specified by:

getStream in interface DocumentService

Parameters:

hDoc - document HDOC

element - sub document

currentRevision - currentRevision

Returns:

InputStream with content

Throws:

BinaryUnavailableException - when the binary content could not be accessed.

AuthenticationException - when the user is not authenticated

See Also:

• DocumentService.getStream(java.lang.String, int, boolean)

getStream

public final InputStream getStream(String hDoc,
 int element,
 boolean currentRevision,
 boolean withAnnotations)
                            throws BinaryUnavailableException,
AuthenticationException

Retrieves the content of a document. For use in servlets.

Specified by:

getStream in interface DocumentService

Parameters:

hDoc - document HDOC

element - sub document

currentRevision - currentRevision

withAnnotations - * withAnnotations

Returns:

InputStream with content

Throws:

BinaryUnavailableException - when the binary content could not be accessed.

AuthenticationException - when the user is not authenticated

See Also:

• DocumentService.getStream(java.lang.String, int, boolean,boolean)

getStream

public final InputStream getStream(String hDoc,
 int element)
                            throws BinaryUnavailableException,
AuthenticationException

Retrieves the content of a document. For use in servlets.

Specified by:

getStream in interface DocumentService

Parameters:

hDoc - document HDOC

element - sub document

Returns:

InputStream with content

Throws:

BinaryUnavailableException - when the binary content could not be accessed.

AuthenticationException - when the user is not authenticated

See Also:

• DocumentService.getStream(java.lang.String, int)

getStream

public InputStream getStream(String hDoc,
 int element,
 boolean currentRevision,
 long start,
 long size)
                      throws BinaryUnavailableException,
AuthenticationException

Retrieves the content of a document. For use in servlets.

Specified by:

getStream in interface DocumentService

Parameters:

hDoc - document HDOC

element - sub document

currentRevision - currentRevision

start - Startbyte

size - Streamsize

Returns:

InputStream with content

Throws:

BinaryUnavailableException - when the binary content could not be accessed.

AuthenticationException - when the user is not authenticated

See Also:

• DocumentService.getStream(java.lang.String, int, boolean, long, long)

getPageList

public PageList getPageList(String hDoc,
 int element,
 boolean currentRevision)
                     throws BinaryUnavailableException,
AuthenticationException

Specified by:

getPageList in interface DocumentService

Parameters:

hDoc - document HDOC

element - sub document

currentRevision - currentRevision

Returns:

Pagelist

Throws:

BinaryUnavailableException - when the binary content could not be accessed.

AuthenticationException - when the user is not authenticated

See Also:

• DocumentService.getPageList(java.lang.String, int, boolean)

getAnnotations

@Deprecated
public final String getAnnotations(String hDoc,
 int element)
                            throws AuthenticationException,
SystemException

Deprecated.

use getAnnotations(String, int, boolean) instead

Retrieves the annotations of a document.

Specified by:

getAnnotations in interface DocumentService

Parameters:

hDoc - document hDoc

element - document element

Returns:

annotations string

Throws:

AuthenticationException - if user identification fails

SystemException - in case of common system error

See Also:

• DocumentService.getAnnotations(java.lang.String, int)

getAnnotations

public final String getAnnotations(String hDoc,
 int element,
 boolean currentRevision)
                            throws AuthenticationException,
SystemException

Retrieves the annotations of a document.

Specified by:

getAnnotations in interface DocumentService

Parameters:

hDoc - document hDoc

element - document element

currentRevision - currentRevision

Returns:

annotations string

Throws:

AuthenticationException - if user identification fails

SystemException - in case of common system error

See Also:

• DocumentService.getAnnotations(java.lang.String, int,boolean)

setAnnotations

public final void setAnnotations(String hDoc,
 int element,
 String annotations)
                          throws AuthenticationException,
SystemException

Sets the annotations of a document.

Specified by:

setAnnotations in interface DocumentService

Parameters:

hDoc - document hDoc

element - document element

annotations - annotations string

Throws:

AuthenticationException - if user identification fails

SystemException - in case of common system error

See Also:

• DocumentService.setAnnotations(java.lang.String, int, java.lang.String)

getAccessData

public ResultAccessData getAccessData(DocumentId id)
                               throws SystemException,
AuthenticationException

Retrieves the access data for the specified document.

Specified by:

getAccessData in interface DocumentService

Parameters:

id - document id

Returns:

access data

Throws:

SystemException - System exception

AuthenticationException - Authentication exception

See Also:

• DocumentService.getAccessData(com.saperion.ngc.model.document.DocumentId)

getAccessData

public ResultAccessData getAccessData(String revisionId)
                               throws SystemException,
AuthenticationException

Retrieves the access data fot the specified document. For use in servlets.

Specified by:

getAccessData in interface DocumentService

Parameters:

revisionId - document's revision id

Returns:

access data

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.getAccessData(java.lang.String)

getLookupEntryAccessData

public ResultAccessData getLookupEntryAccessData(DocumentId id)
                                          throws SystemException,
AuthenticationException

Description copied from interface: DocumentService

Retrieves the access data for the specified lookup table entry.

Specified by:

getLookupEntryAccessData in interface DocumentService

Parameters:

id - the id of the entry

Returns:

the access data for the current user

Throws:

SystemException - system error when getting access data

AuthenticationException - authentication error when getting access data

createLookupEntryService

public com.saperion.connector.service.RmiClientExtendedLookupEntryService createLookupEntryService(com.saperion.connector.SaClassicConnector connector)

getAcl

@Deprecated
public String getAcl(DocumentId docId)
              throws SystemException,
AuthenticationException

Deprecated.

use getAclNames(DocumentId) instead. Will be removed in 8.1.

Retrieves the ACLs for the specified document.

Specified by:

getAcl in interface DocumentService

Parameters:

docId - document id

Returns:

ACL string (separated by SaConstants.ACL_DELIMITER to get multiple ACLs)

Throws:

SystemException - System exception

AuthenticationException - Authentication exception

See Also:

• DocumentService.getAcl(com.saperion.ngc.model.document.DocumentId)

getAclNames

public List<String> getAclNames(DocumentId id)
                         throws SystemException,
AuthenticationException

Description copied from interface: DocumentService

Retrieves the ACLs for the specified document or lookup entry.

Specified by:

getAclNames in interface DocumentService

Parameters:

id - document id

Returns:

a list of ACL names that are set on the specified document

Throws:

SystemException - System exception

AuthenticationException - Authentication exception

getAllAcls

public final List<String> getAllAcls()
                              throws SystemException,
AuthenticationException

Gets all ACL names.

Specified by:

getAllAcls in interface DocumentService

Returns:

list of ACL names

Throws:

AuthenticationException

SystemException

See Also:

• DocumentService.getAllAcls()

setAcl

@Deprecated
public void setAcl(DocumentId docId,
 String acl,
 String comment)
            throws SystemException,
AuthenticationException

Deprecated.

use setAclNames(DocumentId, List, String) instead. Will be removed in 8.1.

Sets the ACLs for the specified document.

Specified by:

setAcl in interface DocumentService

Parameters:

docId - document id

acl - ACL string (separated by SaConstants.ACL_DELIMITER to set multiple ACLs)

comment - revision comment

Throws:

SystemException - System exception

AuthenticationException - Authentication exception

See Also:

• DocumentService.setAcl(com.saperion.ngc.model.document.DocumentId, java.lang.String, java.lang.String)

setAclNames

public void setAclNames(DocumentId id,
 List<String> acls,
 String comment)
                 throws SystemException,
AuthenticationException

Description copied from interface: DocumentService

Sets the ACL for the specified document or lookup table entry.

Specified by:

setAclNames in interface DocumentService

Parameters:

id - document id

acls - a list of ACL names to set on the specified document

comment - revision comment

Throws:

SystemException - System exception

AuthenticationException - Authentication exception

lockDocument

public final boolean lockDocument(DocumentId id,
 DocumentService.AuditEvent event)
                           throws SystemException,
AuthenticationException,
DocumentLockException

Lock document.

Specified by:

lockDocument in interface DocumentService

Parameters:

id - Document ID

Returns:

True, if done

Throws:

SystemException - system exception

AuthenticationException - authentication exception

DocumentLockException - lock exception

See Also:

• DocumentService.lockDocument(com.saperion.ngc.model.document.DocumentId, com.saperion.ngc.model.document.DocumentService.AuditEvent)

unlockDocument

public final boolean unlockDocument(DocumentId id)
                             throws SystemException,
AuthenticationException,
DocumentLockException

Unlock document.

Specified by:

unlockDocument in interface DocumentService

Parameters:

id - Document ID

Returns:

True, if done

Throws:

SystemException - system exception

AuthenticationException - authentication exception

DocumentLockException - lock exception

See Also:

• DocumentService.unlockDocument(com.saperion.ngc.model.document.DocumentId)

deleteDocument

public final boolean deleteDocument(DocumentId id)
                             throws DocumentAccessException,
SystemException,
AuthenticationException

Delete a document.

Specified by:

deleteDocument in interface DocumentService

Parameters:

id - Document id

Returns:

True, if done

Throws:

DocumentAccessException - document access exception

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.deleteDocument(com.saperion.ngc.model.document.DocumentId)

deleteDocument

public boolean deleteDocument(DocumentId id,
 boolean finalDelete)
                       throws SystemException,
AuthenticationException,
DocumentAccessException

Delete a document.

Specified by:

deleteDocument in interface DocumentService

Parameters:

id - Document id

finalDelete - set to true if the document was already marked as deleted (sysindexstate = 65002) to avoid checking of document access, which will fail otherwise

Returns:

True, if done

Throws:

SystemException - system exception

AuthenticationException - authentication exception

DocumentAccessException - document access exception

See Also:

• (com.saperion.ngc.model.document.DocumentId, boolean)

updateDocument

@Deprecated
public final com.saperion.intf.SaSaveInfo updateDocument(Properties properties,
 com.saperion.bean.ContentStream[] content,
 String comment,
 DocumentId docId,
 boolean checkin,
 boolean lookup,
 int selectedImage)
                                                  throws DocumentAccessException,
SystemException,
AuthenticationException

Deprecated.

Use updateDocument(DocumentId, DataToUpdate, UpdateSettings) instead

Update a document.

Specified by:

updateDocument in interface DocumentService

Parameters:

properties - Properties

content - Document content

comment - revision comment

docId - Document ID

checkin - True for checkin

lookup - True for lookup table

selectedImage - Selected image

Returns:

true if success

Throws:

DocumentAccessException - document access exception

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.updateDocument(java.util.Properties, com.saperion.bean.ContentStream[], java.lang.String, com.saperion.ngc.model.document.DocumentId, boolean, boolean, int)

updateDocument

public DocumentId updateDocument(DocumentId docId,
 DataToUpdate data,
 UpdateSettings settings)
                          throws SystemException,
AuthenticationException,
DocumentAccessException

Updates the document identfied by docId using the specified data and settings.

Specified by:

updateDocument in interface DocumentService

Parameters:

docId - ID of the document to update

data - data to update (content and/or metadata)

settings - setting to use when updating

Returns:

ID of the updated document

Throws:

SystemException - system error when updating

AuthenticationException - insufficient rights or logged off

DocumentAccessException - insufficient rights (ACL-based)

See Also:

• (com.saperion.ngc.model.document.DocumentId, com.saperion.ngc.model.document.DataToUpdate, com.saperion.ngc.model.document.UpdateSettings)

getIXOSAnnotation

public String getIXOSAnnotation(String hdoc)
                         throws AuthenticationException,
SystemException

Reads the IXOS annotation for this document.

Specified by:

getIXOSAnnotation in interface DocumentService

Parameters:

hdoc - Document ID

Returns:

ISOS Annotation as string

Throws:

AuthenticationException - AuthenticationException

SystemException - SystemException

See Also:

• DocumentService.getIXOSAnnotation(java.lang.String)

removeIXOSAnno

public final void removeIXOSAnno(DocumentId docId)
                          throws DocumentAccessException,
SystemException,
AuthenticationException

Remove the IXOS annotation from content list.

Specified by:

removeIXOSAnno in interface DocumentService

Parameters:

docId - Document ID

Throws:

DocumentAccessException - document access exception

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.removeIXOSAnno(com.saperion.ngc.model.document.DocumentId)

updateDocument

@Deprecated
public final com.saperion.intf.SaSaveInfo updateDocument(List<FieldResultBean> properties,
 com.saperion.bean.ContentStream[] content,
 String comment,
 DocumentId docId,
 boolean checkin,
 boolean lookup,
 int selectedImage)
                                                  throws DocumentAccessException,
SystemException,
AuthenticationException

Deprecated.

Use updateDocument(DocumentId, DataToUpdate, UpdateSettings) instead

Update a document.

Specified by:

updateDocument in interface DocumentService

Parameters:

properties - Properties

content - Document content

comment - revision comment

docId - Document ID

checkin - True for checkin

lookup - True for lookup table

selectedImage - Selected image

Returns:

true if success

Throws:

DocumentAccessException - document access exception

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.updateDocument(java.util.List, com.saperion.bean.ContentStream[], java.lang.String, com.saperion.ngc.model.document.DocumentId, boolean, boolean, int)

addDocument

public final DocumentId addDocument(List<FieldResultBean> properties,
 com.saperion.rmi.SaContentStream[] content,
 String comment,
 String ddcName,
 String acls)
                             throws SystemException,
AuthenticationException

Adds a new document to the archive.

Specified by:

addDocument in interface DocumentService

Parameters:

properties - meta data

content - content

comment - comment

ddcName - name of the ddc

acls - semicolon separated string of ACL names

Returns:

id of the new document

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.addDocument(java.util.List, com.saperion.rmi.SaContentStream[], java.lang.String, java.lang.String, java.lang.String)

addDocument

@Deprecated
public final DocumentId addDocument(Properties properties,
 com.saperion.rmi.SaContentStream[] content,
 String comment,
 String ddcName,
 String acls)
                             throws SystemException,
AuthenticationException

Deprecated.

use addDocument(Map, ContentStream[], String, String, String, Map) instead

Adds a new document to the archive.

Specified by:

addDocument in interface DocumentService

Parameters:

properties - meta data

content - content

comment - comment

ddcName - name of the ddc

acls - semicolon separated string of ACL names

Returns:

id of the new document

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.addDocument(java.util.Properties, com.saperion.rmi.SaContentStream[], java.lang.String, java.lang.String, java.lang.String)

addDocument

public DocumentId addDocument(List<FieldResultBean> properties,
 com.saperion.rmi.SaContentStream[] content,
 String comment,
 String ddcName,
 String acls,
 Map<String,DocumentVariable> variables)
                       throws SystemException,
AuthenticationException

Adds a new document to the archive.

Specified by:

addDocument in interface DocumentService

Parameters:

properties - meta data

content - content

comment - comment

ddcName - name of the ddc

acls - semicolon separated string of ACL names

variables - variables to add to the document

Returns:

id of the new document

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.addDocument(java.util.List, com.saperion.rmi.SaContentStream[], java.lang.String, java.lang.String, java.lang.String, java.util.Map)

addDocument

public DocumentId addDocument(Map<String,Object> properties,
 com.saperion.bean.ContentStream[] content,
 String comment,
 String ddcName,
 String acls,
 Map<String,DocumentVariable> variables)
                       throws SystemException,
AuthenticationException

Adds a new document to the archive.

Specified by:

addDocument in interface DocumentService

Parameters:

properties - meta data

content - content

comment - comment

ddcName - name of the ddc

acls - semicolon separated string of ACL names

variables - variables to add to the document

Returns:

id of the new document

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.addDocument(java.util.Map, com.saperion.bean.ContentStream[], java.lang.String, java.lang.String, java.lang.String, java.util.Map)

createLookupItem

public final DocumentId createLookupItem(List<FieldResultBean> properties,
 String ddcName)
                                  throws SystemException,
AuthenticationException

Create a new lookup entry.

Specified by:

createLookupItem in interface DocumentService

Parameters:

properties - meta data

ddcName - name of the ddc

Returns:

id of the new document

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.createLookupItem(java.util.List, java.lang.String)

updateLookupItem

public void updateLookupItem(String sysRowId,
 List<FieldResultBean> properties,
 String ddcName)
                      throws SystemException,
AuthenticationException

Update a lookup entry.

Specified by:

updateLookupItem in interface DocumentService

Parameters:

sysRowId - SysRowId of the lookup entry

properties - meta data

ddcName - name of the ddc

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.updateLookupItem(java.lang.String, java.util.List, java.lang.String)

updateLookupItem

public void updateLookupItem(String sysRowId,
 List<FieldResultBean> properties,
 String ddcName,
 boolean isDeleted)
                      throws SystemException,
AuthenticationException

Update a lookup entry.

Specified by:

updateLookupItem in interface DocumentService

Parameters:

sysRowId - SysRowId of the lookup entry

properties - meta data

ddcName - name of the ddc

isDeleted - indicates if the document is deleted or not

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.updateLookupItem(String, List, String, boolean)

getLockData

public ResultLockData getLockData(DocumentId id)
                           throws SystemException,
AuthenticationException

Returns the lock data for the specified document.

Specified by:

getLockData in interface DocumentService

Parameters:

id - document id

Returns:

lock data

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.getLockData(com.saperion.ngc.model.document.DocumentId)

getLockData

public ResultLockData getLockData(DocumentId id,
 boolean isDeleted)
                           throws SystemException,
AuthenticationException

Returns the lock data for the specified document.

Specified by:

getLockData in interface DocumentService

Parameters:

id - document id

isDeleted - pass true if the document is deleted (sysIndexState = 65002)

Returns:

lock data

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.getLockData(com.saperion.ngc.model.document.DocumentId)

checkoutDocument

public void checkoutDocument(DocumentId id)
                      throws SystemException,
AuthenticationException,
DocumentAccessException,
CheckoutFailedException

Checkout a document.

Specified by:

checkoutDocument in interface DocumentService

Parameters:

id - Document id

Throws:

DocumentAccessException

SystemException - System exception

AuthenticationException - Authentication exception

CheckoutFailedException - thrown when the checkout-operation did not cause an exception but did not actually checkout the document. Happens on image-files.

See Also:

• (com.saperion.ngc.model.document.DocumentId)

checkoutDocument

public void checkoutDocument(DocumentId id,
 boolean withShareBase,
 int[] shareBaseDocIds)
                      throws SystemException,
AuthenticationException,
DocumentAccessException,
CheckoutFailedException

Checkout a document.

Specified by:

checkoutDocument in interface DocumentService

Parameters:

id - Document id

withShareBase - true if open document is checked out with ShareBase else false

shareBaseDocIds - Array of sharebase doc ids for open checkout docs

Throws:

DocumentAccessException

SystemException - System exception

AuthenticationException - Authentication exception

CheckoutFailedException - thrown when the checkout-operation did not cause an exception but did not actually checkout the document. Happens on image-files.

See Also:

• (com.saperion.ngc.model.document.DocumentId)

releaseDocument

public void releaseDocument(DocumentId id,
 String comment)
                     throws SystemException,
AuthenticationException,
DocumentAccessException

Release a document.

Specified by:

releaseDocument in interface DocumentService

Parameters:

id - Document id

comment - the revision comment

Throws:

DocumentAccessException

SystemException - System exception

AuthenticationException - Authentication exception

See Also:

• (com.saperion.ngc.model.document.DocumentId)

getReleaseHdoc

public String getReleaseHdoc(String hDoc)
                      throws AuthenticationException,
SystemException

Gets the last released hdoc.

Specified by:

getReleaseHdoc in interface DocumentService

Parameters:

hDoc - the h doc

Returns:

the release hdoc

Throws:

AuthenticationException - the authentication exception

SystemException - the system exception

See Also:

• DocumentService.getReleaseHdoc(java.lang.String)

discardCheckout

public void discardCheckout(DocumentId id)
                     throws SystemException,
AuthenticationException,
DocumentAccessException

Discards checkout of a document.

Specified by:

discardCheckout in interface DocumentService

Parameters:

id - Document id

Throws:

DocumentAccessException

SystemException - System exception

AuthenticationException - Authentication exception

See Also:

• DocumentService.discardCheckout(com.saperion.ngc.model.document.DocumentId)

getRevisionInfo

public ResultProperties getRevisionInfo(DocumentId id)
                                 throws DatabaseException,
AuthenticationException,
SystemException,
DocumentIdentificationException

Reads the properties of the specified revision.

Specified by:

getRevisionInfo in interface DocumentService

Parameters:

id - id identifying the revision (revision-id must be set!)

Returns:

revision properties

Throws:

DatabaseException - database exception

AuthenticationException - authentication exception

SystemException - system exception

DocumentIdentificationException - if the id does not contain the revision id

See Also:

• (com.saperion.ngc.model.document.DocumentId)

getDocumentInfo

public ResultProperties getDocumentInfo(DocumentId id)
                                 throws SystemException,
AuthenticationException

Reads the document properties.

Specified by:

getDocumentInfo in interface DocumentService

Parameters:

id - Document id

Returns:

Document properties

Throws:

SystemException - System exception

AuthenticationException - Authentication exception

See Also:

• DocumentService.getDocumentInfo(com.saperion.ngc.model.document.DocumentId)

getDocumentInfo

public ResultProperties getDocumentInfo(DocumentId id,
 boolean isDeleted)
                                 throws SystemException,
AuthenticationException

Reads the document properties.

Specified by:

getDocumentInfo in interface DocumentService

Parameters:

id - Document id

isDeleted - pass true if the document is deleted (sysIndexState = 65002)

Returns:

Document properties

Throws:

SystemException - System exception

AuthenticationException - Authentication exception

See Also:

• DocumentService.getDocumentInfo(com.saperion.ngc.model.document.DocumentId)

getDocumentVersionIds

public List<String> getDocumentVersionIds(DocumentId id)
                                   throws SystemException,
AuthenticationException

Returns a list of all version IDs for the specified document.

Specified by:

getDocumentVersionIds in interface DocumentService

Parameters:

id - document ID

Returns:

list of version IDs

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• (com.saperion.ngc.model.document.DocumentId)

getDocumentVersion

public DocumentVersionInfo getDocumentVersion(String versionId)
                                       throws DatabaseException,
AuthenticationException,
SystemException

Returns the metadata of the specified version.

Specified by:

getDocumentVersion in interface DocumentService

Parameters:

versionId - ID of the version

Returns:

version information

Throws:

DatabaseException - database exception

AuthenticationException - authentication exception

SystemException - system exception

See Also:

• DocumentService.getDocumentVersion(java.lang.String)

getDocumentVersions

public List<DocumentVersionInfo> getDocumentVersions(DocumentId id)
                                              throws SystemException,
AuthenticationException

Retrieves information about a document's versions.

Specified by:

getDocumentVersions in interface DocumentService

Parameters:

id - document id

Returns:

list with DocumentVersionInfo objects

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• (com.saperion.ngc.model.document.DocumentId)

getDocumentVersions

public List<DocumentVersionInfo> getDocumentVersions(String ddcName,
 String objectId)
                                              throws SystemException,
AuthenticationException

Retrieves information about a document's versions. For use in servlets.

Specified by:

getDocumentVersions in interface DocumentService

Parameters:

ddcName - ddc name

objectId - object id of the document (SysRowId)

Returns:

list with DocumentVersionInfo objects

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.getDocumentVersions(java.lang.String, java.lang.String)

resolveLatestHdoc

@Deprecated
public String resolveLatestHdoc(String oldHdoc)
                         throws com.saperion.exception.SaSystemException,
com.saperion.exception.SaAuthenticationException

Deprecated.

use resolveLatestRevision(String) instead

Resolve latest hdoc(revision) for the given hdoc.

Specified by:

resolveLatestHdoc in interface DocumentService

Parameters:

oldHdoc - the old hdoc to lookup

Returns:

the latest hdoc (revision) of the given hdoc

Throws:

com.saperion.exception.SaSystemException - system exception

com.saperion.exception.SaAuthenticationException - authentication exception

See Also:

• DocumentService.resolveLatestHdoc(java.lang.String)

resolveLatestRevision

public String resolveLatestRevision(String oldHdoc)
                             throws SystemException,
AuthenticationException

Resolve latest revision for the given hdoc.

Specified by:

resolveLatestRevision in interface DocumentService

Parameters:

oldHdoc - the old hdoc to lookup

Returns:

the latest hdoc (revision) of the given hdoc

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.resolveLatestRevision(java.lang.String)

getThumbnail

public BufferedImage getThumbnail(DocumentId id,
 int height,
 int width,
 boolean color)
                           throws SystemException,
AuthenticationException

Retrieves a thumbnail for the specified document or null if no thumbnail is available.

Specified by:

getThumbnail in interface DocumentService

Parameters:

id - document id

height - thumbnail height

width - thumbnail width

color - color option

Returns:

thumbnail as BufferedImage in PNG format

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.getThumbnail(com.saperion.ngc.model.document.DocumentId, int, int, boolean)

writeAuditEvent

public void writeAuditEvent(String hdoc,
 DocumentService.AuditEvent event,
 String remark)
                     throws SystemException,
AuthenticationException

Write audit event.

Specified by:

writeAuditEvent in interface DocumentService

Parameters:

hdoc - Document HDOC

event - Event type

remark - Remark

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.writeAuditEvent(java.lang.String, com.saperion.ngc.model.document.DocumentService.AuditEvent, java.lang.String)

getSessionLocks

public Set<DocumentId> getSessionLocks()

Returns a set of document IDs that are locked by this session.

Specified by:

getSessionLocks in interface DocumentService

Returns:

set of document IDs

See Also:

• DocumentService.getSessionLocks()

getNextCounterValue

@Deprecated
public int getNextCounterValue(String ddcName,
 String fieldName,
 String dbFieldName)
                        throws SystemException,
AuthenticationException

Deprecated.

Counter fields cannot be set by API any more. This method is contained for backwards-compatibility and will be removed in a future version.

This method is only contained for compatibility reasons and always returns -1 because counter-fields cannot be set by API any more.

Specified by:

getNextCounterValue in interface DocumentService

Parameters:

ddcName - name of the ddc

fieldName - name of the counter field

dbFieldName - database name of the counter field

Returns:

next possible value as int

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.getNextCounterValue(java.lang.String, java.lang.String, java.lang.String)

getImageInfo

public DocumentImageInfo getImageInfo(DocumentId id)
                               throws SystemException,
AuthenticationException

Reads the document image informations from backend.

Specified by:

getImageInfo in interface DocumentService

Parameters:

id - Document Id

Returns:

Image info

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.getImageInfo(com.saperion.ngc.model.document.DocumentId)

getActualImage

public org.zkoss.image.Image getActualImage(DocumentId id)
                                     throws SystemException,
AuthenticationException

Reads the actual document image from backend.

Specified by:

getActualImage in interface DocumentService

Parameters:

id - Document Id

Returns:

Image

Throws:

SystemException - system exception

AuthenticationException - authentication exception

See Also:

• DocumentService.getActualImage(com.saperion.ngc.model.document.DocumentId)

getPageListStream

public InputStream getPageListStream(DocumentId documentId,
 List<DocumentArchiveMetaInfo.ElementArchiveMetaInfo> documentElements)

Specified by:

getPageListStream in interface DocumentService

Parameters:

documentId - ID of the document

documentElements - list of the document's elements

Returns:

stream containing the page-list

hasVariable

public boolean hasVariable(Properties variables,
 String key)

Checks, if the variable with the given case insensitive name exists.

Specified by:

hasVariable in interface DocumentService

Parameters:

variables - Variables

key - Key name

Returns:

True, if exists

See Also:

• DocumentService.hasVariable(java.util.Properties, java.lang.String)

getVariable

public String getVariable(Properties variables,
 String key)

Reads the variable with the given case insensitive name.

Specified by:

getVariable in interface DocumentService

Parameters:

variables - Variables

key - Key name

Returns:

Variable value or null, if variable don't exists

See Also:

• DocumentService.getVariable(java.util.Properties, java.lang.String)

getNotesContent

public String getNotesContent(String hDoc)
                       throws SystemException,
AuthenticationException

Reads notes element.

Specified by:

getNotesContent in interface DocumentService

Parameters:

hDoc - Document id

Returns:

Element content

Throws:

SystemException - System exception

AuthenticationException - Authentication exception

See Also:

• DocumentService.getNotesContent(java.lang.String)

setNotesContent

public void setNotesContent(String hDoc,
 String ddc,
 String content)
                     throws SystemException,
AuthenticationException

Writes the notes element.

Specified by:

setNotesContent in interface DocumentService

Parameters:

hDoc - Document id

ddc - DDC name

content - element content

Throws:

SystemException - System exception

AuthenticationException - Authentication exception

See Also:

• DocumentService.setNotesContent(java.lang.String,java.lang.String, java.lang.String)

resolveSapURL

public com.saperion.bean.SapDocInfo resolveSapURL(String url)
                                           throws SystemException,
SapViewerUrlException,
AuthenticationException

Resolves the given SAP URL and returns the SapDocInfo.

Specified by:

resolveSapURL in interface DocumentService

Parameters:

url - URL

Returns:

SAP Document info

Throws:

SystemException - System exception

SapViewerUrlException - resolving the url failed

AuthenticationException - Authentication exception

See Also:

• DocumentService.resolveSapURL(java.lang.String)

getElementSizes

public Map<Integer,Long> getElementSizes(String hDoc,
 List<Integer> elementsWithoutSize)
                                  throws SystemException,
AuthenticationException

Retrieves a map with the sizes (in bytes) of elements for a given hDoc.

Specified by:

getElementSizes in interface DocumentService

Parameters:

hDoc - hDoc of the document

elementsWithoutSize - List of elementNumbers for elements without a file size.

Returns:

Map of Element Numbers and its sizes in bytes

Throws:

SystemException - System exception

AuthenticationException - Authentication exception

See Also:

• DocumentService.getElementSizes(java.lang.String, java.util.List)

getElementSize

public long getElementSize(String hDoc,
 int element)
                    throws SystemException,
AuthenticationException

Retrieves the size of the specified element (in bytes).

Specified by:

getElementSize in interface DocumentService

Parameters:

hDoc - hDoc of the document

element - number of the element

Returns:

size in bytes

Throws:

SystemException - System exception

AuthenticationException - Authentication exception

See Also:

• DocumentService.getElementSize(java.lang.String, int)

getArchiveMetaInfo

public DocumentArchiveMetaInfo getArchiveMetaInfo(DocumentId documentId,
 boolean currentRevision)
                                           throws AuthenticationException,
SystemException

Retrieves the meta information of a document that is stored on the archive.

Specified by:

getArchiveMetaInfo in interface DocumentService

Parameters:

documentId - The id of the document the information is about

currentRevision - if true, the latest revision of the document will be retrieved

Returns:

The meta information of a document that is stored on the archive.

Throws:

AuthenticationException

SystemException

See Also:

• DocumentService.getArchiveMetaInfo(DocumentId, boolean)

getArchiveMetaInfo

public DocumentArchiveMetaInfo getArchiveMetaInfo(DocumentId documentId,
 boolean currentRevision,
 boolean previewMode)
                                           throws AuthenticationException,
SystemException

Retrieves the meta information of a document that is stored on the archive.

Specified by:

getArchiveMetaInfo in interface DocumentService

Parameters:

documentId - The id of the document the information is about

currentRevision - if true, the latest revision of the document will be retrieved

previewMode - used to notify the document service that a preview-viewer in a mask requests the archive meta info (currently not in use)

Returns:

The meta information of a document that is stored on the archive.

Throws:

AuthenticationException

SystemException

See Also:

• DocumentService.getArchiveMetaInfo(DocumentId, boolean, boolean)

hasBlackmarkers

public boolean hasBlackmarkers(DocumentId docId)
                        throws AuthenticationException,
SystemException

Checks for blackmarkers.

Specified by:

hasBlackmarkers in interface DocumentService

Parameters:

docId - The id of the document in question

Returns:

Whether the document has blackmarker annotations

Throws:

AuthenticationException

SystemException

See Also:

• DocumentService.hasBlackmarkers(DocumentId)

getRenderedDocument

public List<com.saperion.connector.renditions.Rendition> getRenderedDocument(DocumentId documentId,
 com.saperion.connector.formats.TargetFormat format,
 boolean currentRevision)
                                                                      throws SystemException,
AuthenticationException,
RenderingFailedException

Renders the specified document to the target format.

Specified by:

getRenderedDocument in interface DocumentService

Parameters:

documentId - the document id

format - the target format

currentRevision - if true, the current revision of the document will be rendered

Returns:

the rendered document

Throws:

SystemException - System exception when rendering

AuthenticationException - authentication exception when rendering

RenderingFailedException - rendering the document failed

See Also:

• (com.saperion.ngc.model.document.DocumentId, com.saperion.connector.formats.TargetFormat, boolean)

getDocumentMetadataFromArchive

public com.saperion.intf.SaPropertyValue[] getDocumentMetadataFromArchive(DocumentId id,
 boolean currentRevision)
                                                                   throws DocumentIdentificationException,
SystemException,
AuthenticationException,
DatabaseException

Returns the metadata of the document as read from the archive. The database will not be used to load the data.

Specified by:

getDocumentMetadataFromArchive in interface DocumentService

Parameters:

id - document id

currentRevision - resolve current revision or not

Returns:

document's metadata

Throws:

DocumentIdentificationException - revision id not set in document id

SystemException - system exception when loading metadata

AuthenticationException - authentication exception when loading metadata

DatabaseException - ddc exception when loading metadata

setDocumentRead

public void setDocumentRead(DocumentId id)
                     throws DocumentIdentificationException,
SystemException,
AuthenticationException

Sets the specified document's state to 'read' without creating a new revision. If the specified DDC does not contain the SYSDOCSTATE field, this method has no effect.

Specified by:

setDocumentRead in interface DocumentService

Parameters:

id - document's ID

Throws:

DocumentIdentificationException - missing information in ID

SystemException - system error when setting state

AuthenticationException - authentication error when setting state

See Also:

• DocumentService.setDocumentRead(com.saperion.ngc.model.document.DocumentId)

setDocumentUnread

public void setDocumentUnread(DocumentId id)
                       throws DocumentIdentificationException,
SystemException,
AuthenticationException

Sets the specified document's state to 'unread' without creating a new revision. If the specified DDC does not contain the SYSDOCSTATE field, this method has no effect.

Specified by:

setDocumentUnread in interface DocumentService

Parameters:

id - document's ID

Throws:

DocumentIdentificationException - missing information in ID

SystemException - system error when setting state

AuthenticationException - authentication error when setting state

See Also:

• (com.saperion.ngc.model.document.DocumentId)

getFullTextFields

public Set<Map.Entry<String,String>> getFullTextFields(String ddcName,
 List<String> fullTextFields,
 String hdoc)
                                                throws SystemException

See DocumentService.getFullTextFields(String, List, String)

Specified by:

getFullTextFields in interface DocumentService

Parameters:

ddcName - name of the DDC

fullTextFields - List of Fields which are of Text retrieval type. Make sure to prefix SaConstants.FULL_TEXT_COLUMN_PREFIX

hdoc - hdoc of the document

Returns:

Set of entries containing full text coulmn and corresponding value

Throws:

SystemException