Introduction
The category service allows retrieval of categories by href or searching based on strings and filters.
Retrieve a category
Search for a category with a string
This documentation is mostly a place-holder.
1. annotations
Provides annotations for the common classes (mostly icalendar and database related).
1.1. Using this project
Add the artifact(s) as a dependency to your project:
<dependency>
<groupId>org.bedework</groupId>
<artifactId>bw-calendar-annotations</artifactId>
</dependency>2. api
Provides definitions for the r/w api for the calendar engine. This SHOULD NOT be treated as a public api as it is somewhat volatile. === Using this project Add the artifact(s) as a dependency to your project:
<dependency>
<groupId>org.bedework</groupId>
<artifactId>bw-calendar-api</artifactId>
</dependency>3. api-ro
Provides definitions for the read-only api for the calendar engine. This SHOULD NOT be treated as a public api as it is somewhat volatile.
Note that the split between read/write and read-only is incomplete. The intent is ultimately to have a deployable read-only calendar engine with no classes that update data.
This would provide greater security for the public read-only web services as well as a smaller footprint. === Using this project Add the artifact(s) as a dependency to your project:
<dependency>
<groupId>org.bedework</groupId>
<artifactId>bw-calendar-api-ro</artifactId>
</dependency>4. config
Provides definitions for the configuration for the calendar engine. === Using this project Add the artifact(s) as a dependency to your project:
<dependency>
<groupId>org.bedework</groupId>
<artifactId>bw-calendar-config</artifactId>
</dependency>5. convert
Provides definitions for the conversion code for the calendar engine.
Mostly code to convert from the internal format to external formats and vice versa. === Using this project Add the artifact(s) as a dependency to your project:
<dependency>
<groupId>org.bedework</groupId>
<artifactId>bw-calendar-convert</artifactId>
</dependency>6. facade
Provides classes for the apis) for the calendar engine.
The origins of this are based on what is described here, though it predates wikipedia.
This is closer to a public api. It could do with refactoring into read-only, read-write and admin. === Using this project Add the artifact(s) as a dependency to your project:
<dependency>
<groupId>org.bedework</groupId>
<artifactId>bw-calendar-convert</artifactId>
</dependency>7. mail
Provides definitions for the email code for the calendar engine.
7.1. Using this project
Add the artifact(s) as a dependency to your project:
<dependency>
<groupId>org.bedework</groupId>
<artifactId>bw-calendar-mail</artifactId>
</dependency>8. sysevents-common
Provides definitions for the internal system events generated and consumed by the calendar engine.
8.1. Using this project
Add the artifact(s) as a dependency to your project:
<dependency>
<groupId>org.bedework</groupId>
<artifactId>bw-calendar-sysevents-common</artifactId>
</dependency>9. sysevents-msgs
Provides definitions for the internal system event messages generated and consumed by the calendar engine.
9.1. Using this project
Add the artifact(s) as a dependency to your project:
<dependency>
<groupId>org.bedework</groupId>
<artifactId>bw-calendar-sysevents-msgs</artifactId>
</dependency>