com.adobe.livecycle.rightsmanagement.client.infomodel
Interface Watermark2

All Superinterfaces:

java.lang.Cloneable

public interface Watermark2
extends java.lang.Cloneable

The Watermark2 interface defines methods for the creation and manipulation of watermarks. Every watermark has a name and contain one or more WatermarkElements.

For information about using this interface as part of creating watermarks using the Document Security Java API, see the Creating a new watermark using the Java API quick start in Programming with Adobe Experience Manager Forms.

Method Summary

void	addWatermarkElement(Watermark2Element watermarkElement) Adds a new watermark element in the list of watermark elements for the watermark.
java.lang.String	getId() Retrieves the identification of the watermark.
java.lang.String	getName() Retrieves the name of the watermark.
java.util.ArrayList	getWatermarkElements() Retrieves the watermark elements contained in the watermark.
boolean	isDeleted() Retrieves the state of the watermark.
void	removeWatermarkElement(int index) Removes a watermark element in the list at the specified index.
void	setName(java.lang.String name) Sets the name for the watermark.
void	setWatermarkElements(java.util.ArrayList watermarkElements) Sets the list of watermark elements for the watermark.

Method Detail

getId

java.lang.String getId()

Retrieves the identification of the watermark.

Returns:

A string value that contains the identification of the watermark and null if this Watermark object represents a watermark that is not registered with the Rights Management service.

getName

java.lang.String getName()

Retrieves the name of the watermark.

Returns:

A java.lang.String that contains the name of the watermark.

setName

void setName(java.lang.String name)
             throws PDRLException

Sets the name for the watermark.

Parameters:

name - A java.lang.String that contains the name for the watermark. name can have a maximum length of 50 characters.

Throws:

PDRLException - if name is longer than the allowed length.

isDeleted

boolean isDeleted()

Retrieves the state of the watermark. Watermarks can be either active or deleted. If the watermark is deleted it can no longer be used with policies, however deleted watermarks still appear in documents protected by policies that were created before the watermark was deleted.

Returns:

A Boolean value of true if the watermark is deleted and false if the watermark is active.

getWatermarkElements

java.util.ArrayList getWatermarkElements()

Retrieves the watermark elements contained in the watermark.

Returns:

A java.lang.ArrayList that contains the list of all the contained watermark elements.

setWatermarkElements

void setWatermarkElements(java.util.ArrayList watermarkElements)
                          throws SDKException

Sets the list of watermark elements for the watermark.

Parameters:

watermarkElements - A java.lang.ArrayList that contains the list of all the contained watermark elements.

Throws:

SDKException - if watermarkElements is null.

addWatermarkElement

void addWatermarkElement(Watermark2Element watermarkElement)
                         throws SDKException

Adds a new watermark element in the list of watermark elements for the watermark.

Parameters:

watermarkElement - A com.adobe.livecycle.rightsmanagement.client.infomodel.WatermarkElement that contains the watermark element to be added.

Throws:

SDKException - if watermarkElement is null.

removeWatermarkElement

void removeWatermarkElement(int index)
                            throws SDKException

Removes a watermark element in the list at the specified index. Index starts at zero.

Parameters:

index - A int that contains the index of the watermark element to be removed.

Throws:

SDKException - if index is not valid.