org.bedework.calsvci

Interface EventProperties<T extends BwEventProperty>

Type Parameters:

T - type of property, Location, Sponsor etc.

All Superinterfaces:

Serializable

All Known Subinterfaces:

Categories, Contacts, Locations

public interface EventProperties<T extends BwEventProperty>
extends Serializable

Interface which handles manipulation of BwEventProperty subclasses which are treated in the same manner, these being Category, Location and Contact.

Each has a single field which together with the owner makes a unique key and all operations on those classes are the same.

Author:

Mike Douglass douglm - rpi.edu

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EventProperties.EnsureEntityExistsResult<T> Returned to show if an entity was added.

Method Summary

Modifier and Type	Method and Description
boolean	add(T val) Add an entity to the database.
int	delete(T val) Delete an entity
EventProperties.EnsureEntityExistsResult<T>	ensureExists(T val, String ownerHref) Ensure an entity exists.
T	find(BwString val) Return an entity matching the given BwString to which the user has access.
GetEntitiesResponse<T>	find(String fexpr, int from, int size) Return all entities matching the given filter expression to which the user has access.
T	findPersistent(BwString val) Return one or more entities matching the given BwString and owned by the current principal.
Collection<T>	get() Return all current user entities.
T	get(String href) Return a non-persistent version of the entity given the uid - if the user has access
T	getByUid(String uid) Return a cached version of the entity given the uid - if the user has access
Collection<T>	getByUids(Collection<String> uids) Return cached versions of the entity given the uids - if the user has access
Collection<T>	getEditable() Return all entities satisfying the conditions and to which the current user has edit access.
T	getPersistent(String uid) Return an entity given the uid if the user has access
Collection<T>	getPublic() Return all public entities.
Collection<EventPropertiesReference>	getRefs(T val) Return references to the entity
void	init(String className, boolean adminCanEditAllPublic) Initialise the object
int	reindex(BwIndexer indexer) Reindex current users entities
void	update(T val) Update an entity in the database.

Method Detail

init

void init(String className,
          boolean adminCanEditAllPublic)

Initialise the object

Parameters:

className - Class of entity

adminCanEditAllPublic - True if administrators can edit all public entities

getPublic

Collection<T> getPublic()
                 throws CalFacadeException

Return all public entities.

Returns an empty collection for none.

The returned objects will not be persistent objects.

Returns:

Collection of objects

Throws:

CalFacadeException - on fatal error

getEditable

Collection<T> getEditable()
                   throws CalFacadeException

Return all entities satisfying the conditions and to which the current user has edit access.

Returns an empty collection for none.

The returned objects may not be persistent objects but the result of a report query.

Returns:

Collection of objects

Throws:

CalFacadeException - on fatal error

getByUid

T getByUid(String uid)
    throws CalFacadeException

Return a cached version of the entity given the uid - if the user has access

This entity will not be a live version - it is a detached copy which may be out of date. The cache entries will be refreshed fairly frequently.

Parameters:

uid - String uid

Returns:

BwEventProperty object representing the entity in question null if it doesn't exist.

Throws:

CalFacadeException - on fatal error

get

T get(String href)
throws CalFacadeException

Return a non-persistent version of the entity given the uid - if the user has access

This entity will not be a live version - it is a detached copy which may be out of date. The cache entries will be refreshed fairly frequently.

Parameters:

href - String href

Returns:

BwEventProperty object representing the entity in question null if it doesn't exist.

Throws:

CalFacadeException - on fatal error

get

Collection<T> get()
           throws CalFacadeException

Return all current user entities.

Returns an empty collection for none.

The returned objects may not be persistent objects but the result of a report query.

Returns:

Collection of objects

Throws:

CalFacadeException - on fatal error

getPersistent

T getPersistent(String uid)
         throws CalFacadeException

Return an entity given the uid if the user has access

Parameters:

uid - String uid

Returns:

BwEventProperty object representing the entity in question null if it doesn't exist.

Throws:

CalFacadeException - on fatal error

getByUids

Collection<T> getByUids(Collection<String> uids)
                 throws CalFacadeException

Return cached versions of the entity given the uids - if the user has access

These entities will not be live versions - but detached copies which may be out of date. The cache entries will be refreshed fairly frequently.

Parameters:

uids - Collection of String uids

Returns:

BwEventProperty objects representing the entities in question never null.

Throws:

CalFacadeException - on fatal error

findPersistent

T findPersistent(BwString val)
          throws CalFacadeException

Return one or more entities matching the given BwString and owned by the current principal.

All event properties have string values which are used as the external representation in icalendar files. The combination of field and owner should be unique. The field value may change over time while the uid does not.

Parameters:

val - BwString value

Returns:

matching BwEventProperty object

Throws:

CalFacadeException - on fatal error

find

T find(BwString val)
throws CalFacadeException

Return an entity matching the given BwString to which the user has access.

All event properties have string values which are used as the external representation in icalendar files. The field should be unique for the owner. The field value may change over time while the uid does not.

Parameters:

val - BwString value

Returns:

matching BwEventProperty object

Throws:

CalFacadeException - on fatal error

find

GetEntitiesResponse<T> find(String fexpr,
                            int from,
                            int size)

Return all entities matching the given filter expression to which the user has access.

Parameters:

fexpr - filter expression - will be restriced to type

Returns:

matching BwEventProperty objects and status

add

boolean add(T val)
     throws CalFacadeException

Add an entity to the database. The id will be set in the parameter object.

Parameters:

val - BwEventProperty object to be added

Returns:

boolean true for added, false for already exists

Throws:

CalFacadeException - on fatal error

update

void update(T val)
     throws CalFacadeException

Update an entity in the database.

Parameters:

val - BwEventProperty object to be updated

Throws:

CalFacadeException - on fatal error

delete

int delete(T val)
    throws CalFacadeException

Delete an entity

Parameters:

val - BwEventProperty object to be deleted

Returns:

int 0 if it was deleted. 1 if it didn't exist 2 if in use

Throws:

CalFacadeException - on fatal error

getRefs

Collection<EventPropertiesReference> getRefs(T val)
                                      throws CalFacadeException

Return references to the entity

Parameters:

val - an entity

Returns:

a collection of references.

Throws:

CalFacadeException - on faltal error

ensureExists

EventProperties.EnsureEntityExistsResult<T> ensureExists(T val,
                                                         String ownerHref)
                                                  throws CalFacadeException

Ensure an entity exists. If it already does returns the object. If not creates the entity.

Parameters:

val - T object. If this object has the id set, we assume the check was made previously.

ownerHref - String principal href, null for current user

Returns:

EnsureEntityExistsResult with entity set to actual object.

Throws:

CalFacadeException - on fatal error

reindex

int reindex(BwIndexer indexer)
     throws CalFacadeException

Reindex current users entities

Parameters:

indexer - to use for this operation

Returns:

number of entities reindexed

Throws:

CalFacadeException - on fatal error