org.bedework.calsvci

Interface FiltersI

All Superinterfaces:

Serializable

public interface FiltersI
extends Serializable

Interface for handling bedework filters.

A filter can be regarded as an extension of CalDAV filters and a subset of bedework filters is indeed equivalent to those defined in the CalDAV rfc.

We can define a filter by creating an xml definition and having the create filter method parse that definition and create a filter.

We can save the xml definition and also retrieve it and create the internal form.

Author:

Mike Douglass

Method Summary

Modifier and Type	Method and Description
void	delete(String name) Delete a filter given the name
GetFilterDefResponse	get(String name) Get a filter given the name
Collection<BwFilterDef>	getAll() Get filter definitions to which this user has access
SimpleFilterParser.ParseResult	parse(BwFilterDef val) Parse the xml definition in the given filter object
SimpleFilterParser.ParseResult	parseSort(String val) Parse the sort expression
int	reindex(BwIndexer indexer) Reindex current users entities
void	save(BwFilterDef val) Validate and persist a new filter definition
void	update(BwFilterDef val) Update a filter definition.
void	validate(String val) Validate a filter definition.

Method Detail

parse

SimpleFilterParser.ParseResult parse(BwFilterDef val)

Parse the xml definition in the given filter object

Parameters:

val - BwFilterDef

Returns:

result of parsing - check the ok flag.

validate

void validate(String val)
       throws CalFacadeException

Validate a filter definition.

Parameters:

val - String xml filter definition

Throws:

CalFacadeException

save

void save(BwFilterDef val)
   throws CalFacadeException

Validate and persist a new filter definition

Parameters:

val - filter definition

Throws:

CalFacadeException - for errrors including duplicate name

get

GetFilterDefResponse get(String name)

Get a filter given the name

Parameters:

name - String internal name of filter

Returns:

GetFilterDefResponse with status set

getAll

Collection<BwFilterDef> getAll()
                        throws CalFacadeException

Get filter definitions to which this user has access

Returns:

Collection of BwCalSuiteWrapper

Throws:

CalFacadeException

update

void update(BwFilterDef val)
     throws CalFacadeException

Update a filter definition.

Parameters:

val - filter definition

Throws:

CalFacadeException - for errors including duplicate name

delete

void delete(String name)
     throws CalFacadeException

Delete a filter given the name

Parameters:

name - String name of filter

Throws:

CalFacadeException

parseSort

SimpleFilterParser.ParseResult parseSort(String val)

Parse the sort expression

Parameters:

val - String sort expression

Returns:

result - check the status

reindex

int reindex(BwIndexer indexer)
     throws CalFacadeException

Reindex current users entities

Parameters:

indexer - to use for this operation

Returns:

number of entities reindexed

Throws:

CalFacadeException - on fatal error