public interface Goose3
extends org.systemsbiology.gaggle.core.Goose2
The Goose3 interface defines APIs for handling workflow related activities. A goose that supports workflow should perform the following tasks.
First, it should implement the handleWorkflowAction API. Boss passes a WorkflowAction to a goose using this API. Details
of the semantics of WorkflowAPI can be found in WorkflowAction
.
In handleWorkflowAction, the goose can leverage the APIs provided by GooseWorkflowManager
.
First, the goose should store the WorkflowAction using
GooseWorkflowManager.addSession(org.systemsbiology.gaggle.core.datatypes.WorkflowAction)
.
It can also implement UI components to display the next geese in the workflow and allow users to pick data for them.
Data picked for each subsequent goose should be submitted to the GooseWorkflowManager by
calling GooseWorkflowManager.addSessionTargetData(String, int, org.systemsbiology.gaggle.core.datatypes.GaggleData)
.
Once all the data is selected, the goose should call GooseWorkflowManager.CompleteWorkflowAction(Boss, String)
to submit the data to Boss.
Modifier and Type | Method and Description |
---|---|
org.systemsbiology.gaggle.core.datatypes.GaggleGooseInfo |
getGooseInfo()
Get information about a goose.
|
void |
handleWorkflowAction(WorkflowAction action)
Handles a workflowAction passed from the Boss to the goose.
|
void |
handleWorkflowInformation(java.lang.String type,
java.lang.String info)
Handles information passed from Boss.
|
void |
loadState(java.lang.String location)
Load the state according given the state file.
|
void |
saveState(java.lang.String directory,
java.lang.String filePrefix)
This API is called by the Boss during state saving.
|
void handleWorkflowAction(WorkflowAction action) throws java.rmi.RemoteException
action
- WorkflowAction passedjava.rmi.RemoteException
- on remote errorvoid handleWorkflowInformation(java.lang.String type, java.lang.String info) throws java.rmi.RemoteException
type
- type of the information passed from boss to the goose (can be error, warning, etc)info
- information passed from boss to the goosejava.rmi.RemoteException
- on remote errororg.systemsbiology.gaggle.core.datatypes.GaggleGooseInfo getGooseInfo() throws java.rmi.RemoteException
java.rmi.RemoteException
void saveState(java.lang.String directory, java.lang.String filePrefix) throws java.rmi.RemoteException
directory
- The destination directory to save the state files.filePrefix
- The prefix of the name of the state file.java.rmi.RemoteException
void loadState(java.lang.String location) throws java.rmi.RemoteException
location
- The full path name of the state file to be loaded.java.rmi.RemoteException