com.highdeal.bart.hci

Class SchedulableJobOperationResult

java.lang.Object

com.highdeal.bart.hci.SchedulableJobOperationResult

All Implemented Interfaces:

com.highdeal.hci.OperationResult, XMLMarshallable

Direct Known Subclasses:

CreateSchedulableJobResult, ModifySchedulableJobResult, SearchSchedulableJobResult

public abstract class SchedulableJobOperationResult
extends java.lang.Object
implements com.highdeal.hci.OperationResult

This class is a generic abstract class for the results returned by operations on Schedulable jobs.

• If the current operation on job must return a list of jobs, please use getJobs() method for the result obtention.
• If the current operation on job must return only one job, please use getJob() method for the result obtention.

Constructor Summary

Constructors

Constructor and Description
SchedulableJobOperationResult(java.lang.String resultTagName, boolean singleton) Builds an SchedulableJobOperationResult without job.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
SchedulableJobModel	getJob() Gets the job.
java.util.Vector<SchedulableJobModel>	getJobs() Gets the job list.
java.lang.String	getOperandReference()
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setJob(SchedulableJobModel job) Sets the job(internal use).
void	setJobs(java.util.Vector<SchedulableJobModel> list) Sets the jobs list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchedulableJobOperationResult

public SchedulableJobOperationResult(java.lang.String resultTagName,
                                     boolean singleton)

Builds an SchedulableJobOperationResult without job.

Parameters:

resultTagName - the operation result name.

singleton - is at true if there is only one result(job).

Method Detail

setJobs

public void setJobs(java.util.Vector<SchedulableJobModel> list)

Sets the jobs list.

Parameters:

list - a vector of SchedulableJobModel.

getJobs

public java.util.Vector<SchedulableJobModel> getJobs()

Gets the job list. This method must be called by the client, if the current operation on groups must return a list of jobs.

Returns:

a vector of SchedulableJobModel.

getJob

public SchedulableJobModel getJob()

Gets the job. This method must be called by the client, if the current operation on job must return a single job.

Returns:

the SchedulableJobModel.

setJob

public void setJob(SchedulableJobModel job)

Sets the job(internal use).

Parameters:

job - the job.

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into

getOperandReference

public java.lang.String getOperandReference()

Specified by:

getOperandReference in interface com.highdeal.hci.OperationResult