PolicyRequest (OpenAM Project 15.1.7-SNAPSHOT API)

java.lang.Object
- com.sun.identity.policy.remote.PolicyRequest

```
public class PolicyRequest
extends Object
```
This PolicyRequest class represents a PolicyRequest XML document. The PolicyRequest DTD is defined as the following:
```
  

  
  
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`POLICY_REQUEST_ADD_POLICY_LISTENER` Policy Request - Add Policy Listener ID.
`static int`	`POLICY_REQUEST_ADVICES_HANDLEABLE_BY_AM_REQUEST` Policy Request - Advices handleable by OpenAM ID.
`static int`	`POLICY_REQUEST_GET_RESOURCE_RESULTS` Policy Request - Get Resource Results ID.
`static int`	`POLICY_REQUEST_REMOVE_POLICY_LISTENER` Policy Request - Remove Policy Listener ID.

Constructor Summary

Constructors
Constructor and Description

PolicyRequest()
Default constructor for PolicyRequest.

Constructors
Constructor and Description
`PolicyRequest()` Default constructor for `PolicyRequest`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAppSSOToken()` Returns the single sign on token of the application who sends the request.
`int`	`getMethodID()` Returns the method ID of the Policy Request.
`String`	`getMethodName()` Retrieves the string representation of the method Id.
`PolicyListenerRequest`	`getPolicyListenerRequest()` Returns the `PolicyListenerRequest` object.
`RemoveListenerRequest`	`getRemoveListenerRequest()` Returns the `RemoveListenerRequest` object.
`String`	`getRequestId()` Returns the request ID.
`ResourceResultRequest`	`getResourceResultRequest()` Returns the resource result request object.
`static PolicyRequest`	`parseXML(Node pNode)` Returns a `PolicyRequest` object constructed from a XML.
`void`	`setAdvicesHandleableByAMRequest(AdvicesHandleableByAMRequest advicesHandleableByAMRequest)` Sets the `AdvicesHandleableByAMRequest` sub element of `PolicyRequest`.
`void`	`setAppSSOToken(String ssoToken)` Sets the single sign on token of the application who sends the request.
`void`	`setMethodID(int id)` Sets the method ID of the Policy Request.
`void`	`setPolicyListenerRequest(PolicyListenerRequest req)` Sets the `PolicyListenerRequest` of the Policy Service.
`void`	`setRemoveListenerRequest(RemoveListenerRequest req)` Sets the `RemoveListenerRequest` of the Policy Service.
`void`	`setRequestId(String reqId)` Sets the request ID.
`void`	`setResourceResultRequest(ResourceResultRequest req)` Sets the resource result request object.
`String`	`toXMLString()` Returns a string representation of this object.

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

- Field Detail
  - POLICY_REQUEST_GET_RESOURCE_RESULTS
```
public static final int POLICY_REQUEST_GET_RESOURCE_RESULTS
```
    Policy Request - Get Resource Results ID.
    
    See Also:
    
    Constant Field Values
  - POLICY_REQUEST_ADD_POLICY_LISTENER
```
public static final int POLICY_REQUEST_ADD_POLICY_LISTENER
```
    Policy Request - Add Policy Listener ID.
    
    See Also:
    
    Constant Field Values
  - POLICY_REQUEST_REMOVE_POLICY_LISTENER
```
public static final int POLICY_REQUEST_REMOVE_POLICY_LISTENER
```
    Policy Request - Remove Policy Listener ID.
    
    See Also:
    
    Constant Field Values
  - POLICY_REQUEST_ADVICES_HANDLEABLE_BY_AM_REQUEST
```
public static final int POLICY_REQUEST_ADVICES_HANDLEABLE_BY_AM_REQUEST
```
    Policy Request - Advices handleable by OpenAM ID.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PolicyRequest
```
public PolicyRequest()
```
    Default constructor for PolicyRequest.
- Method Detail
  - getMethodID
```
public int getMethodID()
```
    Returns the method ID of the Policy Request.
    
    Returns:
    
    the method ID.
  - getMethodName
