com.ibm.commerce.rules
Class RuleServiceStatus

java.lang.Object
  |
  +--com.ibm.commerce.rules.RuleServiceStatus

public class RuleServiceStatus
extends java.lang.Object

Represents a rule service status report, consisting of reports from a number of application clones.


Field Summary
static java.lang.String COPYRIGHT
           
 
Constructor Summary
RuleServiceStatus(java.lang.String aServerName, RuleServiceKey aServiceKey)
          Creates a rule service status with an empty list of clone reports.
 
Method Summary
 java.util.Set collectCloneReports()
          Returns a Set of RuleServiceStatusCloneReports, containing the clone reports for this rule service.
 int countCloneReports()
           
 void eachCloneReport(RuleServiceStatusCloneReportBlock aBlock)
          Execute the specified block of code for each rule service status application clone report.
 java.lang.String getServerName()
           
 RuleServiceKey getServiceKey()
           
 RuleServiceStatusCode getStatus(java.lang.String aCloneName)
          Returns the status of this rule service for the specified application clone.
 boolean hasCloneReport(java.lang.String aCloneName)
          Answers the question, "Does this status report have a clone report for a certain clone?"
 void setStatus(java.lang.String aCloneName, RuleServiceStatusCode aStatusCode)
          Updates the status of this rule service for the specified clone.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
Constructor Detail

RuleServiceStatus

public RuleServiceStatus(java.lang.String aServerName,
                         RuleServiceKey aServiceKey)
Creates a rule service status with an empty list of clone reports.
Parameters:
aServerName - The name of the server to which the rule service for this status exists.
aServiceKey - The identifying key of the rule service for this status report.
Method Detail

collectCloneReports

public java.util.Set collectCloneReports()
Returns a Set of RuleServiceStatusCloneReports, containing the clone reports for this rule service.

countCloneReports

public int countCloneReports()

eachCloneReport

public void eachCloneReport(RuleServiceStatusCloneReportBlock aBlock)
Execute the specified block of code for each rule service status application clone report.

getServerName

public java.lang.String getServerName()

getServiceKey

public RuleServiceKey getServiceKey()

getStatus

public RuleServiceStatusCode getStatus(java.lang.String aCloneName)
Returns the status of this rule service for the specified application clone.

hasCloneReport

public boolean hasCloneReport(java.lang.String aCloneName)
Answers the question, "Does this status report have a clone report for a certain clone?"

setStatus

public void setStatus(java.lang.String aCloneName,
                      RuleServiceStatusCode aStatusCode)
Updates the status of this rule service for the specified clone.
Parameters:
aCloneName - The name of an application clone.
aStatusCode - A new status code representing the current status of this rule service in the specified clone.

toString

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