Package com.emc.d2fs.interfaces
Interface IHyperlinkService
- All Superinterfaces:
ID2fsService
Hyperlink services.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionboolean
cancelCheckoutPdfFile
(Context context, String id) cancelCheckout Pdf File for specified object idcheckoutPdfFile
(Context context, String id, List<Attribute> parameters) Checkout Pdf File for specified object idcreateHyperlink
(Context context, String id, List<Attribute> parameters) Create hyperlink on destination documentboolean
deleteHyperlink
(Context context, String id, List<Attribute> parameters) Delete hyperlinkgetCheckinPdfFileUrls
(Context context, String id, List<Attribute> parameters) Get checkin urls for specified object idgetDestinationUrls
(Context context, String id, List<Attribute> parameters) Get destination urls for specified object id so one can download/open the documentvoid
setBaseUrl
(String url) Set server base url used to build the url forgetDownloadUrls
orgetUploadUrls
boolean
setDestinationVersion
(Context context, String id, String version) change Version of the destination documentboolean
shiftDestinationPage
(Context context, String id, int shiftPage, String orientationPageShifting) Shift page of the destination documentMethods inherited from interface com.emc.d2fs.interfaces.ID2fsService
isRemote, setRemote
-
Field Details
-
ARG_SRC_DOC_CHRON_ID
src_doc_chron_id- See Also:
-
ARG_DEST_DOC_CHRON_ID
dest_doc_chron_id- See Also:
-
ARG_DEST_DOC_VERSION
dest_version- See Also:
-
ARG_DEST_NUM_PAGE
dest_page- See Also:
-
ARG_SELECTED_VALUE
tree-hyperlinks-selected-value- See Also:
-
ARG_TREE_VALUES
tree-hyperlinks-values- See Also:
-
ARG_D2_LINK_TYPE
link_type- See Also:
-
-
Method Details
-
setBaseUrl
Set server base url used to build the url forgetDownloadUrls
orgetUploadUrls
- Parameters:
url
- String value of base url- Since:
- 4.5.0 P03
-
checkoutPdfFile
List<Attribute> checkoutPdfFile(Context context, String id, List<Attribute> parameters) throws Exception Checkout Pdf File for specified object id- Parameters:
context
-Context
object containing information about client/sessionid
- String value of document idparameters
-Attribute
list of parameters- It can contain the following attribute names:
- format : String value of file format
- pageNumber : Integer value of page number (to get only one specific page)
- pageModifier : String value of page modifier (key for specific render)
- event_name : String value of event type name (view, edit or print)
- contentId : (optional) Id of dmrContent from which to calculate the format
- Returns:
- Attribute list of parameters to pass on the download
- Throws:
Exception
- Since:
- 4.5.0 P03
-
getCheckinPdfFileUrls
List<String> getCheckinPdfFileUrls(Context context, String id, List<Attribute> parameters) throws Exception Get checkin urls for specified object id- Parameters:
context
-Context
object containing information about client/sessionid
- String value of document idparameters
-Attribute
list of parameters- It can contain the following attribute names:
- format : String value of file format
- pageNumber : Integer value of page number (to get only one specific page)
- pageModifier : String value of page modifier (key for specific render)
- event_name : String value of event type name (view, edit or print)
- contentId : (optional) Id of dmrContent from which to calculate the format
- Returns:
- String list of urls
- Throws:
Exception
- Since:
- 4.5.0 P03
-
getDestinationUrls
List<String> getDestinationUrls(Context context, String id, List<Attribute> parameters) throws Exception Get destination urls for specified object id so one can download/open the document- Parameters:
context
-Context
object containing information about client/sessionid
- String value of document idparameters
-Attribute
list of parameters- It can contain the following attribute names:
- format : String value of file format
- pageNumber : Integer value of page number (to get only one specific page)
- pageModifier : String value of page modifier (key for specific render)
- event_name : String value of event type name (view, edit or print)
- contentId : (optional) Id of dmrContent from which to calculate the format
- Returns:
- String list of urls
- Throws:
Exception
- Since:
- 4.5.0 P03
-
cancelCheckoutPdfFile
cancelCheckout Pdf File for specified object id -
setDestinationVersion
change Version of the destination document -
deleteHyperlink
Delete hyperlink -
shiftDestinationPage
boolean shiftDestinationPage(Context context, String id, int shiftPage, String orientationPageShifting) throws Exception Shift page of the destination document- Parameters:
context
-Context
object containing information about client/sessionid
- String value of document idshiftPage
- Integer value for the page, should be an existing page or it will default to 1orientationPageShifting
- String value for the orientation: target- Returns:
- boolean if operation was a success.
- Throws:
Exception
- Since:
- 4.5.0 P03
-
createHyperlink
Create hyperlink on destination document- Parameters:
context
-Context
object containing information about client/sessionid
- String value of source document idparameters
-Attribute
list of parameters- It can contain the following attribute names:
- src_doc_chron_id : Id of source document (chronicle id)
- dest_doc_chron_id : Id of destination document (chronicle id)
- dest_version : String value of destination document's version
- dest_page : (Optional - default to 0) String value of target document's page
- link_type : Integer value of link type (0 to Office, 1 to PDF, 2 on PDF )
- dest_bookmark : (Optional - Use only on link_type to PDF - default to empty) String value of target document's bookmark
- bookmarkPath : (Optional - Use only on link_type to PDF - default to empty) String value of target document's bookmark path
- Returns:
- String url of the Hyperlink
- Throws:
Exception
- Since:
- 4.5.0 P03
-