org.bedework.calsvci

Interface Locations

All Superinterfaces:

EventProperties<BwLocation>, Serializable

public interface Locations
extends EventProperties<BwLocation>

Interface which handles manipulation of location entities.

These are maintained in the database but completely cached by the indexer and in memory. There are methods to retrieve only the cached objects for the many cases where speed is important.

Author:

Mike Douglass douglm - rpi.edu

Nested Class Summary

Nested classes/interfaces inherited from interface org.bedework.calsvci.EventProperties

EventProperties.EnsureEntityExistsResult<T>

Method Summary

Modifier and Type	Method and Description
GetEntityResponse<BwLocation>	fetchLocationByKey(String keyName, String keyVal) Uses named keys to locate the location.
void	init(boolean adminCanEditAllPublic) Initialize the object

Methods inherited from interface org.bedework.calsvci.EventProperties

add, delete, ensureExists, find, find, findPersistent, get, get, getByUid, getByUids, getEditable, getPersistent, getPublic, getRefs, init, reindex, update

Method Detail

init

void init(boolean adminCanEditAllPublic)

Initialize the object

Parameters:

adminCanEditAllPublic - True if administrators can edit all public entities

fetchLocationByKey

GetEntityResponse<BwLocation> fetchLocationByKey(String keyName,
                                                 String keyVal)

Uses named keys to locate the location. These are used to map a String location value onto a location entity. This allows us to map locations in e.g. an OrgSync event onto better specified bedework entities.

Parameters:

keyName - name of key

keyVal - the value

Returns:

response with possible BwLocation object.