com.highdeal.bart.hci

Class SearchAcquisitionSessionOp

java.lang.Object

com.highdeal.bart.hci.SearchAcquisitionSessionOp

All Implemented Interfaces:

com.highdeal.hci.MessageOperation, XMLMarshallable

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

The search acquisition session operation allows to retrieve any acquisition session using a AcquisitionSessionSearchFilterModel to build search criterias.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="searchAcquisitionSession">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="acquisitionSessionSearchFilter" minOccurs="1" maxOccurs="1"/> 
     </xs:sequence>
   </xs:complexType>
 </xs:element>

Constructor Summary

Constructors

Constructor and Description
SearchAcquisitionSessionOp() Builds an empty operation.

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.
AcquisitionSessionSearchFilterModel	getFilter() Gets the acquisition session filter.
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	setFilter(AcquisitionSessionSearchFilterModel filter) Sets the acquisition session filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchAcquisitionSessionOp

public SearchAcquisitionSessionOp()

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.

getFilter

public AcquisitionSessionSearchFilterModel getFilter()

Gets the acquisition session filter.

Returns:

the filter to apply.

setFilter

public void setFilter(AcquisitionSessionSearchFilterModel filter)

Sets the acquisition session filter.

Parameters:

filter - the filter to apply.

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