| org.cougaar.tools.csmart.society.SocietyComponent
All known Subclasses: org.cougaar.tools.csmart.society.SocietyBase,
| SocietyComponent | | public interface SocietyComponent extends ModifiableComponent(Code) | | The interface for adding and removing nodes from a society.
|
| copyAndSave | | ModifiableComponent copyAndSave(String name)(Code) | | Copy this Society and save the copy to the database, under
the given new name. If the save fails, the new society
will be marked modified when this method returns
Parameters:
name - a String new society name a ModifiableComponent new society |
| getAgents | | AgentComponent[] getAgents()(Code) | | Get the agents, both assigned and unassigned.
array of agent components |
| getAssemblyId | | String getAssemblyId()(Code) | | Get the assembly id for this Society.
a String which is the assembly id for this Society |
| getCleanupFileFilter | | FileFilter getCleanupFileFilter()(Code) | | Return a file filter which can be used to delete
the files generated by this experiment.
FileFilter for cleanup |
| getDescription | | URL getDescription()(Code) | | Returns the description of this society
an URL value |
| getResultFileFilter | | FileFilter getResultFileFilter()(Code) | | Return a file filter which can be used to fetch
the metrics files for this experiment.
FileFilter to get metrics files for this experiment |
| getSocietyName | | String getSocietyName()(Code) | | Get the name of the society.
the name of the society |
| isModified | | boolean isModified()(Code) | | Has this society been modified, such that a save would do something.
a boolean, false if no save necessary |
| isRunning | | boolean isRunning()(Code) | | Returns whether or not the society is running,
i.e. can be dynamically monitored.
Running societies are not editable, but they can be copied,
and the copy can be edited.
true if society is running and false otherwise |
| isSelfTerminating | | boolean isSelfTerminating()(Code) | | Returns whether the society is self terminating or must
be manually terminated.
Self terminating nodes cause the app-server to send back
a "process-destroyed" message when the node terminates.
true if society is self terminating |
| saveToDatabase | | boolean saveToDatabase()(Code) | | Save this society to the database. Only to be used
after creating a new society. Not to be used from DB societies
which are already in the database.
a boolean, false on error |
| setRunning | | void setRunning(boolean isRunning)(Code) | | Set by the experiment controller to indicate that the
society is running.
The society is running from the moment that any node
is successfully created
(via the app-server's "create" method)
until all nodes are terminated (aborted, self terminated, or
manually terminated).
Parameters:
isRunning - flag indicating whether or not the society is running |
|
|