com.adobe.livecycle.rightsmanagement.client.infomodel
Class AbstractPolicySearchFilter

java.lang.Object
  com.adobe.livecycle.rightsmanagement.client.infomodel.AbstractPolicySearchFilter

public class AbstractPolicySearchFilter
extends java.lang.Object

The AbstractPolicySearchFilter class is used to specify search criteria when searching for abstract policies.

This class provides methods for setting and retrieving the values of parameters for searching for abstract policies by the policy owner, name:

• All search parameters are optional.
• The default value of all parameters is null.
• When more than one search parameter is specified, the search returns abstract policies that match all the parameters.

The AbstractPolicyManager.getAbstractPolicies(AbstractPolicySearchFilter, int) } method uses an AbstractPolicySearchFilter object to perfom searches.

Constructor Summary

AbstractPolicySearchFilter()

AbstractPolicySearchFilter(PolicySearchFilter policySearchFilter)

Method Summary

java.lang.String	getName() Retrieves the value of the parameter used for searching for abstract policies by name.
java.lang.String	getPolicySetName() Retrieves the value of the parameter used for searching for abstract policies by policy set name.
void	setName(java.lang.String name) Sets the value of the parameter used for searching for abstract policies by name.
void	setPolicySetName(java.lang.String policySetName) Sets the name of the policy set to search when searching for abstract policies.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPolicySearchFilter

public AbstractPolicySearchFilter(PolicySearchFilter policySearchFilter)

AbstractPolicySearchFilter

public AbstractPolicySearchFilter()

Method Detail

getName

public java.lang.String getName()

Retrieves the value of the parameter used for searching for abstract policies by name.

Returns:

A string value that specifies the parameter for searching by name and null if no parameter is set.

See Also:

AbstractPolicySearchFilter.setName(String)

getPolicySetName

public java.lang.String getPolicySetName()

Retrieves the value of the parameter used for searching for abstract policies by policy set name.

Returns:

A string value that specifies the parameter for searching by policy set name and null if no parameter was set.

See Also:

AbstractPolicySearchFilter.setPolicySetName(String)

setName

public void setName(java.lang.String name)

Sets the value of the parameter used for searching for abstract policies by name.

You can specify all or part of the name to search for.

Parameters:

name - A java.lang.String that holds all or part of the name of the abstract policy to search for and null if you do not want to search by name. The maximum length of the java.lang.String you can use is 25 characters or errors can occur.

setPolicySetName

public void setPolicySetName(java.lang.String policySetName)

Sets the name of the policy set to search when searching for abstract policies. The maximum length of the java.lang.String you can use is 50 characters. You can specify all or part of the policy set name.

Parameters:

policySetName - A string value that represents the policy set name.