|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.ram.policy.Policy
public abstract class Policy
Must be implemented by all policies that are intended to be run in Rational Asset Manager.
| Nested Class Summary | |
|---|---|
static class |
Policy.CustomReturnCode
Policy writers use this class to map custom return codes to a description. |
| Constructor Summary | |
|---|---|
Policy()
|
|
| Method Summary | |
|---|---|
ConfigurationDetails[] |
getConfigurationDetails()
Deprecated. Use getConfigurationDetails(Locale) |
ConfigurationDetails[] |
getConfigurationDetails(java.util.Locale locale)
Get the custom fields of the policy |
Policy.CustomReturnCode[] |
getCustomReturnCodes(java.util.Locale locale)
Get the custom return codes of the policy. |
java.lang.String |
getDescription()
Deprecated. Use getDescription(Locale) |
java.lang.String |
getDescription(java.util.Locale locale)
Get the description of the policy |
abstract java.lang.String |
getID()
Return the unique identifier for the policy |
java.lang.String |
getName()
Deprecated. Use getName(Locale) |
java.lang.String |
getName(java.util.Locale locale)
Get the name of the policy |
java.util.Map<?,?> |
getParameters()
Get the Map of runtime parameters for this policy. |
abstract PolicyGovernor |
getPolicyGovernor()
Get the governor who owns this policy |
void |
initialize(java.util.Map<?,?> parameters)
Initialize the Map of parameters for the policy. |
abstract Result |
test()
Run the policy's compliance test |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Policy()
| Method Detail |
|---|
public void initialize(java.util.Map<?,?> parameters)
Map of parameters for the policy.
All classes extending this method should call super.initialize to ensure proper initialization.
parameters - Map of key/value pairs containing configuration details and other runtime parameters.public abstract Result test()
Note: This will be called with the Extension point's classloader as the thread context class loader.
Result of the compliance testpublic abstract PolicyGovernor getPolicyGovernor()
PolicyGovernor that contains this Policypublic abstract java.lang.String getID()
public java.lang.String getName()
getName(Locale)
public java.lang.String getName(java.util.Locale locale)
locale - The Locale of the user making the request.
public java.lang.String getDescription()
getDescription(Locale)
public java.lang.String getDescription(java.util.Locale locale)
locale - The Locale of the user making the request.
public ConfigurationDetails[] getConfigurationDetails()
getConfigurationDetails(Locale)
public ConfigurationDetails[] getConfigurationDetails(java.util.Locale locale)
locale - The Locale of the user making the request.
public Policy.CustomReturnCode[] getCustomReturnCodes(java.util.Locale locale)
locale - The Locale of the user making the request.
public java.util.Map<?,?> getParameters()
Map of runtime parameters for this policy.
Map of runtime parameters for this policy.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||