com.highdeal.bart.hci
Class SearchSchedulableJobOp

java.lang.Object
  com.highdeal.bart.hci.SearchSchedulableJobOp

All Implemented Interfaces:

com.highdeal.hci.MessageOperation, XMLMarshallable

public class SearchSchedulableJobOp
extends java.lang.Object
implements com.highdeal.hci.MessageOperation

This operation allows to search schedulable jobs. If a jobID is provided, It will search for this specific job. If no jobID is provided, it will search for all existing jobs.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchSchedulableJob">
   <xs:complexType>
     <xs:attribute name="jobID" type="xs:string"/>
   </xs:complexType>
 </xs:element>

Constructor Summary

SearchSchedulableJobOp()
Builds an empty operation.

Method Summary

void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable marsh) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.lang.Long	getJobID() Gets the job unique ID.
java.lang.String	getName() Gets the name.
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	setJobID(java.lang.Long jobID) Sets the job unique ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchSchedulableJobOp

public SearchSchedulableJobOp()

Builds an empty operation.

Method Detail

getName

public java.lang.String getName()

Gets the name.

Specified by:

getName in interface com.highdeal.hci.MessageOperation

Returns:

the name.

getJobID

public java.lang.Long getJobID()

Gets the job unique ID.

Returns:

the job unique ID.

setJobID

public void setJobID(java.lang.Long jobID)

Sets the job unique ID. If set to null, all jobs will be searched.

Parameters:

jobID - the job unique ID.

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 marsh)

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

marsh - 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