EntityRef

class EntityRef(*args)

Bases: object

The EntityRef class is an identification of a persistent entity in the ALMA archive. It wasily maps onto an EntiyREfT object in ACS system entities.

Methods Summary

equals(other)	Returns True if and only if other is an EntityRef and it’s values are all equal to this EntityRef.
from1DBin(eis)	Read a list of EntityRef from an EndianInput instance and return the resulting list.
fromBin(eis)	Read the binary representation of an EntityRef from an EndianInput instance and use the read values to set an EntityRef.
getEntityId()	Returns the entityId as a string
getEntityTypeName()	returns the entityTypeName string
getInstance(stringList)	This mirrors similar functions in the other types.
getInstanceVersion()	returns the instanceVersion string
getPartId()	Returns the partId as a string.
isNull()	Returns True if and only if the entityId is Null
listTo1DBin(entityRefList, eos)	Write a 1D list of EntityRef to the EndianOutput
listToBin(entityRefList, eos)	Write a list of EntityRef to the EndianOutput.
setEntityId(entityId)	Sets the entityId to this string, which must be a valid EntityId string
setEntityTypeName(entityTypeName)	sets the entityTypeName to the given string
setFromXML(xmlstr)	Set the values of this EntityRef from an XML formatted as produced by toXML
setInstanceVersion(instanceVersion)	sets the instanceVersion to the given string
setPartId(partId)	Sets the part to the given string
toBin(eos)	Write the binary representation of this into a DataOutput stream.
toXML()	Return the values of this EntityRef as an XML-formatted string.
validXML()	Used internally to validate this EntityRef for conversion to or after conversion from an XML string If this is invalid a string message is returned, otherwise None is returned.

Methods Documentation

equals(other)

Returns True if and only if other is an EntityRef and it’s values are all equal to this EntityRef.

static from1DBin(eis)

Read a list of EntityRef from an EndianInput instance and return the resulting list.

static fromBin(eis)

Read the binary representation of an EntityRef from an EndianInput instance and use the read values to set an EntityRef.

return an EntityRef

getEntityId()

Returns the entityId as a string

getEntityTypeName()

returns the entityTypeName string

static getInstance(stringList)

This mirrors similar functions in the other types. This should not be used to construct an EntityRef because of the complexity of that object. It is included here in case the translation from java includes such a use. If used it will raise a RuntimeError.

getInstanceVersion()

returns the instanceVersion string

getPartId()

Returns the partId as a string. If unset, returns None

isNull()

Returns True if and only if the entityId is Null

static listTo1DBin(entityRefList, eos)

Write a 1D list of EntityRef to the EndianOutput

static listToBin(entityRefList, eos)

Write a list of EntityRef to the EndianOutput. Only lists of 1D are supported.

setEntityId(entityId)

Sets the entityId to this string, which must be a valid EntityId string

setEntityTypeName(entityTypeName)

sets the entityTypeName to the given string

setFromXML(xmlstr)

Set the values of this EntityRef from an XML formatted as produced by toXML

setInstanceVersion(instanceVersion)

sets the instanceVersion to the given string

setPartId(partId)

Sets the part to the given string

toBin(eos)

Write the binary representation of this into a DataOutput stream.

toXML()

Return the values of this EntityRef as an XML-formatted string.

validXML()

Used internally to validate this EntityRef for conversion to or after conversion from an XML string If this is invalid a string message is returned, otherwise None is returned.