com.adobe.livecycle.rightsmanagement.client.infomodel.impl
Class Watermark2Impl

java.lang.Object
  com.adobe.livecycle.rightsmanagement.client.infomodel.impl.Watermark2Impl

All Implemented Interfaces:

Watermark2, java.lang.Cloneable

public class Watermark2Impl
extends java.lang.Object
implements Watermark2

Constructor Summary

Watermark2Impl()

Watermark2Impl(WatermarkBO bo)

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	setDeleted(boolean b)
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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Watermark2Impl

public Watermark2Impl()

Watermark2Impl

public Watermark2Impl(WatermarkBO bo)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: Watermark2

Retrieves the name of the watermark.

Specified by:

getName in interface Watermark2

Returns:

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

setName

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

Description copied from interface: Watermark2

Sets the name for the watermark.

Specified by:

setName in interface Watermark2

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

public boolean isDeleted()

Description copied from interface: Watermark2

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.

Specified by:

isDeleted in interface Watermark2

Returns:

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

setDeleted

public void setDeleted(boolean b)

getWatermarkElements

public java.util.ArrayList getWatermarkElements()

Description copied from interface: Watermark2

Retrieves the watermark elements contained in the watermark.

Specified by:

getWatermarkElements in interface Watermark2

Returns:

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

setWatermarkElements

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

Description copied from interface: Watermark2

Sets the list of watermark elements for the watermark.

Specified by:

setWatermarkElements in interface Watermark2

Parameters:

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

Throws:

SDKException - if watermarkElements is null.

addWatermarkElement

public void addWatermarkElement(Watermark2Element watermarkElement)
                         throws SDKException

Description copied from interface: Watermark2

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

Specified by:

addWatermarkElement in interface Watermark2

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

public void removeWatermarkElement(int index)
                            throws SDKException

Description copied from interface: Watermark2

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

Specified by:

removeWatermarkElement in interface Watermark2

Parameters:

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

Throws:

SDKException - if index is not valid.

getId

public java.lang.String getId()

Description copied from interface: Watermark2

Retrieves the identification of the watermark.

Specified by:

getId in interface Watermark2

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.