Policy (OpenAM Project 15.1.7-SNAPSHOT API)

java.lang.Object
- com.sun.identity.entitlement.xacml3.core.Policy

All Implemented Interfaces:: XACMLRootElement

public class Policy
extends Object
implements XACMLRootElement

Java class for PolicyType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="PolicyType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:tc:xacml:3.0:core:schema:wd-17}Description" minOccurs="0"/>
         <element ref="{urn:oasis:names:tc:xacml:3.0:core:schema:wd-17}PolicyIssuer" minOccurs="0"/>
         <element ref="{urn:oasis:names:tc:xacml:3.0:core:schema:wd-17}PolicyDefaults" minOccurs="0"/>
         <element ref="{urn:oasis:names:tc:xacml:3.0:core:schema:wd-17}Target"/>
         <choice maxOccurs="unbounded">
           <element ref="{urn:oasis:names:tc:xacml:3.0:core:schema:wd-17}CombinerParameters" minOccurs="0"/>
           <element ref="{urn:oasis:names:tc:xacml:3.0:core:schema:wd-17}RuleCombinerParameters" minOccurs="0"/>
           <element ref="{urn:oasis:names:tc:xacml:3.0:core:schema:wd-17}VariableDefinition"/>
           <element ref="{urn:oasis:names:tc:xacml:3.0:core:schema:wd-17}Rule"/>
         </choice>
         <element ref="{urn:oasis:names:tc:xacml:3.0:core:schema:wd-17}ObligationExpressions" minOccurs="0"/>
         <element ref="{urn:oasis:names:tc:xacml:3.0:core:schema:wd-17}AdviceExpressions" minOccurs="0"/>
       </sequence>
       <attribute name="PolicyId" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="Version" use="required" type="{urn:oasis:names:tc:xacml:3.0:core:schema:wd-17}VersionType" />
       <attribute name="RuleCombiningAlgId" use="required" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
       <attribute name="MaxDelegationDepth" type="{http://www.w3.org/2001/XMLSchema}integer" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected AdviceExpressions`	`adviceExpressions`
`protected List<Object>`	`combinerParametersOrRuleCombinerParametersOrVariableDefinition`
`protected String`	`description`
`protected BigInteger`	`maxDelegationDepth`
`protected ObligationExpressions`	`obligationExpressions`
`protected Defaults`	`policyDefaults`
`protected String`	`policyId`
`protected PolicyIssuer`	`policyIssuer`
`protected String`	`ruleCombiningAlgId`
`protected Target`	`target`
`protected Version`	`version`

Fields inherited from interface com.sun.identity.entitlement.xacml3.core.XACMLRootElement
XACML3_NAMESPACE

Constructor Summary

Constructors
Constructor and Description

Policy()

Constructors
Constructor and Description
`Policy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdviceExpressions`	`getAdviceExpressions()` Gets the value of the adviceExpressions property.
`List<Object>`	`getCombinerParametersOrRuleCombinerParametersOrVariableDefinition()` Gets the value of the combinerParametersOrRuleCombinerParametersOrVariableDefinition property.
`String`	`getDescription()` Gets the value of the description property.
`BigInteger`	`getMaxDelegationDepth()` Gets the value of the maxDelegationDepth property.
`ObligationExpressions`	`getObligationExpressions()` Gets the value of the obligationExpressions property.
`Defaults`	`getPolicyDefaults()` Gets the value of the policyDefaults property.
`String`	`getPolicyId()` Gets the value of the policyId property.
`PolicyIssuer`	`getPolicyIssuer()` Gets the value of the policyIssuer property.
`String`	`getRuleCombiningAlgId()` Gets the value of the ruleCombiningAlgId property.
`Target`	`getTarget()` Gets the value of the target property.
`Version`	`getVersion()` Gets the value of the version property.
`void`	`setAdviceExpressions(AdviceExpressions value)` Sets the value of the adviceExpressions property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setMaxDelegationDepth(BigInteger value)` Sets the value of the maxDelegationDepth property.
`void`	`setObligationExpressions(ObligationExpressions value)` Sets the value of the obligationExpressions property.
`void`	`setPolicyDefaults(Defaults value)` Sets the value of the policyDefaults property.
`void`	`setPolicyId(String value)` Sets the value of the policyId property.
`void`	`setPolicyIssuer(PolicyIssuer value)` Sets the value of the policyIssuer property.
`void`	`setRuleCombiningAlgId(String value)` Sets the value of the ruleCombiningAlgId property.
`void`	`setTarget(Target value)` Sets the value of the target property.
`void`	`setVersion(Version value)` Sets the value of the version property.
`String`	`toXML()` Default toXML Method to Marshal Object into XML.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - description
```
protected String description
```
  - policyIssuer
```
protected PolicyIssuer policyIssuer
```
  - policyDefaults
```
protected Defaults policyDefaults
```
  - target
```
protected Target target
```
  - combinerParametersOrRuleCombinerParametersOrVariableDefinition
```
protected List<Object> combinerParametersOrRuleCombinerParametersOrVariableDefinition
```
  - obligationExpressions
```
protected ObligationExpressions obligationExpressions
```
  - adviceExpressions
```
protected AdviceExpressions adviceExpressions
```
  - policyId
```
protected String policyId
```
  - version
