com.ibm.ram.common.data
Class PolicyResult

java.lang.Object
  extended by com.ibm.ram.common.data.PolicyResult

public class PolicyResult
extends java.lang.Object

Contains the results of running a policy on an asset

Since:
7.1.1

Field Summary
static int RETURN_CODE_ERROR
          Policy compliance error
static int RETURN_CODE_PENDING
          Policy result pending
static int RETURN_CODE_SUCCESS
          Policy compliance success
static int RETURN_CODE_SUCCESS_FORCE_APPROVE
          Policy result success force approve.
static int RETURN_CODE_WARNING
          Policy compliance warning
 
Constructor Summary
PolicyResult()
           
 
Method Summary
 PolicyResultDetail[] getDetails()
           
 java.lang.String getMessage()
           
 Policy getPolicy()
          The policy this result is associated with
 java.lang.String getResult()
          Deprecated. never used
 int getReturnCode()
          The overall return for for the policy result Values include: RETURN_CODE_SUCCESS_FORCE_APPROVE RETURN_CODE_SUCCESS RETURN_CODE_WARNING RETURN_CODE_ERROR RETURN_CODE_PENDING
 java.util.Date getTime()
           
 boolean isObsolete()
          A result is obsolete once it has been re-run in the current state.
 void setDetails(PolicyResultDetail[] details)
           
 void setMessage(java.lang.String message)
           
 void setObsolete(boolean obsolete)
          A result is obsolete once it has been re-run in the current state.
 void setPolicy(Policy policy)
          The policy this result is associated with
 void setResult(java.lang.String result)
          Deprecated. never used
 void setReturnCode(int returnCode)
          The overall return for for the policy result Values include: RETURN_CODE_SUCCESS_FORCE_APPROVE RETURN_CODE_SUCCESS RETURN_CODE_WARNING RETURN_CODE_ERROR RETURN_CODE_PENDING
 void setTime(java.util.Date time)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RETURN_CODE_SUCCESS_FORCE_APPROVE

public static final int RETURN_CODE_SUCCESS_FORCE_APPROVE
Policy result success force approve.

Will bypass review process if all other policies are at least WARNING or better.

Since:
7.2
See Also:
Constant Field Values

RETURN_CODE_SUCCESS

public static final int RETURN_CODE_SUCCESS
Policy compliance success

Since:
7.2
See Also:
Constant Field Values

RETURN_CODE_WARNING

public static final int RETURN_CODE_WARNING
Policy compliance warning

Since:
7.2
See Also:
Constant Field Values

RETURN_CODE_ERROR

public static final int RETURN_CODE_ERROR
Policy compliance error

Since:
7.2
See Also:
Constant Field Values

RETURN_CODE_PENDING

public static final int RETURN_CODE_PENDING
Policy result pending

Since:
7.2
See Also:
Constant Field Values
Constructor Detail

PolicyResult

public PolicyResult()
Method Detail

getResult

public java.lang.String getResult()
Deprecated. never used

Returns:
Returns the result.
Since:
7.1.1

setResult

public void setResult(java.lang.String result)
Deprecated. never used

Parameters:
result - The result to set.
Since:
7.1.1

getMessage

public java.lang.String getMessage()
Returns:
Returns the message.
Since:
7.1.1

setMessage

public void setMessage(java.lang.String message)
Parameters:
message - The message to set.
Since:
7.1.1

getDetails

public PolicyResultDetail[] getDetails()
Returns:
Returns the details.
Since:
7.1.1

setDetails

public void setDetails(PolicyResultDetail[] details)
Parameters:
details - The details to set.
Since:
7.1.1

getReturnCode

public int getReturnCode()
The overall return for for the policy result Values include: RETURN_CODE_SUCCESS_FORCE_APPROVE RETURN_CODE_SUCCESS RETURN_CODE_WARNING RETURN_CODE_ERROR RETURN_CODE_PENDING

Returns:
Returns the returnCode.
Since:
7.2

setReturnCode

public void setReturnCode(int returnCode)
The overall return for for the policy result Values include: RETURN_CODE_SUCCESS_FORCE_APPROVE RETURN_CODE_SUCCESS RETURN_CODE_WARNING RETURN_CODE_ERROR RETURN_CODE_PENDING

Parameters:
returnCode - The returnCode to set.
Since:
7.2

getPolicy

public Policy getPolicy()
The policy this result is associated with

Returns:
Returns the policy.
Since:
7.2

setPolicy

public void setPolicy(Policy policy)
The policy this result is associated with

Parameters:
policy - The policy to set.
Since:
7.2

isObsolete

public boolean isObsolete()
A result is obsolete once it has been re-run in the current state.

Returns:
Returns the obsolete.
Since:
7.2

setObsolete

public void setObsolete(boolean obsolete)
A result is obsolete once it has been re-run in the current state.

Parameters:
obsolete - The obsolete to set.
Since:
7.2

getTime

public java.util.Date getTime()
Returns:
Returns the time.
Since:
7.2

setTime

public void setTime(java.util.Date time)
Parameters:
time - The time to set.
Since:
7.2