com.adobe.livecycle.rightsmanagement.client
Interface WatermarkManager

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 Adobe Experience Manager Forms.

Method Summary

void	deleteWatermark(java.lang.String watermarkId) Deletes the specified watermark.
Watermark	getWatermark(java.lang.String watermarkId) Retrieves the specified watermark from the database.
Watermark2	getWatermark2(java.lang.String watermarkId) Retrieves the specified watermark from the database.
Watermark	getWatermarkByName(java.lang.String watermarkName) Retrieves the specified watermark from the Rights Management service.
Watermark2	getWatermarkByName2(java.lang.String watermarkName) Retrieves the specified watermark from the Rights Management service.
java.lang.String	registerWatermark(Watermark watermark) Registers the specified watermark with the Rights Management service.
java.lang.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

registerWatermark

java.lang.String registerWatermark(Watermark watermark)
                                   throws SDKException

Registers the specified watermark with the Rights Management service. To see this method used within a code example, see the Creating a new watermark using the Java API quick start in Programming with Adobe Experience Manager Forms.

Parameters:

watermark - A new watermark to register with the Rights Management service.

Returns:

The watermarkId of the registered watermark.

Throws:

SDKException - if any of the following conditions occur:

• The watermark name of the watermark you provided is already used for an existing watermark.
• The watermark you provided is not valid.
• The operation was not permitted.
• An error occurred while communicating with the Rights Management service.

registerWatermark2

java.lang.String registerWatermark2(Watermark2 watermark)
                                    throws SDKException

Registers the specified watermark with the Rights Management service. To see this method used within a code example, see the Creating a new watermark using the Java API quick start in Programming with Adobe Experience Manager Forms.

Parameters:

watermark - A new watermark to register with the Rights Management service.

Returns:

The watermarkId of the registered watermark.

Throws:

SDKException - if any of the following conditions occur:

• The watermark name of the watermark you provided is already used for an existing watermark.
• The watermark you provided is not valid.
• The operation was not permitted.
• An error occurred while communicating with the Rights Management service.

updateWatermark

void updateWatermark(Watermark watermark)
                     throws SDKException

Updates an existing watermark with the properties defined in a new watermark definition. To update a watermark, you must first retrieve the watermark from the Rights Management service. To see this method used in a code example, see the Modifying a watermark using the Java API quick start in Programming with Adobe Experience Manager Forms.

Parameters:

watermark - A Watermark object that holds the watermark to update. The watermark was previously retrieved and modified as required.

Throws:

SDKException - if any of the following conditions occur:

• The watermark you provided is not valid.
• The operation was not permitted.
• An error occurred while communicating with the Rights Management service.

See Also:

WatermarkManager.getWatermark(java.lang.String), WatermarkManager.getWatermarkByName(java.lang.String)

updateWatermark2

void updateWatermark2(Watermark2 watermark)
                      throws SDKException

Updates an existing watermark with the properties defined in a new watermark definition. To update a watermark, you must first retrieve the watermark from the Rights Management service. To see this method used in a code example, see the Modifying a watermark using the Java API quick start in Programming with Adobe Experience Manager Forms.

Parameters:

watermark - A Watermark2 object that holds the watermark to update. The watermark was previously retrieved and modified as required.

Throws:

SDKException - if any of the following conditions occur:

• The watermark you provided is not valid.
• The operation was not permitted.
• An error occurred while communicating with the Rights Management service.

See Also:

WatermarkManager.getWatermark(java.lang.String), WatermarkManager.getWatermarkByName(java.lang.String)

deleteWatermark

void deleteWatermark(java.lang.String watermarkId)
                     throws SDKException

Deletes the specified watermark.

Parameters:

watermarkId - The identifier of the watermark to delete.

Throws:

SDKException - if any of the following conditions occur:

• The watermark is already deleted.
• The watermark identification you provided is not valid.
• The operation was not permitted.
• An error occurred while communicating with the Rights Management service.

See Also:

Watermark

getWatermark

Watermark getWatermark(java.lang.String watermarkId)
                       throws SDKException

Retrieves the specified watermark from the database.

Parameters:

watermarkId - The identifier value of the watermark to retrieve.

Returns:

The Watermark object that has the specified watermarkId.

Throws:

SDKException - if any of the following conditions occur:

• The watermark identification you provided is not valid.
• The watermark was not found.
• The operation was not permitted.
• An error occurred while communicating with the Rights Management service.

getWatermark2

Watermark2 getWatermark2(java.lang.String watermarkId)
                         throws SDKException

Retrieves the specified watermark from the database.

Parameters:

watermarkId - The identifier value of the watermark to retrieve.

Returns:

The Watermark2 object that has the specified watermarkId.

Throws:

SDKException - if any of the following conditions occur:

• The watermark identification you provided is not valid.
• The watermark was not found.
• The operation was not permitted.
• An error occurred while communicating with the Rights Management service.

getWatermarkByName

Watermark getWatermarkByName(java.lang.String watermarkName)
                             throws SDKException

Retrieves the specified watermark from the Rights Management service.

Parameters:

watermarkName - The name of the watermark to retrieve.

Returns:

The Watermark object that has the specified watermarkName.

Throws:

SDKException - if any of the following conditions occur:

• The watermark name you provided is not valid.
• The watermark was not found.
• The operation was not permitted.
• An error occurred while communicating with the Rights Management service.

getWatermarkByName2

Watermark2 getWatermarkByName2(java.lang.String watermarkName)
                               throws SDKException

Retrieves the specified watermark from the Rights Management service.

Parameters:

watermarkName - The name of the watermark to retrieve.

Returns:

The Watermark2 object that has the specified watermarkName.

Throws:

SDKException - if any of the following conditions occur:

• The watermark name you provided is not valid.
• The watermark was not found.
• The operation was not permitted.
• An error occurred while communicating with the Rights Management service.