Package com.epicentric.entity

Provides management of entities, which are any objects that have configurable properties and are uniquely identifiable; used at this time only to support user management.

See:
Package Summary

Interface Summary

ChildEntity	This interface is used for entities that can have other entities as parents.
Entity	An Entity represents a particular class of object with multiple configurable properties.
ParentEntity	This interface is used for entities that can have other entities as children.

Class Summary

EntityProperty	An entity property is a representation of an entity's attribute.
EntityType	An EntityType defines a particular class of entity.

Exception Summary

EntityManagementException	Base class for all checked exceptions associated with the Entity Management Subsystem.
EntityManagementRuntimeException	Base class for all runtime exceptions associated with the Entity Management Subsystem.
EntityNotFoundException	Exception thrown when the requested entity does not exist in the system.
EntityPersistenceException	Exception representing an error in storing, retrieving, or querying an entity persistence store.
EntityTypeMismatchException	Exception resulting from an attempt to initiate a process using an incorrect entity type.
EntityTypeNotCreatableException	Exception resulting from an attempt to create an entity of an entity type that is marked as not creatable.
EntityTypeNotDeletableException	Exception resulting from an attempt to delete an entity of an entity type that is marked as not deletable.
EntityTypeNotSearchableException	Exception thrown when a query is attempted against an entity type that is marked as not searchable.
IllegalEntityRelationshipException	Exception resulting from an attempt to create, remove, or query an entity relationship that is not supported.
PropertyDataTypeMismatchException	Exception resulting from an attempt to set a property of a particular data type to a value of a different data type.
PropertyNotEditableException	Exception resulting from an attempt to set a property that is marked as not editable.
PropertyNotFoundException	Exception thrown when the requested property does not exist in the entity type definition for the entity in question.
PropertyNotSearchableException	Exception thrown when a query is attempted with a property that is marked as not searchable.
PropertyNotUniqueException	Exception thrown when the method EntityManager.getEntity() is passed a propertyID of a property that is not marked as unique.
PropertyRequiredException	Exception thrown when the requested property is marked as required, but was not set when the entity was created.
UniquePropertyValueConflictException	Exception resulting from an attempt to assign a value to an entity property that has been declared unique when an entity of the same type and same property value already exists.

Package com.epicentric.entity Description

Provides management of entities, which are any objects that have configurable properties and are uniquely identifiable; used at this time only to support user management. The Vignette Portal user system supports two types of entities: users and user groups.

The properties of an entity are defined through a configuration file. This file can be modified--for example, to add custom properties or to make certain properties read-only. Vignette Portal Configuration Guide, available from http://global.vignette.com, explains how to modify this configuration file.

Entities can have hierarchical relationships to each other. For example, a user is a child of a user group, and a user group can be a parent of a user, a user group, or both. Entities can have many-to-many relationships; a single parent can have multiple children and a single child can have multiple parents. Note that an entity does not correlate to an entity relationship diagram. For example, entities are not necessarily persisted, but if they are many different persistence mechanisms can be used.

Methods in this package support querying the properties of users and user groups. The user package should be used to access users and user groups.

See:
Discussion

See Also:

com.epicentric.user, com.epicentric.uid