sfi.director.application.objevents.Workflow Class Reference

List of all members.

Detailed Description

implementing some higher level functionality set on top of EventEnvironment.

Basically you use doEvent() for stacking up jobs and flush() for passing a job stack to the Scheduler.


Public Member Functions

 Workflow ()
 Workflow (boolean inQueue)
 Workflow (String description)
 Workflow (String description, String name)
 Workflow (String description, String name, boolean inQueue)
void finalize ()
void setInQueue (boolean queue)
void dispose ()
void setDescr (String name)
void setName (String name)
synchronized void flush () throws DirectorException
synchronized void addJob (Job job)
synchronized void addHead (JobNode job)
synchronized void addWorkflow (Workflow wf)
synchronized void doEvent (EventEnvironment env, String type) throws DirectorException
void doEvent (DBObject dbo, final DBConnection dir, final Record data, final String type) throws DirectorException
void doEvent (DBObject dbo, final DBConnection dir, final Record data, final String type, boolean warnIfNotApplicable) throws DirectorException
 Execute an event for a given database entry and the given corresponding object editor data.
void setMonitorOptions (String name)
void setMonitorOptions (String name, String contents)
void openMonitor () throws DirectorException
LogEntry watch () throws DirectorException
JobStatus getStatus ()
void closeMonitor ()
String getId ()
void setId (String id)
JobNode getMaster ()

Package Attributes

String name = null
String description = null
Vector jobHeads = new Vector()
Vector jobs = new Vector()
String headId = null
JobNode jobMaster = null
Options monitorOptions = new Options()
BufferedReader monitorStream = null
boolean pollMonitor = false
JobStatus status = JobStatus.setup
Socket monitorSocket = null
boolean preserveQueue = false


Constructor & Destructor Documentation

sfi.director.application.objevents.Workflow.Workflow  ) 
 

sfi.director.application.objevents.Workflow.Workflow boolean  inQueue  ) 
 

sfi.director.application.objevents.Workflow.Workflow String  description  ) 
 

sfi.director.application.objevents.Workflow.Workflow String  description,
String  name
 

sfi.director.application.objevents.Workflow.Workflow String  description,
String  name,
boolean  inQueue
 


Member Function Documentation

synchronized void sfi.director.application.objevents.Workflow.addHead JobNode  job  ) 
 

synchronized void sfi.director.application.objevents.Workflow.addJob Job  job  ) 
 

synchronized void sfi.director.application.objevents.Workflow.addWorkflow Workflow  wf  ) 
 

void sfi.director.application.objevents.Workflow.closeMonitor  ) 
 

void sfi.director.application.objevents.Workflow.dispose  ) 
 

void sfi.director.application.objevents.Workflow.doEvent DBObject  dbo,
final DBConnection  dir,
final Record  data,
final String  type,
boolean  warnIfNotApplicable
throws DirectorException
 

Execute an event for a given database entry and the given corresponding object editor data.

void sfi.director.application.objevents.Workflow.doEvent DBObject  dbo,
final DBConnection  dir,
final Record  data,
final String  type
throws DirectorException
 

synchronized void sfi.director.application.objevents.Workflow.doEvent EventEnvironment  env,
String  type
throws DirectorException
 

void sfi.director.application.objevents.Workflow.finalize  ) 
 

synchronized void sfi.director.application.objevents.Workflow.flush  )  throws DirectorException
 

String sfi.director.application.objevents.Workflow.getId  ) 
 

JobNode sfi.director.application.objevents.Workflow.getMaster  ) 
 

JobStatus sfi.director.application.objevents.Workflow.getStatus  ) 
 

void sfi.director.application.objevents.Workflow.openMonitor  )  throws DirectorException
 

void sfi.director.application.objevents.Workflow.setDescr String  name  ) 
 

void sfi.director.application.objevents.Workflow.setId String  id  ) 
 

void sfi.director.application.objevents.Workflow.setInQueue boolean  queue  ) 
 

void sfi.director.application.objevents.Workflow.setMonitorOptions String  name,
String  contents
 

void sfi.director.application.objevents.Workflow.setMonitorOptions String  name  ) 
 

void sfi.director.application.objevents.Workflow.setName String  name  ) 
 

LogEntry sfi.director.application.objevents.Workflow.watch  )  throws DirectorException
 


Member Data Documentation

String sfi.director.application.objevents.Workflow.description = null [package]
 

String sfi.director.application.objevents.Workflow.headId = null [package]
 

Vector sfi.director.application.objevents.Workflow.jobHeads = new Vector() [package]
 

JobNode sfi.director.application.objevents.Workflow.jobMaster = null [package]
 

Vector sfi.director.application.objevents.Workflow.jobs = new Vector() [package]
 

Options sfi.director.application.objevents.Workflow.monitorOptions = new Options() [package]
 

Socket sfi.director.application.objevents.Workflow.monitorSocket = null [package]
 

BufferedReader sfi.director.application.objevents.Workflow.monitorStream = null [package]
 

String sfi.director.application.objevents.Workflow.name = null [package]
 

boolean sfi.director.application.objevents.Workflow.pollMonitor = false [package]
 

boolean sfi.director.application.objevents.Workflow.preserveQueue = false [package]
 

JobStatus sfi.director.application.objevents.Workflow.status = JobStatus.setup [package]
 


The documentation for this class was generated from the following file:
Generated on Sat Feb 11 01:20:15 2012 for Node Director by  doxygen 1.4.5