DumpIntf (bw-calendar-engine-api 3.12.5 API)

```
public interface DumpIntf
```
Interface which defines the database functions needed to dump the calendar data. It is intended that the implementation might cache objects. Calling each method in the order below should be the most efficient.
These methods return dummy objects for references. For example, an event location is represented by a Location object with only the id filled in.
If the implementing class discovers a discrepency, e.g. a missing user entry, it is up to the caller to determine that is the case.
Error messages should be emitted by the implementing classes.
Classes to dump in the order they must appear are
- BwSystem
- BwUser
- BwCalendar
- BwLocation
- BwSponsor
- BwOrganizer
- BwAttendee
- BwCategory
- BwAuthUser
- BwAuthUserPrefs
- BwEvent
- BwEventAnnotation
- BwAdminGroup
- BwPreferences + BwView
- BwCalSuite
- BwFilter
- BwUserInfo
Version:

1.0

Author:

Mike Douglass douglm rpi.edu

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`endPrincipal(BwPrincipal val)` End dumping of the given principal - used by the file dump
`Iterator<BwAdminGroup>`	`getAdminGroups()` Will return an Iterator returning AdminGroup objects.
`Iterator<BwPrincipal>`	`getAllPrincipals()` Will return an Iterator returning principal objects.
`Iterator<BwAuthUser>`	`getAuthUsers()` Will return an Iterator returning AuthUser objects.
`Iterator<BwCalendar>`	`getCalendars()` Will return an Iterator returning the top level BwCalendar objects.
`Iterator<BwCalSuite>`	`getCalSuites()` Will return an Iterator returning BwCalSuite objects.
`Iterator<BwCategory>`	`getCategories()` Will return an Iterator returning Category objects.
`Collection<BwCalendar>`	`getChildren(BwCalendar val)`
`Iterator<BwContact>`	`getContacts()` Will return an Iterator returning BwContact objects.
`Iterator<BwEventAnnotation>`	`getEventAnnotations()` Will return an Iterator returning BwEvent objects.
`Iterator<String>`	`getEventHrefs(int start)` Will return an Iterator over event hrefs.
`Iterable<EventInfo>`	`getEventInfos(String colPath)` Will return an Iterable object returning EventInfo objects.
`Iterator<BwEvent>`	`getEvents()` Will return an Iterator returning BwEvent objects.
`Iterator<BwFilterDef>`	`getFilters()` Will return an Iterator returning Filter objects.
`Iterator<BwLocation>`	`getLocations()` Will return an Iterator returning Location objects.
`Iterator<BwPreferences>`	`getPreferences()` Will return an Iterator returning BwPreferences objects.
`void`	`getResourceContent(BwResource res)` Will return the resource content for the given resource.
`Iterator<BwResource>`	`getResources()` Will return an Iterator returning User resources.
`Iterator`	`getViews()` Will return an Iterator returning view objects.
`void`	`startPrincipal(BwPrincipal val)` Prepare for dumping of the given principal - used by the file dump

- Method Detail
  - getAdminGroups
```
Iterator<BwAdminGroup> getAdminGroups()
                               throws CalFacadeException
```
    Will return an Iterator returning AdminGroup objects.
    
    Returns:
    
    Iterator over entities
    
    Throws:
    
    CalFacadeException - on error
  - getAuthUsers
```
Iterator<BwAuthUser> getAuthUsers()
                           throws CalFacadeException
```
    Will return an Iterator returning AuthUser objects. Preferences will be attached - user objects will also be attached.
    
    Returns:
    
    Iterator over entities
    
    Throws:
    
    CalFacadeException - on error
  - getCalendars
```
Iterator<BwCalendar> getCalendars()
                           throws CalFacadeException
```
    Will return an Iterator returning the top level BwCalendar objects.
    
    Returns:
    
    Iterator over entities
    
    Throws:
    
    CalFacadeException - on error
  - getChildren
```
Collection<BwCalendar> getChildren(BwCalendar val)
                            throws CalFacadeException
```
    Parameters:
    
    val - - the collection
    
    Returns:
    
    Children of val
    
    Throws:
    
    CalFacadeException - on error
  - getCalSuites
```
Iterator<BwCalSuite> getCalSuites()
                           throws CalFacadeException
```
    Will return an Iterator returning BwCalSuite objects.
    
    Returns:
    
    Iterator over entities
    
    Throws:
    
    CalFacadeException - on error
  - getCategories
