com.highdeal.bart.hci

Class AcquisitionSessionOperationResult

java.lang.Object

com.highdeal.bart.hci.AcquisitionSessionOperationResult

All Implemented Interfaces:

com.highdeal.hci.OperationResult, XMLMarshallable

Direct Known Subclasses:

StartAcquisitionSessionResult, StopAcquisitionSessionResult

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

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

• If the current operation on AcquisitionSession must return a list of sessions, please use getAcquisitionSessions() method for the result obtention.
• If the current operation on AcquisitionSession must returns only one AcquisitionSession, please use gesAcquisitionSession() method for the result obtention.

Constructor Summary

Constructors

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

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.
AcquisitionSessionModel	getAcquisitionSession() Gets the AcquisitionSessionModel.
java.util.Vector<AcquisitionSessionModel>	getAcquisitionSessions() Gets the acquisition session list.
java.lang.String	getOperandReference()
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAcquisitionSession(AcquisitionSessionModel session)
void	setAcquisitionSessions(java.util.Vector<AcquisitionSessionModel> list) Sets the acquisition session list.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.

Methods inherited from class java.lang.Object

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

Constructor Detail

AcquisitionSessionOperationResult

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

Builds an AcquisitionSessionOperationResult without session.

Parameters:

resultTagName - the operation result name.

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

Method Detail

setAcquisitionSessions

public void setAcquisitionSessions(java.util.Vector<AcquisitionSessionModel> list)

Sets the acquisition session list.

Parameters:

list - a vector of AcquisitionSessionModel.

getAcquisitionSessions

public java.util.Vector<AcquisitionSessionModel> getAcquisitionSessions()

Gets the acquisition session list. This method must be called by the client, if the current operation on sessions must return a list of sessions.

Returns:

a vector of AcquisitionSessionModel.

getAcquisitionSession

public AcquisitionSessionModel getAcquisitionSession()

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

Returns:

the AcquisitionSessionModel.

setAcquisitionSession

public void setAcquisitionSession(AcquisitionSessionModel session)

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