XGController

Inherits from:
Declared In:

Overview

This class provides a local interface to remote Xgrid controllers.

Discussion

Instances of this class each connect to an individual controller. The association between an instance and a remote Xgrid controller is represented by the instance's connection property. Instances of XGController automatically keep themselves up-to-date by monitoring changes to the controller they are connected to. Instances can have predicate strings set which cause the controller to selectively filter which properties get updated. If a property predicate string is set to "FALSE" then that property will not be updated at all.



Methods

-defaultGrid

Returns the default grid, or nil if there is no default grid.

-gridForIdentifier:

Returns the grid with the specified identifier, or nil if the controller does not manage the grid with the specified identifier.

-grids

Returns an array of the grids lists managed by the controller.

-initWithConnection:

The designated initializer.

-jobsPredicateString

Returns the predicate string used to filter jobs.

-performSubmitJobActionWithJobSpecification:gridIdentifier:

Attempts to submit a job to the specified grid, or the default grid if no grid is specified.

-setJobsPredicateString:

Sets the predicate string used to filter jobs.


defaultGrid


Returns the default grid, or nil if there is no default grid.

- (XGGrid *)defaultGrid; 
Return Value

An XGGrid instance, or nil.


gridForIdentifier:


Returns the grid with the specified identifier, or nil if the controller does not manage the grid with the specified identifier.

- (XGGrid *)gridForIdentifier:(NSString *)identifier; 
Parameters
identifier

The identifier of the grid.

Return Value

An XGGrid instance, or nil.


grids


Returns an array of the grids lists managed by the controller.

- (NSArray *)grids; 
Return Value

An array of XGGrids.


initWithConnection:


The designated initializer.

- (id)initWithConnection:(XGConnection *)connection; 
Parameters
connection

The connection to be used by the receiver.

Return Value

An initialized instance.


jobsPredicateString


Returns the predicate string used to filter jobs.

- (NSString *)jobsPredicateString; 
Return Value

A predicate string.


performSubmitJobActionWithJobSpecification:gridIdentifier:


Attempts to submit a job to the specified grid, or the default grid if no grid is specified.

- (id)performSubmitJobActionWithJobSpecification:(NSDictionary *)jobSpecification 
        gridIdentifier:(NSString *)gridIdentifier; 
Return Value

An XGActionMontior instance for tracking the action progress.


setJobsPredicateString:


Sets the predicate string used to filter jobs.

- (void)setJobsPredicateString:(NSString *)predicateString; 
Parameters
predicateString

The predicate string used to filter jobs.

Did this document help you? Yes It's good, but... Not helpful...

 

Last Updated: 2009-08-12