com.unboundid.directory.sdk.broker.types

Interface AdviceStatement

public interface AdviceStatement

Interface providing access to Advice statements returned from a policy evaluation.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Get the value of any Trust Framework Attributes that were returned along with the Advice instance.
java.lang.String	getCode() Get the code (advice Id) of the Advice instance.
java.lang.String	getName() Get the name of the Advice instance.
java.lang.String	getPayload() Get the payload returned with this advice instance.
boolean	isObligatory() Determine whether this Advice is obligatory.

Method Detail

getName

java.lang.String getName()

Get the name of the Advice instance.

Returns:

the Advice name.

getCode

java.lang.String getCode()

Get the code (advice Id) of the Advice instance. The advice code corresponds to the type of advice returned.

Returns:

the Advice code.

getPayload

java.lang.String getPayload()

Get the payload returned with this advice instance.

Returns:

The payload string, whose interpretation is specific to the Advice type.

isObligatory

boolean isObligatory()

Determine whether this Advice is obligatory.

Returns:

boolean value, true for obligatory advice.

getAttributes

java.util.Map<java.lang.String,java.lang.String> getAttributes()

Get the value of any Trust Framework Attributes that were returned along with the Advice instance.

Returns:

a Map of Attribute name to Attribute value.