Entity

class Entity(*args)

Bases: object

The Entity class is an identification of a persistant entity in the ALMA archive. It easily maps onto an EntityT object in the ACS system entities.

Adapted from the c++ and Java implementations of this class.

Methods Summary

equals(entity)	Returns True if entity is an Entity and it’s values are equal to this Entity
fromBin(ein)	Create and return an Entity from an EndianInput instance.
getEntityId()
getEntityIdEncrypted()
getEntityTypeName()
getEntityVersion()
getInstance(stringList)	This mirrors similar functions in the other types.
getInstanceVersion()
isNull()	Return True if the entityId is null
setEntityId(entityId)	Set the entityId, an EntityId or a valid string can be used.
setEntityIdEncrypted(entityIdEncrypted)
setEntityTypeName(entityTypeName)
setEntityVersion(entityVersion)
setFromXML(xmlString)
setInstanceVersion(instanceVersion)
toBin(eout)	Write this Entity out to an EndianOutput instance.
toXML()	Return the values of this Entity as an XML-formatted string.

Methods Documentation

equals(entity)

Returns True if entity is an Entity and it’s values are equal to this Entity

static fromBin(ein)

Create and return an Entity from an EndianInput instance.

getEntityId()

getEntityIdEncrypted()

getEntityTypeName()

getEntityVersion()

static getInstance(stringList)

This mirrors similar functions in the other types. This should not be used to construct an Entity 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()

isNull()

Return True if the entityId is null

setEntityId(entityId)

Set the entityId, an EntityId or a valid string can be used.

setEntityIdEncrypted(entityIdEncrypted)

setEntityTypeName(entityTypeName)

setEntityVersion(entityVersion)

setFromXML(xmlString)

setInstanceVersion(instanceVersion)

toBin(eout)

Write this Entity out to an EndianOutput instance.

toXML()

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