```
public String getMethodName()
```
    Retrieves the string representation of the method Id.
    
    Returns:
    
    the string representation of the method Id
    
    Throws:
    
    IllegalStateException - should the method Id become unknown
  - setMethodID
```
public void setMethodID(int id)
```
    Sets the method ID of the Policy Request.
    
    Parameters:
    
    id - the method ID.
  - getAppSSOToken
```
public String getAppSSOToken()
```
    Returns the single sign on token of the application who sends the request.
    
    Returns:
    
    the single sign on token of the application.
  - setAppSSOToken
```
public void setAppSSOToken(String ssoToken)
```
    Sets the single sign on token of the application who sends the request.
    
    Parameters:
    
    ssoToken - the single sign on token of the application.
  - getRequestId
```
public String getRequestId()
```
    Returns the request ID.
    
    Returns:
    
    the request ID.
  - setRequestId
```
public void setRequestId(String reqId)
```
    Sets the request ID.
    
    Parameters:
    
    reqId - the ID of the request.
  - getResourceResultRequest
```
public ResourceResultRequest getResourceResultRequest()
```
    Returns the resource result request object.
    
    Returns:
    
    the resource result request.
  - setResourceResultRequest
```
public void setResourceResultRequest(ResourceResultRequest req)
```
    Sets the resource result request object.
    
    Parameters:
    
    req - the resource result request.
  - getPolicyListenerRequest
```
public PolicyListenerRequest getPolicyListenerRequest()
```
    Returns the PolicyListenerRequest object.
    
    Returns:
    
    the PolicyListenerRequest object.
  - setPolicyListenerRequest
```
public void setPolicyListenerRequest(PolicyListenerRequest req)
```
    Sets the PolicyListenerRequest of the Policy Service.
    
    Parameters:
    
    req - the PolicyListenerRequest of this Policy Service
  - getRemoveListenerRequest
```
public RemoveListenerRequest getRemoveListenerRequest()
```
    Returns the RemoveListenerRequest object.
    
    Returns:
    
    the RemoveListenerRequest object
  - setRemoveListenerRequest
```
public void setRemoveListenerRequest(RemoveListenerRequest req)
```
    Sets the RemoveListenerRequest of the Policy Service.
    
    Parameters:
    
    req - the RemoveListenerRequest of this Policy Service
  - setAdvicesHandleableByAMRequest
```
public void setAdvicesHandleableByAMRequest(AdvicesHandleableByAMRequest advicesHandleableByAMRequest)
```
    Sets the AdvicesHandleableByAMRequest sub element of PolicyRequest.
    
    Parameters:
    
    advicesHandleableByAMRequest - the AdvicesHandleableByAMRequest sub element of PolicyRequest.
  - parseXML
```
public static PolicyRequest parseXML(Node pNode)
                              throws PolicyEvaluationException
```
    Returns a PolicyRequest object constructed from a XML.
    
    Parameters:
    
    pNode - the XML DOM node for the PolicyRequest object.
    
    Returns:
    
    constructed PolicyRequest object
    
    Throws:
    
    PolicyEvaluationException
  - toXMLString
```
public String toXMLString()
```
    Returns a string representation of this object.
    
    Returns:
    
    a string representation of this object.

Class PolicyRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

POLICY_REQUEST_GET_RESOURCE_RESULTS

POLICY_REQUEST_ADD_POLICY_LISTENER

POLICY_REQUEST_REMOVE_POLICY_LISTENER

POLICY_REQUEST_ADVICES_HANDLEABLE_BY_AM_REQUEST

Constructor Detail

PolicyRequest

Method Detail

getMethodID

getMethodName

setMethodID

getAppSSOToken

setAppSSOToken

getRequestId

setRequestId

getResourceResultRequest

setResourceResultRequest

getPolicyListenerRequest

setPolicyListenerRequest

getRemoveListenerRequest

setRemoveListenerRequest

setAdvicesHandleableByAMRequest

parseXML

toXMLString