|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WatermarkManager
The WatermarkManager
interface provides methods for creating, manipulating,
retrieving, and removing watermarks.
To see this interface used within a code example,
see the Creating a new watermark using the Java API quick start in Programming with LiveCycle ES3.
Method Summary | |
---|---|
void |
deleteWatermark(String watermarkId)
Deletes the specified watermark. |
Watermark |
getWatermark(String watermarkId)
Retrieves the specified watermark from the Rights Management service database. |
Watermark2 |
getWatermark2(String watermarkId)
Retrieves the specified watermark from the Rights Management service database. |
Watermark |
getWatermarkByName(String watermarkName)
Retrieves the specified watermark from the Rights Management service. |
Watermark2 |
getWatermarkByName2(String watermarkName)
Retrieves the specified watermark from the Rights Management service. |
String |
registerWatermark(Watermark watermark)
Registers the specified watermark with the Rights Management service. |
String |
registerWatermark2(Watermark2 watermark)
Registers the specified watermark with the Rights Management service. |
void |
updateWatermark(Watermark watermark)
Updates an existing watermark with the properties defined in a new watermark definition. |
void |
updateWatermark2(Watermark2 watermark)
Updates an existing watermark with the properties defined in a new watermark definition. |
Method Detail |
---|
String registerWatermark(Watermark watermark) throws SDKException
watermark
- A new watermark to register with the Rights Management service.
watermarkId
of the registered watermark.
SDKException
- if any of the following conditions occur:
String registerWatermark2(Watermark2 watermark) throws SDKException
watermark
- A new watermark to register with the Rights Management service.
watermarkId
of the registered watermark.
SDKException
- if any of the following conditions occur:
void updateWatermark(Watermark watermark) throws SDKException
watermark
- A Watermark
object that holds the watermark to update. The watermark was
previously retrieved and modified as required.
SDKException
- if any of the following conditions occur:
WatermarkManager.getWatermark(java.lang.String)
,
WatermarkManager.getWatermarkByName(java.lang.String)
void updateWatermark2(Watermark2 watermark) throws SDKException
watermark
- A Watermark2
object that holds the watermark to update. The watermark was
previously retrieved and modified as required.
SDKException
- if any of the following conditions occur:
WatermarkManager.getWatermark(java.lang.String)
,
WatermarkManager.getWatermarkByName(java.lang.String)
void deleteWatermark(String watermarkId) throws SDKException
watermarkId
- The identifier of the watermark to delete.
SDKException
- if any of the following conditions occur:
Watermark
Watermark getWatermark(String watermarkId) throws SDKException
watermarkId
- The identifier value of the watermark to retrieve.
Watermark
object that has the specified watermarkId
.
SDKException
- if any of the following conditions occur:
Watermark2 getWatermark2(String watermarkId) throws SDKException
watermarkId
- The identifier value of the watermark to retrieve.
Watermark2
object that has the specified watermarkId
.
SDKException
- if any of the following conditions occur:
Watermark getWatermarkByName(String watermarkName) throws SDKException
watermarkName
- The name of the watermark to retrieve.
Watermark
object that has the specified watermarkName
.
SDKException
- if any of the following conditions occur:
Watermark2 getWatermarkByName2(String watermarkName) throws SDKException
watermarkName
- The name of the watermark to retrieve.
Watermark2
object that has the specified watermarkName
.
SDKException
- if any of the following conditions occur:
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |