Class Job

Object
   |
   +--Job

class Job

Defined in job.js

Constructor Detail

Job

Job( aObj )

Creates a Job. In most cases though you will want to use JobManager.createJob()

abort

void abort( )

Abort execution of the running job. This is only useful a jobId is is set. Leads to an "onjobaborted" event.

Returns:

Throws:
- Exception if any error occurs

addListener

void addListener( <string> aType , <function> aListener )

Add a listener for a particular type of callback. Only one listener per callback type is allowed

Parameters:
aType - the callback type
aListener - a function reference

addNamespace

void addNamespace( <string> use , <string> aNamespace )

Add a namespace of use to the web service. For example: job.addNamespace( "query" , "http://nbcr.sdsc.edu/gamess/types" ); will specify that query objects use the NBCR namespace. This will overwrite any existing namespace with the same purpose.

Parameters:
use - the purpose of the namespace
aNamespace - the namespace

addURI

void addURI( <string> aType , <string> aURI )

Add an additional URI of use to web service. For example: job.addURI( "query" , "http://athena.nbcr.net:8080/APBSStatusPort" ) ; will indicate to the Job object that the endpoint APBSStatusPort should be used when querying for status.

Parameters:
aType - the purpose of the uri
aURI - the uri

getAutoRun

boolean getAutoRun( )

Getter

getCode

int getCode( )

Get the status code of the job. Only useful if currently running

getId

string getId( )

This is not an id returned from a Web service. This id is for the framework to track this job throughout its life including when it does not have an id from a Web service.

getInterfaceURI

string getInterfaceURI( )

Returns the uri of the XUL panel associated with this job

getJobId

string getJobId( )

returns this job's JobId as returned by the web service. This will only be available after a Job is submitted.

Returns:
jobId could be null if not set

getLastResponseText

string getLastResponseText( )

Get the last SOAP message recieved in it's raw form

getListeners

hash getListeners( )

Get all listeners of of the job

Returns:
hash of use, listener name pairs

getNamespaces

hash getNamespaces( )

Get all namespaces of of the job

Returns:
hash of use, namespace pairs

getOutput

void getOutput( )

Call the getOutput operation of the Web service. This is only if the job has already completed and autoRun is false. Can be called multiple times but will only lead to an "onjobcompletion" event the first time.

getQueryInterval

int getQueryInterval( )

Returns the time interval between status queries

Returns:
the time, in milliseconds

getServiceName

string getServiceName( )

Get the name of the service this job is tied to.

getServiceURI

string getServiceURI( )

Get the main service URI of the job

getStatusMessage

string getStatusMessage( )

Get the status message of the job. Only useful if currently running

getTimeCompleted

int getTimeCompleted( )

Returns the millisecond representation (number of milliseconds between 1/1/1970 GMT) of this job's completion time.

getTimeOfLast

int getTimeOfLast( )

Returns the millisecond representation (number of milliseconds between 1/1/1970 GMT) of this job's time of last operation.

getTimeStarted

int getTimeStarted( )

Returns the millisecond representation (number of milliseconds between 1/1/1970 GMT) of this job's start time.

init

void init( aObj )

isActive

boolean isActive( )

Whether this job is currently executing a request of some sort: launch, status, getting outputs, etc.

isSecure

boolean isSecure( )

Whether this job is secure.

launch

void launch( <string> body )

Start the job If successful this will lead to an "onjoblaunched" event.

Parameters:
body - this job's input

open

void open( <string> uri, <boolean> autoRun, <string> type , <string> serviceName)

Prepare this job for being run

Parameters:
uri - the main service URI
autoRun - whether to handle querying and completion automatically or not
type - what class of service will be run. Options are "opal" and ""
serviceName - the service name

query

void query( )

Run a one shot query for status of the job. This is only useful a jobId is is set and autoRun is false. Leads to an "onjobquery" event.

See:
- open()
- setAutoRun()

removeAllListeners

Object removeAllListeners( )

Removes all listeners

removeListener

void removeListener( <string> aType )

Remove a listener from this job.

Parameters:
aType - the listener type to remove

setAutoRun

void setAutoRun( <boolean> val )

Set whether to handle querying and completion automatically or not

Parameters:
val -

Returns:
-

setId

void setId( <string> id )

Sets this Job object's internal id. This should normally be used only the framework.

Parameters:
id -

setInterfaceURI

void setInterfaceURI( <string> uri )

Sets the URI of the XUL panel associated with this job

Parameters:
uri -

setQueryInterval

void setQueryInterval( aInterval )

Sets the time interval between status queries

Parameters:
the - time, in milliseconds

setServiceName

void setServiceName( <string> sn )

Set the name of the service this job is tied to.

Parameters:
sn -