org.eclipse.higgins.idas.api
Interface IEntity

All Superinterfaces:

IHasAttributes, IValue

public interface IEntity
extends IValue

As defined at http://wiki.eclipse.org/Entity and http://wiki.eclipse.org/Context, This interface holds a set of IEntity objects.

All Entities follow the http://www.eclipse.org/higgins/ontologies/2008/6/higgins ontology as a base. TODO (Doc): Finish javadoc on methods

Field Summary

Fields inherited from interface org.eclipse.higgins.idas.api.IValue

BASE_OWL_URI

Method Summary

IContext	getContext()
String	getEntityID()
IEntityModel	getModel() Returns a model of this type of Entities as it defined in the context's schema.
boolean	isProxy() Indicates whether the entity belongs to this context or is just a reference to an entity from another context.

Methods inherited from interface org.eclipse.higgins.idas.api.IValue

getType, getValueModel, isSimple, remove

Methods inherited from interface org.eclipse.higgins.idas.api.IHasAttributes

addAttribute, addAttribute, addAttributeValue, getAttribute, getAttributes, getSingleValuedAttribute, removeAttribute, removeAttributeValue, removeAttributeValue

Method Detail

getModel

IEntityModel getModel()

Returns a model of this type of Entities as it defined in the context's schema. Returned model could be used to discover what attributes are defined in the context's schema for this type of Entities.

Returns:

the model of this Entity

getContext

IContext getContext()
                    throws IdASException

Returns:

The Context holding this Entity.

Throws:

IdASException

getEntityID

String getEntityID()
                   throws IdASException

Returns:

Contextually unique identifier of this Entity

Throws:

IdASException

isProxy

boolean isProxy()
                throws IdASException

Indicates whether the entity belongs to this context or is just a reference to an entity from another context. If entity is a reference, its type is null and it does not contain any attribute.

Returns:

true if this is a reference, false otherwise.

Throws:

IdASException