com.highdeal.bart.hci
Class AcquisitionSessionOperationResult

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

Direct Known Subclasses:

StartAcquisitionSessionResult, StopAcquisitionSessionResult

public abstract class AcquisitionSessionOperationResult
extends java.lang.Object

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

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

Method Summary

void	addCharacterData(java.lang.String cData)
void	addChild(java.lang.String tagName, XMLMarshallable child)
AcquisitionSessionModel	getAcquisitionSession() Gets the AcquisitionSessionModel.
java.util.Vector<AcquisitionSessionModel>	getAcquisitionSessions() Gets the acquisition session list.
java.lang.String	getOperandReference()
void	marshal(XMLOutputter output)
void	setAcquisitionSession(AcquisitionSessionModel session)
void	setAcquisitionSessions(java.util.Vector<AcquisitionSessionModel> list) Sets the acquisition session list.
void	setAttributes(XMLAttributes atts)

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)

addCharacterData

public void addCharacterData(java.lang.String cData)

addChild

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

marshal

public void marshal(XMLOutputter output)

getOperandReference

public java.lang.String getOperandReference()