```
Iterator<BwCategory> getCategories()
                            throws CalFacadeException
```
    Will return an Iterator returning Category objects.
    
    Returns:
    
    Iterator over entities
    
    Throws:
    
    CalFacadeException - on error
  - getEvents
```
Iterator<BwEvent> getEvents()
                     throws CalFacadeException
```
    Will return an Iterator returning BwEvent objects. All relevent objects, categories, locations, sponsors, creators will be attached.
    
    Returns:
    
    Iterator - events may have overrides attached.
    
    Throws:
    
    CalFacadeException - on error
  - getEventInfos
```
Iterable<EventInfo> getEventInfos(String colPath)
                           throws CalFacadeException
```
    Will return an Iterable object returning EventInfo objects. All relevent objects, categories, locations, sponsors, creators will be attached.
    
    Parameters:
    
    colPath - for events
    
    Returns:
    
    Iterable - events may have overrides attached.
    
    Throws:
    
    CalFacadeException - on error
  - getEventHrefs
```
Iterator<String> getEventHrefs(int start)
                        throws CalFacadeException
```
    Will return an Iterator over event hrefs.
    
    Parameters:
    
    start - - position.
    
    Returns:
    
    Iterator over hrefs.
    
    Throws:
    
    CalFacadeException - on error
  - getEventAnnotations
```
Iterator<BwEventAnnotation> getEventAnnotations()
                                         throws CalFacadeException
```
    Will return an Iterator returning BwEvent objects. All relevent objects, categories, locations, sponsors, creators will be attached.
    Overrides are not included
    
    Returns:
    
    Iterator over entities
    
    Throws:
    
    CalFacadeException - on error
  - getFilters
```
Iterator<BwFilterDef> getFilters()
                          throws CalFacadeException
```
    Will return an Iterator returning Filter objects.
    
    Returns:
    
    Iterator over entities
    
    Throws:
    
    CalFacadeException - on error
  - getLocations
```
Iterator<BwLocation> getLocations()
                           throws CalFacadeException
```
    Will return an Iterator returning Location objects.
    
    Returns:
    
    Iterator over entities
    
    Throws:
    
    CalFacadeException - on error
  - getPreferences
```
Iterator<BwPreferences> getPreferences()
                                throws CalFacadeException
```
    Will return an Iterator returning BwPreferences objects.
    
    Returns:
    
    Iterator over entities
    
    Throws:
    
    CalFacadeException - on error
  - getContacts
```
Iterator<BwContact> getContacts()
                         throws CalFacadeException
```
    Will return an Iterator returning BwContact objects.
    
    Returns:
    
    Iterator over entities
    
    Throws:
    
    CalFacadeException - on error
  - getAllPrincipals
```
Iterator<BwPrincipal> getAllPrincipals()
                                throws CalFacadeException
```
    Will return an Iterator returning principal objects. Subscriptions will be included
    
    Returns:
    
    Iterator over entities
    
    Throws:
    
    CalFacadeException - on error
  - getResources
```
Iterator<BwResource> getResources()
                           throws CalFacadeException
```
    Will return an Iterator returning User resources.
    
    Returns:
    
    Iterator over entities
    
    Throws:
    
    CalFacadeException - on error
  - getResourceContent
```
void getResourceContent(BwResource res)
                 throws CalFacadeException
```
    Will return the resource content for the given resource.
    
    Parameters:
    
    res - on return resource content object will be implanted
    
    Throws:
    
    CalFacadeException - on error
  - getViews
```
Iterator getViews()
           throws CalFacadeException
```
    Will return an Iterator returning view objects.
    
    Returns:
    
    Iterator over entities
    
    Throws:
    
    CalFacadeException - on error
  - startPrincipal
```
void startPrincipal(BwPrincipal val)
             throws CalFacadeException
```
    Prepare for dumping of the given principal - used by the file dump
    
    Parameters:
    
    val - the principal
    
    Throws:
    
    CalFacadeException - on error
  - endPrincipal
```
void endPrincipal(BwPrincipal val)
           throws CalFacadeException
```
    End dumping of the given principal - used by the file dump
    
    Parameters:
    
    val - the principal
    
    Throws:
    
    CalFacadeException - on error

Interface DumpIntf

Method Summary

Method Detail

getAdminGroups

getAuthUsers

getCalendars

getChildren

getCalSuites

getCategories

getEvents

getEventInfos

getEventHrefs

getEventAnnotations

getFilters

getLocations

getPreferences

getContacts

getAllPrincipals

getResources

getResourceContent

getViews

startPrincipal

endPrincipal