org.bedework.calsvci

Interface ViewsI

All Superinterfaces:

Serializable

public interface ViewsI
extends Serializable

Interface for handling bedework view objects.

Author:

Mike Douglass

Method Summary

Modifier and Type	Method and Description
boolean	add(BwView val, boolean makeDefault) Add a view.
boolean	addCollection(String name, String path) Add a collection path to the named view.
BwView	find(String val) Find the named view.
Collection<BwView>	getAll() Return the collection of views - named collections of collections
Collection<BwView>	getAll(BwPrincipal pr) Return the collection of views - named collections of collections
boolean	remove(BwView val) Remove the view for the owner of the object.
boolean	removeCollection(String name, String path) Remove a collection path from the named view.

Method Detail

add

boolean add(BwView val,
            boolean makeDefault)
     throws CalFacadeException

Add a view.

Parameters:

val - BwView to add

makeDefault - boolean true for make this the default.

Returns:

boolean false view not added, true - added.

Throws:

CalFacadeException

remove

boolean remove(BwView val)
        throws CalFacadeException

Remove the view for the owner of the object.

Parameters:

val - BwView

Returns:

boolean false - view not found.

Throws:

CalFacadeException

find

BwView find(String val)
     throws CalFacadeException

Find the named view.

Parameters:

val - String view name - null means default

Returns:

BwView null view not found.

Throws:

CalFacadeException

addCollection

boolean addCollection(String name,
                      String path)
               throws CalFacadeException

Add a collection path to the named view.

Parameters:

name - String view name - null means default

path - collection path to add

Returns:

boolean false view not found, true - collection path added.

Throws:

CalFacadeException

removeCollection

boolean removeCollection(String name,
                         String path)
                  throws CalFacadeException

Remove a collection path from the named view.

Parameters:

name - String view name - null means default

path - collection path to remove

Returns:

boolean false view not found, true - collection path removed.

Throws:

CalFacadeException

getAll

Collection<BwView> getAll()
                   throws CalFacadeException

Return the collection of views - named collections of collections

Returns:

collection of views

Throws:

CalFacadeException

getAll

Collection<BwView> getAll(BwPrincipal pr)
                   throws CalFacadeException

Return the collection of views - named collections of collections

Parameters:

pr -

Returns:

collection of views

Throws:

CalFacadeException