Package com.saperion.ngc.viewer.hylandviewer

Class HylandViewerUtil

java.lang.Object

com.saperion.ngc.viewer.hylandviewer.HylandViewerUtil

All Implemented Interfaces:

Serializable

public final class HylandViewerUtil
extends Object
implements Serializable

Utility class for the Hyland Viewer.

Author:

schowdhury

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
HylandViewerUtil(jakarta.servlet.http.HttpServletRequest httpRequest, jakarta.servlet.http.HttpSession session)

Method Summary

Modifier and Type	Method	Description
String	constructViewerDocumentUrl(jakarta.servlet.http.HttpServletRequest httpRequest, String sessionId)	Construct the url to retrieve the document with the given sessionId
String	constructViewerDocumentUrl(jakarta.servlet.http.HttpServletRequest httpRequest, String sessionId, String revisionId, int elementNumber, String name)	Construct the url to retrieve the document with the given sessionId
String	constructViewerTempDocumentUrl(jakarta.servlet.http.HttpServletRequest httpRequest, String sessionId)	Construct the temporary document url with the given session id of the document
DocumentArchiveMetaInfo	getDocumentArchiveMetaInfo(DocumentId docId, boolean currentRevision)	Get the document archive meta information of a specific document.
AnnotationDocInfo	getIniAnnotation(String revisionId, String sessionId, int elementNumber)	Get the annotation of a document
OpenDocumentBean	getOpenDocumentBean(DocumentId docId, boolean currentRevision, boolean editMode)	Get a OpenDocumentBean for a specific document id.
DocumentStructureInfo	getStructureInfo(String revisionId, String sessionId, int elementNumber)	Get the structure information of a document
DocumentId	getUpdatedDocumentId(DocumentId docId)	Get the updated document id.
boolean	isEditable(jakarta.servlet.http.HttpServletRequest request, ResultProperties documentInfo)	Check whether a document is editable.
String	uploadDocument(String revisionId, int elementNumber, String name, boolean editMode)	Get the session id of a document
String	uploadTemporaryDocument(TemporaryDocumentId id)	Get the session id of a temporary document

Methods inherited from class java.lang.Object

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

Constructor Details

HylandViewerUtil

public HylandViewerUtil(jakarta.servlet.http.HttpServletRequest httpRequest,
 jakarta.servlet.http.HttpSession session)

Method Details

constructViewerDocumentUrl

public String constructViewerDocumentUrl(jakarta.servlet.http.HttpServletRequest httpRequest,
 String sessionId)

Construct the url to retrieve the document with the given sessionId

Parameters:

sessionId - the id of the document from hyland rendering and conversion service

Returns:

url as string

constructViewerDocumentUrl

public String constructViewerDocumentUrl(jakarta.servlet.http.HttpServletRequest httpRequest,
 String sessionId,
 String revisionId,
 int elementNumber,
 String name)

Construct the url to retrieve the document with the given sessionId

Parameters:

sessionId - the id of the document from hyland rendering and conversion service

revisionId - the revisionId of the document

elementNumber - the elementNumber of the document

name - the name of the document

Returns:

url as string

constructViewerTempDocumentUrl

public String constructViewerTempDocumentUrl(jakarta.servlet.http.HttpServletRequest httpRequest,
 String sessionId)

Construct the temporary document url with the given session id of the document

Parameters:

sessionId - the id of the document from hyland rendering and conversion service

Returns:

url as string

uploadDocument

public String uploadDocument(String revisionId,
 int elementNumber,
 String name,
 boolean editMode)

Get the session id of a document

Parameters:

revisionId - hdoc of a structure

elementNumber - element ID. Used only for structured documents to identify the page

name - name of an element in a structured document

Returns:

the session id of a document

uploadTemporaryDocument

public String uploadTemporaryDocument(TemporaryDocumentId id)

Get the session id of a temporary document

Parameters:

id - a reference to the temporary document

Returns:

the session id of a temporary document

getIniAnnotation

public AnnotationDocInfo getIniAnnotation(String revisionId,
 String sessionId,
 int elementNumber)
                                   throws AuthenticationException,
SystemException

Get the annotation of a document

Parameters:

revisionId - hdoc of a structure

sessionId - the id of the document from hyland rendering and conversion service

elementNumber - the element number of the document that is used only for structured documents to identify the page

Returns:

AnnotationDocInfo the annotation information comprising of ini string and document dimension

Throws:

AuthenticationException

SystemException

getStructureInfo

public DocumentStructureInfo getStructureInfo(String revisionId,
 String sessionId,
 int elementNumber)

Get the structure information of a document

Parameters:

revisionId - hdoc of a structure

sessionId - the id of the document from hyland rendering and conversion service

elementNumber - the element number of the document that is used only for structured documents to identify the page

Returns:

DocumentStructureInfo the structure information of a document

getDocumentArchiveMetaInfo

public DocumentArchiveMetaInfo getDocumentArchiveMetaInfo(DocumentId docId,
 boolean currentRevision)
                                                   throws SystemException,
AuthenticationException

Get the document archive meta information of a specific document.

Parameters:

docId -

Returns:

Throws:

SystemException

AuthenticationException

getUpdatedDocumentId

public DocumentId getUpdatedDocumentId(DocumentId docId)
                                throws SystemException,
AuthenticationException,
DocumentIdentificationException

Get the updated document id.

Parameters:

docId -

Returns:

Throws:

SystemException

AuthenticationException

DocumentIdentificationException

getOpenDocumentBean

public OpenDocumentBean getOpenDocumentBean(DocumentId docId,
 boolean currentRevision,
 boolean editMode)
                                     throws SystemException,
AuthenticationException

Get a OpenDocumentBean for a specific document id.

Parameters:

docId -

currentRevision -

editMode -

Returns:

Throws:

SystemException

AuthenticationException

isEditable

public boolean isEditable(jakarta.servlet.http.HttpServletRequest request,
 ResultProperties documentInfo)
                   throws SystemException,
AuthenticationException,
DocumentIdentificationException

Check whether a document is editable.

Parameters:

request -

documentInfo -

Returns:

Throws:

SystemException

AuthenticationException

DocumentIdentificationException