org.bedework.calsvci

Interface CalSuitesI

All Superinterfaces:

Serializable

public interface CalSuitesI
extends Serializable

Interface for handling bedework calendar suite objects.

Author:

Mike Douglass

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CalSuitesI.ResourceClass Define class of resource

Method Summary

Modifier and Type	Method and Description
BwCalSuiteWrapper	add(String name, String adminGroupName, String rootCollectionPath, String submissionsPath) Create a new calendar suite
void	addResource(BwCalSuite suite, BwResource res, CalSuitesI.ResourceClass cl) Add a resource.
void	delete(BwCalSuiteWrapper val) Delete a calendar suite object
void	deleteResource(BwCalSuite suite, String name, CalSuitesI.ResourceClass cl) Delete named resource
BwCalSuiteWrapper	get() Get the current calendar suite.
BwCalSuiteWrapper	get(BwAdminGroup group) Get a calendar suite given the 'owning' group
BwCalSuiteWrapper	get(String name) Get a calendar suite given the name
Collection<BwCalSuite>	getAll() Get calendar suites to which this user has access
BwResource	getResource(BwCalSuite suite, String name, CalSuitesI.ResourceClass cl) Get named resource.
List<BwResource>	getResources(BwCalSuite suite, CalSuitesI.ResourceClass cl) Get a list of resources.
String	getResourcesPath(BwCalSuite suite, CalSuitesI.ResourceClass cl) Get the path to the resources directory for the calsuite
void	set(BwCalSuiteWrapper val) Set the current calendar suite.
void	update(BwCalSuiteWrapper cs, String adminGroupName, String rootCollectionPath, String submissionsPath) Update a calendar suite.

Method Detail

add

BwCalSuiteWrapper add(String name,
                      String adminGroupName,
                      String rootCollectionPath,
                      String submissionsPath)
               throws CalFacadeException

Create a new calendar suite

Parameters:

name - of calsuite

adminGroupName - - name of the admin group

rootCollectionPath -

submissionsPath -

Returns:

BwCalSuiteWrapper for new object

Throws:

CalFacadeException

set

void set(BwCalSuiteWrapper val)
  throws CalFacadeException

Set the current calendar suite.

Parameters:

val - BwCalSuiteWrapper

Throws:

CalFacadeException

get

BwCalSuiteWrapper get()
               throws CalFacadeException

Get the current calendar suite.

Returns:

BwCalSuiteWrapper null for unknown calendar suite

Throws:

CalFacadeException

get

BwCalSuiteWrapper get(String name)
               throws CalFacadeException

Get a calendar suite given the name

Parameters:

name - String name of calendar suite

Returns:

BwCalSuiteWrapper null for unknown calendar suite

Throws:

CalFacadeException

get

BwCalSuiteWrapper get(BwAdminGroup group)
               throws CalFacadeException

Get a calendar suite given the 'owning' group

Parameters:

group - BwAdminGroup

Returns:

BwCalSuiteWrapper null for unknown calendar suite

Throws:

CalFacadeException

getAll

Collection<BwCalSuite> getAll()
                       throws CalFacadeException

Get calendar suites to which this user has access

Returns:

Collection of BwCalSuiteWrapper

Throws:

CalFacadeException

update

void update(BwCalSuiteWrapper cs,
            String adminGroupName,
            String rootCollectionPath,
            String submissionsPath)
     throws CalFacadeException

Update a calendar suite. Any of the parameters to be changed may be null or the current value to indicate no change.

Parameters:

cs - BwCalSuiteWrapper object

adminGroupName - - name of the admin group

rootCollectionPath -

submissionsPath -

Throws:

CalFacadeException

delete

void delete(BwCalSuiteWrapper val)
     throws CalFacadeException

Delete a calendar suite object

Parameters:

val - BwCalSuiteWrapper object

Throws:

CalFacadeException

getResourcesPath

String getResourcesPath(BwCalSuite suite,
                        CalSuitesI.ResourceClass cl)
                 throws CalFacadeException

Get the path to the resources directory for the calsuite

Parameters:

suite - - the suite

cl - - class of resource

Returns:

path

Throws:

CalFacadeException

getResources

List<BwResource> getResources(BwCalSuite suite,
                              CalSuitesI.ResourceClass cl)
                       throws CalFacadeException

Get a list of resources. The content is not fetched.

Parameters:

suite - - calendar suite

cl - - define class of resource

Returns:

list

Throws:

CalFacadeException

getResource

BwResource getResource(BwCalSuite suite,
                       String name,
                       CalSuitesI.ResourceClass cl)
                throws CalFacadeException

Get named resource. The content is fetched.

Parameters:

suite - - calendar suite

name - of resource

cl - - define class of resource

Returns:

resource or null

Throws:

CalFacadeException

addResource

void addResource(BwCalSuite suite,
                 BwResource res,
                 CalSuitesI.ResourceClass cl)
          throws CalFacadeException

Add a resource. The supplied object has all fields set except for the path. This will be determined by the cl parameter and set in the object.

The parent collection will be created if necessary.

Parameters:

suite - - calendar suite

res - to add

cl - - define class of resource

Throws:

CalFacadeException

deleteResource

void deleteResource(BwCalSuite suite,
                    String name,
                    CalSuitesI.ResourceClass cl)
             throws CalFacadeException

Delete named resource

Parameters:

suite - - calendar suite

name - of resource

cl - - define class of resource

Throws:

CalFacadeException