T - type of property, Location, Sponsor etc.public interface EventProperties<T extends BwEventProperty> extends Serializable
Each has a single field which together with the owner makes a unique key and all operations on those classes are the same.
| Modifier and Type | Interface and Description |
|---|---|
static class |
EventProperties.EnsureEntityExistsResult<T>
Returned to show if an entity was added.
|
| 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.
|
void init(String className, boolean adminCanEditAllPublic)
className - Class of entityadminCanEditAllPublic - True if administrators can edit all public entitiesCollection<T> getPublic() throws CalFacadeException
Returns an empty collection for none.
The returned objects will not be persistent objects.
CalFacadeException - on fatal errorCollection<T> getEditable() throws CalFacadeException
Returns an empty collection for none.
The returned objects may not be persistent objects but the result of a report query.
CalFacadeException - on fatal errorT getByUid(String uid) throws CalFacadeException
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.
uid - String uidCalFacadeException - on fatal errorT get(String href) throws CalFacadeException
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.
href - String hrefCalFacadeException - on fatal errorCollection<T> get() throws CalFacadeException
Returns an empty collection for none.
The returned objects may not be persistent objects but the result of a report query.
CalFacadeException - on fatal errorT getPersistent(String uid) throws CalFacadeException
uid - String uidCalFacadeException - on fatal errorCollection<T> getByUids(Collection<String> uids) throws CalFacadeException
These entities will not be live versions - but detached copies which may be out of date. The cache entries will be refreshed fairly frequently.
uids - Collection of String uidsCalFacadeException - on fatal errorT findPersistent(BwString val) throws CalFacadeException
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.
val - BwString valueCalFacadeException - on fatal errorT find(BwString val) throws CalFacadeException
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.
val - BwString valueCalFacadeException - on fatal errorGetEntitiesResponse<T> find(String fexpr, int from, int size)
fexpr - filter expression - will be restriced to typeboolean add(T val) throws CalFacadeException
val - BwEventProperty object to be addedCalFacadeException - on fatal errorvoid update(T val) throws CalFacadeException
val - BwEventProperty object to be updatedCalFacadeException - on fatal errorint delete(T val) throws CalFacadeException
val - BwEventProperty object to be deletedCalFacadeException - on fatal errorCollection<EventPropertiesReference> getRefs(T val) throws CalFacadeException
val - an entityCalFacadeException - on faltal errorEventProperties.EnsureEntityExistsResult<T> ensureExists(T val, String ownerHref) throws CalFacadeException
val - T object. If this object has the id set,
we assume the check was made previously.ownerHref - String principal href, null for current userCalFacadeException - on fatal errorint reindex(BwIndexer indexer) throws CalFacadeException
indexer - to use for this operationCalFacadeException - on fatal errorCopyright © 2019 Bedework. All rights reserved.