```
protected Version version
```
  - ruleCombiningAlgId
```
protected String ruleCombiningAlgId
```
  - maxDelegationDepth
```
protected BigInteger maxDelegationDepth
```
- Constructor Detail
  - Policy
```
public Policy()
```
- Method Detail
  - getDescription
```
public String getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is String
  - setDescription
```
public void setDescription(String value)
```
    Sets the value of the description property.
    
    Parameters:
    
    value - allowed object is String
  - getPolicyIssuer
```
public PolicyIssuer getPolicyIssuer()
```
    Gets the value of the policyIssuer property.
    
    Returns:
    
    possible object is PolicyIssuer
  - setPolicyIssuer
```
public void setPolicyIssuer(PolicyIssuer value)
```
    Sets the value of the policyIssuer property.
    
    Parameters:
    
    value - allowed object is PolicyIssuer
  - getPolicyDefaults
```
public Defaults getPolicyDefaults()
```
    Gets the value of the policyDefaults property.
    
    Returns:
    
    possible object is Defaults
  - setPolicyDefaults
```
public void setPolicyDefaults(Defaults value)
```
    Sets the value of the policyDefaults property.
    
    Parameters:
    
    value - allowed object is Defaults
  - getTarget
```
public Target getTarget()
```
    Gets the value of the target property.
    
    Returns:
    
    possible object is Target
  - setTarget
```
public void setTarget(Target value)
```
    Sets the value of the target property.
    
    Parameters:
    
    value - allowed object is Target
  - getCombinerParametersOrRuleCombinerParametersOrVariableDefinition
```
public List<Object> getCombinerParametersOrRuleCombinerParametersOrVariableDefinition()
```
    Gets the value of the combinerParametersOrRuleCombinerParametersOrVariableDefinition property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the combinerParametersOrRuleCombinerParametersOrVariableDefinition property.
    For example, to add a new item, do as follows:
```
    getCombinerParametersOrRuleCombinerParametersOrVariableDefinition().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list CombinerParameters VariableDefinition RuleCombinerParameters Rule
  - getObligationExpressions
```
public ObligationExpressions getObligationExpressions()
```
    Gets the value of the obligationExpressions property.
    
    Returns:
    
    possible object is ObligationExpressions
  - setObligationExpressions
```
public void setObligationExpressions(ObligationExpressions value)
```
    Sets the value of the obligationExpressions property.
    
    Parameters:
    
    value - allowed object is ObligationExpressions
  - getAdviceExpressions
```
public AdviceExpressions getAdviceExpressions()
```
    Gets the value of the adviceExpressions property.
    
    Returns:
    
    possible object is AdviceExpressions
  - setAdviceExpressions
```
public void setAdviceExpressions(AdviceExpressions value)
```
    Sets the value of the adviceExpressions property.
    
    Parameters:
    
    value - allowed object is AdviceExpressions
  - getPolicyId
```
public String getPolicyId()
```
    Gets the value of the policyId property.
    
    Returns:
    
    possible object is String
  - setPolicyId
```
public void setPolicyId(String value)
```
    Sets the value of the policyId property.
    
    Parameters:
    
    value - allowed object is String
  - getVersion
```
public Version getVersion()
```
    Gets the value of the version property.
    
    Returns:
    
    possible object is Version
  - setVersion
```
public void setVersion(Version value)
```
    Sets the value of the version property.
    
    Parameters:
    
    value - allowed object is Version
  - getRuleCombiningAlgId
```
public String getRuleCombiningAlgId()
```
    Gets the value of the ruleCombiningAlgId property.
    
    Returns:
    
    possible object is String
  - setRuleCombiningAlgId
```
public void setRuleCombiningAlgId(String value)
```
    Sets the value of the ruleCombiningAlgId property.
    
    Parameters:
    
    value - allowed object is String
  - getMaxDelegationDepth
```
public BigInteger getMaxDelegationDepth()
```
    Gets the value of the maxDelegationDepth property.
    
    Returns:
    
    possible object is BigInteger
  - setMaxDelegationDepth
```
public void setMaxDelegationDepth(BigInteger value)
```
    Sets the value of the maxDelegationDepth property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - toXML
```
public String toXML()
```
    Default toXML Method to Marshal Object into XML.
    
    Specified by:
    
    toXML in interface XACMLRootElement
    
    Returns:
    
    String - Marshaled Results into XML String.

Class Policy

Field Summary

Fields inherited from interface com.sun.identity.entitlement.xacml3.core.XACMLRootElement

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

description

policyIssuer

policyDefaults

target

combinerParametersOrRuleCombinerParametersOrVariableDefinition

obligationExpressions

adviceExpressions

policyId

version

ruleCombiningAlgId

maxDelegationDepth

Constructor Detail

Policy

Method Detail

getDescription

setDescription

getPolicyIssuer

setPolicyIssuer

getPolicyDefaults

setPolicyDefaults

getTarget

setTarget

getCombinerParametersOrRuleCombinerParametersOrVariableDefinition

getObligationExpressions

setObligationExpressions

getAdviceExpressions

setAdviceExpressions

getPolicyId

setPolicyId

getVersion

setVersion

getRuleCombiningAlgId

setRuleCombiningAlgId

getMaxDelegationDepth

setMaxDelegationDepth

toXML