MailUrl (webclient 7.5.5 API)

java.lang.Object
- com.saperion.ngc.servlet.MailUrl

public final class MailUrl
extends Object

Author:: rbo

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`constructDocumentMailUrl(String revisionId, boolean currentRevision, int element, String filename, boolean download, javax.servlet.http.HttpServletRequest request)` Constructs the url to retrieve the document with the specified document id.
`static String`	`constructFileMailUrl(String folderid, String ddc, javax.servlet.http.HttpServletRequest request)` Constructs the url to retrieve the file with the specified file id.
`static String`	`constructLinkMailUrl(String appName, String revisionId, String ddcName, String tenant, javax.servlet.http.HttpServletRequest request, int timeout)` Constructs the url to retrieve the document with the specified document id.
`static String`	`constructListMailUrl(String revisionIds, String filename, javax.servlet.http.HttpServletRequest request)` Constructs the url to retrieve the document with the specified document id.
`static String`	`constructPdfMailUrl(String objectId, String revisionId, boolean currentRevision, String ddcName, String filename, boolean download, javax.servlet.http.HttpServletRequest request)` Constructs the url to retrieve the document with the specified document id rendered as PDF.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

constructDocumentMailUrl

public static String constructDocumentMailUrl(String revisionId,
                              boolean currentRevision,
                              int element,
                              String filename,
                              boolean download,
                              javax.servlet.http.HttpServletRequest request)
                                       throws UnsupportedEncodingException

Constructs the url to retrieve the document with the specified document id.

Parameters:: revisionId - the id of the document to retrieve; currentRevision - currentRevision; element - document element; filename - filename of the element; download - set to true to force the browser to open a download box; request - request
Returns:: url as string
Throws:: UnsupportedEncodingException - unsupported encoding

constructPdfMailUrl

public static String constructPdfMailUrl(String objectId,
                         String revisionId,
                         boolean currentRevision,
                         String ddcName,
                         String filename,
                         boolean download,
                         javax.servlet.http.HttpServletRequest request)
                                  throws UnsupportedEncodingException

Constructs the url to retrieve the document with the specified document id rendered as PDF.

Parameters:: objectId - id of the document to retrieve; revisionId - id of the revision to retrieve; currentRevision - currentRevision; ddcName - name of the ddc; filename - filename; download - set to true to force the browser to open a download box; request - request
Returns:: url as string
Throws:: UnsupportedEncodingException - unsupported encoding

constructListMailUrl
```
public static String constructListMailUrl(String revisionIds,
                          String filename,
                          javax.servlet.http.HttpServletRequest request)
                                   throws UnsupportedEncodingException
```
Constructs the url to retrieve the document with the specified document id.

Parameters:
revisionIds - the id's of the document to retrieve (semicolon separated)
filename - filename of the element
request - request

Returns:
url as string

Throws:

UnsupportedEncodingException - unsupported encoding

constructFileMailUrl

public static String constructFileMailUrl(String folderid,
                          String ddc,
                          javax.servlet.http.HttpServletRequest request)
                                   throws UnsupportedEncodingException

Constructs the url to retrieve the file with the specified file id.

Parameters:: folderid - the id's of the file to retrieve; ddc - ddc of the folder; request - request
Returns:: url as string
Throws:: UnsupportedEncodingException - unsupported encoding

constructLinkMailUrl

public static String constructLinkMailUrl(String appName,
                          String revisionId,
                          String ddcName,
                          String tenant,
                          javax.servlet.http.HttpServletRequest request,
                          int timeout)
                                   throws UnsupportedEncodingException