Package org.cyclos.model

Base package for all model classes. Sub-packages represents modules in Cyclos.

Interface Summary

Interface	Description
BeanDataAccessor	Provides access to bean data, allowing getting and setting properties.
BeanDataAccessorFactory	Factory for context-sensitive BeanDataAccessor.
IEntity	Common interface for entities
IInternalNamedEntity	It represents an entity with an internal name. It must be implemented by those entities/dtos allowing search by internal name.
INamedEntity	Represents an entity with a name
IUnqualifiedInternalNamedEntity	It must be implemented by those entities for which the internal name should not be qualified when returning to the client.

Class Summary

Class	Description
AbstractBeanDataAccessor	Basic implementation for BeanDataAccessor
ActionWithConfirmationPassword
BasicProperty<T,B extends Bean>	A property for basic types
Bean	This is the base class for all generated model beans in Cyclos.
BeanComparator<T extends Bean>	A comparator used with properties of Beans
BeanDataAccessorFactory.Instance	Provides access to the BeanDataAccessorFactory
ConfigurationEntityDTO	Base class for all named entities containing internal name and description properties.
ConfigurationEntityVO	Base class for VOs of configuration entities
EntityData<DTO extends EntityDTO>	Base class for entity data objects, which contains an EntityDTO and other contextual data needed to edit that DTO, such as possible data for relationships, logs, permissions and other data
EntityDTO	The EntityDTO is an editable representation of an entity
EntityModel	Base class for entity DTOs or VOs.
EntityVO	An EntityVO is a view-only representation of an entity
IdComparator	A Comparator that compare entity ids
IterableProperty<T,C extends Iterable<T>,B extends Bean>	A base class for collection properties.
ListProperty<T,B extends Bean>	A property for lists.
MapBeanDataAccessor	Provides simple data storage for Beans in a HashMap
MapBeanDataAccessorFactory	Simple Map implementation of BeanDataAccessorFactory
MapProperty<K,V,B extends Bean>	A Property which holds a Map
NamedEntityDTO	Base class for all entities containing a Property representing its name.
NamedEntityVO	Base class for all read only views of a entity which contains a Property representing its name.
NestedProperty<T,B extends Bean>	A Property which is created from a path of other properties
PageProperty<T,B extends Bean>	A property for pages.
Property<T,B extends Bean>	Represents a property in the generated objects
QueryParameters	Base class for search parameters objects.
SearchData<Q extends QueryParameters>	Base class for search data objects, which contains a QueryParameters and other contextual data needed search some kind of entity
SetProperty<T,B extends Bean>	A property for sets.
Submodules	Contains helper methods to handle Submodules
TranslatableUIElementResultVO
TranslatableVersionedVO
VersionedVO

Enum Summary

Enum	Description
Availability	Utility enum with the possible values regarding availability of some data.
CRUDOperation	The CRUD operations
TextMode	Determines how textual data is handled
TrimMode	Indicates how texts should be trimmed

Exception Summary

Exception	Description
BusinessException	Base exception for service-specific business exceptions
ConstraintViolatedOnRemoveException	Error while removing an entity due to constraints
CredentialsNotSuppliedException	Exception thrown when attempting to invoke a service method, but no credentials were supplied when expected (for example, in RPC calls)
CSSCompileException	Thrown when the CSS could not be compiled.
CyclosException	Base for all exceptions generated in Cyclos.
DataAccessException	Represents an exception on the data access (database or content storage)
EntityNotFoundException	Exception thrown when an expected entity was not found
FileParsingException	Exception thrown when a file being parsed has an invalid format
FrameworkException	Base exception for common exceptions, generated by general usage of service methods
IllegalActionException	Exception thrown when attempting to perform an action which is not allowed.
IllegalInvocationException	Exception thrown when an attempt to invoke a remote method was invalid
InternalException	Base class for all those exceptions thrown by the server but never exposed to the client.
LockAcquisitionException	Exception thrown when an expected lock couldn't be acquired
MaxItemsException	Exception thrown when attempting to create a new data but the maximum allowed items has already reached
QueryParseException	Exception thrown whenever there's a query parse error
ReportExecutionException	Exception during a report generation
RetryException	Base class for exception types which indicates that clients should retry the current operation
StaleEntityException	Exception thrown on attempts to save an entity which has been modified by another user / thread
StoredFileException	Exception thrown when trying to retrieve/store files from/to the file storage.
UnexpectedDataAccessException	Represents an unknown exception on the data access (database or content storage)
UserStatusException	Exception thrown when attempting to locate a user with an invalid status
ValidationException	An exception thrown when an invalid object was found