com.ibm.ram.policy
Class ResultDetail

java.lang.Object
  extended by com.ibm.ram.policy.ResultDetail
Direct Known Subclasses:
ArtifactResultDetail

public class ResultDetail
extends java.lang.Object

Represents one informational detail about a the compliance of a policy

Since:
7.0.0.1

Field Summary
static int ERROR
          Policy compliance error
static int INFO
          Policy compliance success
static int PENDING
          Policy result pending
static int WARNING
          Policy compliance warning
 
Constructor Summary
ResultDetail()
           
ResultDetail(int returnCode, java.lang.String message)
           
 
Method Summary
 void deserialize(java.lang.String metadata)
          Subclasses should override this to hydrate any saved data.
 java.lang.String getMessage()
          Get the message from this ResultDetail
 int getReturnCode()
          Get the return code from this ResultDetail
 java.lang.String serialize()
          Subclasses should override this to store any metadata.
 void setMessage(java.lang.String message)
          Set the message for this ResultDetail
 void setReturnCode(int returnCode)
          Set the return code for this ResultDetail
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

INFO

public static final int INFO
Policy compliance success

See Also:
Constant Field Values

WARNING

public static final int WARNING
Policy compliance warning

See Also:
Constant Field Values

ERROR

public static final int ERROR
Policy compliance error

See Also:
Constant Field Values

PENDING

public static final int PENDING
Policy result pending

See Also:
Constant Field Values
Constructor Detail

ResultDetail

public ResultDetail(int returnCode,
                    java.lang.String message)
Parameters:
returnCode - The return code of the ResultDetail
message - The message of the Result Detail
Since:
7.0.0.1

ResultDetail

public ResultDetail()
Since:
7.0.0.1
Method Detail

getMessage

public java.lang.String getMessage()
Get the message from this ResultDetail

Returns:
The message from the ResultDetail
Since:
7.0.0.1

setMessage

public void setMessage(java.lang.String message)
Set the message for this ResultDetail

Parameters:
message - The message for the ResultDetail
Since:
7.0.0.1

getReturnCode

public int getReturnCode()
Get the return code from this ResultDetail

Returns:
The return code from the ResultDetail
Since:
7.0.0.1

setReturnCode

public void setReturnCode(int returnCode)
Set the return code for this ResultDetail

Parameters:
returnCode - The return code for the ResultDetail
Since:
7.0.0.1

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

serialize

public java.lang.String serialize()
Subclasses should override this to store any metadata. Return any metadata needed for subclasses of ResultDetail as a String. RAM will call deserialize with this String when rehyradting this ResultDetail object.

Returns:
A string representation of ResultDetail metadata.
Since:
7.0.0.1

deserialize

public void deserialize(java.lang.String metadata)
Subclasses should override this to hydrate any saved data.

Parameters:
metadata - Previously serialized metadata to set for this ResultDetail
Since:
7.0.0.1