org.biomoby.shared.data
Interface MobyDataInstance

All Known Subinterfaces:

MobyDataServiceAssocInstance

All Known Implementing Classes:

MobyDataBoolean, MobyDataBytes, MobyDataComposite, MobyDataDateTime, MobyDataFloat, MobyDataInt, MobyDataObject, MobyDataObjectDeferred, MobyDataObjectDeferredSAI, MobyDataObjectSAI, MobyDataObjectSet, MobyDataObjectSetDeferred, MobyDataObjectSetDeferredSAI, MobyDataObjectSetSAI, MobyDataObjectVector, MobyDataSecondaryInstance, MobyDataString, MobyDataXref

public interface MobyDataInstance

A convenience interface for passing arrays of instance data around without needing to type cast.

Field Summary

static int	CENTRAL_XML_MODE
static int	SERVICE_XML_MODE

Method Summary

String	getName()
Object	getObject() Each implementer will return the underlying Java object used to store the MOBY value.
Object	getUserData() Retrieves any application-specific data that may have been stored in association with this Moby object.
int	getXmlMode() Report whether toXML will produce Central template or service call instance XML.
void	setName(String name)
void	setUserData(Object data) Allows developers to track their application-specific information alongside the Moby functionality.
void	setXmlMode(int mode) Determined whether toXML will return a Central template value or a service call instance value.
String	toXML() Returns the MOBY XML representation of the object.

Field Detail

CENTRAL_XML_MODE

static final int CENTRAL_XML_MODE

See Also:

Constant Field Values

SERVICE_XML_MODE

static final int SERVICE_XML_MODE

See Also:

Constant Field Values

Method Detail

toXML

String toXML()

Returns the MOBY XML representation of the object.

setXmlMode

void setXmlMode(int mode)
                throws IllegalArgumentException

Determined whether toXML will return a Central template value or a service call instance value.

Parameters:

mode - one of CENTRAL_XML_MODE or SERVICE_XML_MODE

Throws:

IllegalArgumentException - if the mode is not one of the specified values

getXmlMode

int getXmlMode()

Report whether toXML will produce Central template or service call instance XML.

Returns:

one of CENTRAL_XML_MODE or SERVICE_XML_MODE

getObject

Object getObject()

Each implementer will return the underlying Java object used to store the MOBY value. For example, MOBY Floats are stored internally as BigDecimal objects.

getUserData

Object getUserData()

Retrieves any application-specific data that may have been stored in association with this Moby object. The returned object has nothing to do with the Moby protocol itself. See setUserData() for more details.

setUserData

void setUserData(Object data)

Allows developers to track their application-specific information alongside the Moby functionality. Provided for application developers' convenience: data stored using this routine is completely ignore by the Moby core libraries. If you want to store Moby data, use the routines defined in various subclasses of this class (e.g. MobyDataObject).

setName

void setName(String name)

getName

String getName()