org.bedework.calsvci

Interface AdminI

All Superinterfaces:

Serializable

public interface AdminI
extends Serializable

Methods defined here are for adminisitrative uses. They require superuser access and support functions that involve crawling the system or usage reporting.

Author:

Mike Douglass

Method Summary

Modifier and Type	Method and Description
Collection<String>	getChildCollections(String parentPath, int start, int count) Obtain the next batch of children paths for the supplied path.
Collection<String>	getChildEntities(String parentPath, int start, int count) Obtain the next batch of children names for the supplied path.
Collection<BwEvent>	getEventsByAlarm(BwAlarm alarm) Given an alarm return the associated event(s)
Collection<BwAlarm>	getUnexpiredAlarms(long triggerTime) Return all unexpired alarms before a given time.

Method Detail

getChildCollections

Collection<String> getChildCollections(String parentPath,
                                       int start,
                                       int count)
                                throws CalFacadeException

Obtain the next batch of children paths for the supplied path. A path of null will return the system roots.

Parameters:

parentPath -

start - start index in the batch - 0 for the first

count - count of results we want

Returns:

collection of String paths or null for no more

Throws:

CalFacadeException

getChildEntities

Collection<String> getChildEntities(String parentPath,
                                    int start,
                                    int count)
                             throws CalFacadeException

Obtain the next batch of children names for the supplied path. A path of null will return the system roots. These are the names of stored entities, NOT the paths.

Parameters:

parentPath -

start - start index in the batch - 0 for the first

count - count of results we want

Returns:

collection of String names or null for no more

Throws:

CalFacadeException

getUnexpiredAlarms

Collection<BwAlarm> getUnexpiredAlarms(long triggerTime)
                                throws CalFacadeException

Return all unexpired alarms before a given time. If time is 0 all unexpired alarms will be retrieved.

Any cancelled alarms will be excluded from the result.

Typically the system will call this with a time set into the near future and then queue up alarms that are near to triggering.

Parameters:

triggerTime -

Returns:

Collection of unexpired alarms.

Throws:

CalFacadeException

getEventsByAlarm

Collection<BwEvent> getEventsByAlarm(BwAlarm alarm)
                              throws CalFacadeException

Given an alarm return the associated event(s)

Parameters:

alarm -

Returns:

an event.

Throws:

CalFacadeException