Package com.saperion.ngc.json
Class SapViewerResponse
java.lang.Object
com.saperion.ngc.json.SapViewerResponse
A SapViewerResponse contains the data about the opened document that is sent to the SAPViewer
after the document was loaded on server-side. It is used on the client to open the document
in the viewer.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
This class represents a row in the structure-view of the SAPViewer. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
int
boolean
boolean
void
setDocumentId
(String documentId) void
setDocumentRows
(SapViewerResponse.StructureRow[] documentRows) void
setDownloadAllowed
(boolean downloadAllowed) void
setFirstViewableElement
(int firstViewableElement) void
setMailingUrl
(String mailingUrl) void
setPagecount
(int pagecount) void
setShowStructure
(boolean showStructure) void
setSimpleDocumentId
(String simpleDocumentId) void
setUrlMailingUrl
(String urlMailingUrl)
-
Constructor Details
-
SapViewerResponse
public SapViewerResponse()
-
-
Method Details
-
getDocumentId
- Returns:
- the JSON ID of the document
-
setDocumentId
- Parameters:
documentId
- the JSON ID of the document
-
getDocumentRows
- Returns:
- the rows of the structure
-
setDocumentRows
- Parameters:
documentRows
- the rows of the structure
-
isDownloadAllowed
public boolean isDownloadAllowed()- Returns:
- true if the document can be downloaded
-
setDownloadAllowed
public void setDownloadAllowed(boolean downloadAllowed) - Parameters:
downloadAllowed
- true if the document can be downloaded
-
getRevisionId
- Returns:
- thr revision-ID of the document
-
getFirstViewableElement
public int getFirstViewableElement()- Returns:
- the number of the first element in the structure that can be viewed
-
setFirstViewableElement
public void setFirstViewableElement(int firstViewableElement) - Parameters:
firstViewableElement
- the number of the first element in the structure that can be viewed
-
getMailingUrl
- Returns:
- the URL used for mailing with attachment
-
setMailingUrl
- Parameters:
mailingUrl
- the URL used for mailing with attachment
-
getUrlMailingUrl
- Returns:
- the URL used for mailing with link
-
setUrlMailingUrl
- Parameters:
urlMailingUrl
- the URL used for mailing with link
-
isShowStructure
public boolean isShowStructure()- Returns:
- true if the structure is shown
-
setShowStructure
public void setShowStructure(boolean showStructure) - Parameters:
showStructure
- true if the structure is shown
-
getPagecount
public int getPagecount()- Returns:
- the count of pages of the document
-
setPagecount
public void setPagecount(int pagecount) - Parameters:
pagecount
- the count of pages of the document
-
getSimpleDocumentId
- Returns:
- the simple string ID of the document
-
setSimpleDocumentId
- Parameters:
simpleDocumentId
- the simple string ID of the document
-