org.sakaiproject.coursemanagement.api

Interface CourseSiteRemovalService

public interface CourseSiteRemovalService

sakai service for removing\\unpublishing course sites whose terms have ended.

example:
fall term, 2008: starts August 22nd, 2008 ends December 15th, 2008 let's say that a site is created for bio 201 for the fall term 2008. assume that we want the course site to be removed, since it will no longer be needed, two weeks after the term ends. thus, we want the sakai site for bio 201 to be removed on December 15th + 14 days = December 29th, 2008. if this service is invoked on any day after December 29th, 2008, the course will be removed or unpublished, depending on how the service is configured in sakai.properties.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CourseSiteRemovalService.Action

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERMISSION_COURSE_SITE_REMOVAL
static String	SITE_PROPERTY_COURSE_SITE_REMOVAL

Method Summary

Modifier and Type	Method and Description
int	removeCourseSites(CourseSiteRemovalService.Action action, int numDaysAfterTermEnds) removes\\unpublishes course sites whose terms have ended and a specified number of days have passed.

Field Detail

PERMISSION_COURSE_SITE_REMOVAL

static final String PERMISSION_COURSE_SITE_REMOVAL

See Also:

Constant Field Values

SITE_PROPERTY_COURSE_SITE_REMOVAL

static final String SITE_PROPERTY_COURSE_SITE_REMOVAL

See Also:

Constant Field Values

Method Detail

removeCourseSites

int removeCourseSites(CourseSiteRemovalService.Action action,
                      int numDaysAfterTermEnds)

removes\\unpublishes course sites whose terms have ended and a specified number of days have passed. Once a term has ended, the course sites for that term remain available for a specified number of days, whose duration is specified in sakai.properties via the course_site_removal_service.num_days_after_term_ends property. After the specified period has elapsed, this invoking this service will either remove or unpublish the course site, depending on the value of the course_site_removal_service.action sakai property.

Parameters:

action - whether to delete the course site or to simply unpublish it.

numDaysAfterTermEnds - number of days after a term ends when course sites expire.

Returns:

the number of course sites that were removed\\unpublished.