org.jbind.xml.schema.reader
Interface IJob

All Superinterfaces:

IHasLocation

All Known Subinterfaces:

IComponentJob, ISchemaJob

All Known Implementing Classes:

ComponentJob, Job, SchemaJob

public interface IJob

extends IHasLocation

Processes a part of a schema.

Method Summary

boolean	checkSubJobsValidated() Checks if the validation step of all sub jobs has been executed.
void	executeCompletion(IConstraintViolations aViolations) Executes the completion step of the job.
void	executeCreation(IConstraintViolations aViolations) Executes the creation step of the job.
void	executeValidation(IConstraintViolations aViolations) Executes the validation step of the job.
java.lang.String	getDescription() Gets a short description of the job.
IInstantiator	getInstantiator() Gets the instantiator that controls the execution of this job.
boolean	getIsValidated() Checks if the validation step of this job has been executed.
IJob	getParent() Gets the job that initiated (created) this job.
java.util.Iterator	iterRefsForCompletion() Iterates the references that must be resolved before the completion step of this job can be executed.
java.util.Iterator	iterRefsForCreation() Iterates the references that must be resolved before the creation step of this job can be executed.
java.util.Iterator	iterRefsForValidation() Iterates the references that must be resolved before the validation step of this job can be executed.
java.util.Iterator	iterSubJobs() Iterates the sub jobs of this job.
void	setParent(IJob aParent) Sets the parent job.

Methods inherited from interface org.jbind.xml.base.IHasLocation

getLocation

Method Detail

iterRefsForCreation

public java.util.Iterator iterRefsForCreation()

Iterates the references that must be resolved before the creation step of this job can be executed.

Returns:

Returns an iterator of IJobRef. (required)

iterRefsForCompletion

public java.util.Iterator iterRefsForCompletion()

Iterates the references that must be resolved before the completion step of this job can be executed.

Returns:

Returns an iterator of IJobRef. (required)

iterRefsForValidation

public java.util.Iterator iterRefsForValidation()

Iterates the references that must be resolved before the validation step of this job can be executed.

Returns:

Returns an iterator of IJobRef. (required)

executeCreation

public void executeCreation(IConstraintViolations aViolations)
                     throws XmlException

Executes the creation step of the job. This step may be executed if all necessary references can be resolved (cf. iterRefsForCreation.

Returns:

Returns true iff the step was executed successfully.

Throws:

XmlException

executeCompletion

public void executeCompletion(IConstraintViolations aViolations)
                       throws XmlException

Executes the completion step of the job. This step may be executed if all necessary references can be resolved (cf. iterRefsForCompletion.

Returns:

Returns true iff the step was executed successfully.

Throws:

XmlException

executeValidation

public void executeValidation(IConstraintViolations aViolations)
                       throws XmlException

Executes the validation step of the job. This step may be executed if all necessary references can be resolved (cf. iterRefsForValidation and if the validation steps of all sub jobs have been executed.

Returns:

Returns true iff the step was executed successfully.

Throws:

XmlException

getParent

public IJob getParent()

Gets the job that initiated (created) this job.

Returns:

(optional) Returns the job that initiated this job. Schema jobs have no parent.

setParent

public void setParent(IJob aParent)

Sets the parent job.

Parameters:

aParent - (required).

getIsValidated

public boolean getIsValidated()

Checks if the validation step of this job has been executed.

Returns:

Returns true iff the validation step of this job has been executed.

checkSubJobsValidated

public boolean checkSubJobsValidated()

Checks if the validation step of all sub jobs has been executed.

Returns:

Returns true iff the validation steps of all sub jobs have been executed.

iterSubJobs

public java.util.Iterator iterSubJobs()

Iterates the sub jobs of this job.

Returns:

An iterator of IJobs.

getInstantiator

public IInstantiator getInstantiator()

Gets the instantiator that controls the execution of this job.

Returns:

An instantiator. (required)

getDescription

public java.lang.String getDescription()

Gets a short description of the job.

Returns:

A string (required).