|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.adobe.livecycle.rightsmanagement.client.infomodel.PolicySearchFilter
public class PolicySearchFilter
The PolicySearchFilter
class is used to specify search criteria when searching
for policies.
This class provides methods for setting and retrieving the values of parameters for searching for policies by the policy owner, name, and type:
asDocumentPublisher
filter to true
.
The default setting is false
.
The PolicyManager.getPolicies()
method uses
a PolicySearchFilter
object to perfom searches.
Constructor Summary | |
---|---|
PolicySearchFilter()
|
Method Summary | |
---|---|
java.lang.String |
getName()
Retrieves the value of the parameter used for searching for policies by name. |
Principal |
getOwner()
Retrieves the value of the parameter used for searching for policies by owner. |
java.lang.String |
getPolicySetName()
Retrieves the value of the parameter used for searching for policies by policy set name. |
java.lang.String |
getType()
Retrieves the value of the parameter used for searching for policies by type. |
boolean |
isAsDocumentPublisher()
Returns whether the search results include policies for which the user is the document publisher. |
boolean |
isIncludePrincipalAttributes()
Returns whether the search results include detailed information about the principals for which the returned policies provide permissions. |
void |
setAsDocumentPublisher(boolean asDocPublisher)
Specifies whether the search results can include policies for which the user is only a document publisher. |
void |
setIncludePrincipalAttributes(boolean includePrincipalAttrs)
Specifies whether the search results include detailed information about the principals for which the returned policies provide permissions. |
void |
setName(java.lang.String name)
Sets the value of the parameter used for searching for policies by name. |
void |
setOwner(Principal owner)
Sets the name of an owner when searching for policies. |
void |
setPolicySetName(java.lang.String policySetName)
Sets the name of the policy set to search when searching for policies. |
void |
setType(java.lang.String type)
Sets the value of the parameter used for searching for policies by policy type. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PolicySearchFilter()
Method Detail |
---|
public java.lang.String getName()
null
if no parameter is set.#setName()
public java.lang.String getPolicySetName()
null
if no parameter was set.#setPolicySetName()
public Principal getOwner()
Principal
object used for searching policies by owner.#setOwner()
public java.lang.String getType()
java.lang.String
that holds the policy type.Policy
public void setName(java.lang.String name)
You can specify all or part of the name to search for.
name
- A java.lang.String
that holds all or part of the name of the 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.public void setPolicySetName(java.lang.String policySetName)
java.lang.String
you can use is 50 characters.
You can specify all or part of the policy set name.
policySetName
- A string value that represents the policy set name.public void setOwner(Principal owner)
owner
- A Principal
object that owns the policy to retrieve.public void setType(java.lang.String type) throws SDKException
type
- A string value that contains the policy type. The policy type can be either
Policy.USER_POLICY
or Policy.ORGANIZATIONAL_POLICY
. If its a Organizational
Policy, the policy set name has to be specified as well in the filter.
SDKException
- If the policy type specified in type
is not valid.Policy
public boolean isIncludePrincipalAttributes()
#setIncludePrincipalAttributes()
public void setIncludePrincipalAttributes(boolean includePrincipalAttrs)
By default, searches for policies return detailed user information about the associated principals.
includePrincipalAttrs
- A value of true
specifies detailed user information.
A value of false
specifies only the user identification.
The default value of includePrincipalAttrs
is true
.public boolean isAsDocumentPublisher()
true
indicates that
the search results include only policies for which the user
is a document publisher
A value of false
indicates that
the search results include policies for which the user
is document publisher and a Policy Set Coordinator.#setAsDocumentPublisher()
public void setAsDocumentPublisher(boolean asDocPublisher)
By default, policy searches return results for which the user is a document publisher and a Policy Set Coordinator.
asDocPublisher
- A value of true
specifies that
policy searches return results for which the user is only a document publisher.
A value of false
specifies policy searches return results for which the user
is a document publisher and a Policy Set Coordinator.
The default value of includePrincipalAttrs
is true
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |