All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class uhr.part.collab.NotificationRegistry 

java.lang.Object
   |
   +----uhr.part.collab.NotificationRegistry
public class NotificationRegistry
extends Object
implements ParamDriven, ServiceHost, UF_void_String_String, StateCommandable
This part records notifications versus a list of expected notifications and outputs the net result. It's designed for a variety of uses, such as: 
   - Recording tests
   - Tracking arrival of subassemblies needed for a part in mfg.
   - Knowing when it's okay to proceed in a workflow step, because
       the prior steps have all been completed.
   - Knowing when a complex subsystem is fully started and ready 
       for final turn on.
   - Etc, etc, etc.
For example the first use was the Full Regression Test for the Gen2 core. The part DK has the list of testids expected. many part report on the result of a test. When all test are complete the results are listed.

Constructor Index

o NotificationRegistry()

Method Index

o act(String, String)
This uniface is redirected to recordTestResult(...).
o clear()
Clears the recorder of any test state, such as recorded test results.
o doStateCommand(String)
Performs the command if its present state allows it.
o getParamDrivenAide()
Returns the aide-de-camp for the ParamDriven.
o getServiceHostAide()
Returns the aide handling the ServiceHost's attractor work.
o getStateCommandableAide()
Returns the aide handling the StateCommandable's state manchine.
o listResults()
Returns a list of the notification results.
o recordResult(String, String)
Records the result for the notificationID.
o setDK(Object)
Sets the DK listing all the notification_ids this part expects.

Constructors

o NotificationRegistry 
 public NotificationRegistry()

Methods

o getServiceHostAide 
 public ServiceHostAide getServiceHostAide()
Returns the aide handling the ServiceHost's attractor work. My ServiceItems are: 
   Type:      uhr.uniface.UF_void_String_String
   ServiceID: collaboration.NotifiyRegistryOfResult

Returns:
the aide.
o getParamDrivenAide 
 public ParamDrivenAide getParamDrivenAide()
Returns the aide-de-camp for the ParamDriven.

Returns:
the ParamDriven aide.
o setDK 
 public void setDK(Object dk)
Sets the DK listing all the notification_ids this part expects. If an ID is not recorded during a run, that is a defect. The DK format is: 
   
       
           SendMessageDirect;
           ReceiveMessageDirect;
           OpenBranchAutomatically;
Note the notification_ids MUST be ";" delimited.

Parameters:
param - the data structure containing the DK.
Throws: IllegalArgumentException
if the dk is problematic, such as duplicate ids.
o act 
 public void act(String arg1,
                 String arg2)
This uniface is redirected to recordTestResult(...).

Parameters:
arg1 - the testID.
arg2 - the problem.
o getStateCommandableAide 
 public StateCommandableAide getStateCommandableAide()
Returns the aide handling the StateCommandable's state manchine. My commands are "Clear" and "PrintResults".

Returns:
the very handy aide.
o doStateCommand 
 public void doStateCommand(String command)
Performs the command if its present state allows it.

Parameters:
command - the command to perform.
o clear 
 public void clear()
Clears the recorder of any test state, such as recorded test results. A clear() is automatically done when the part is created.

o recordResult 
 public void recordResult(String notificationID,
                          String problem)
Records the result for the notificationID. If the problem argument is null, the result was successful. Otherwise the problem is saved for analysis.

Parameters:
notificationID - uniquely identifies the notification withing the namespace of this part. Also sematically describes what is being notified about, such as a test .
problem - null for success or describes the problem.
Throws: IllegalArgumentException
if the id is unrecognized.
o listResults 
 public String listResults()
Returns a list of the notification results. There will be one line per problem plus a summary line at the end.

Returns:
the summary of results. 
All Packages  Class Hierarchy  This Package  Previous  Next  Index