org.sakaiproject.coursemanagement.api

Interface CourseSitePublishService

public interface CourseSitePublishService

sakai service for publishing course sites a set number of days before a term begins.

example:
fall term, 2008: starts August 20th, 2008 let's say that some course sites, including bio 201, are created for the fall term 2008. assume that we want the course sites to be published two weeks before the fall term starts. thus, we want the sakai site for bio 201 to be published on August 20th - 14 days = August 6th, 2008.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERMISSION_COURSE_SITE_PUBLISH
static String	SITE_PROPERTY_COURSE_SITE_PUBLISHED

Method Summary

Modifier and Type	Method and Description
int	publishCourseSites(int numDaysBeforeTermStarts) publishes course sites whose terms are about to begin.

Field Detail

PERMISSION_COURSE_SITE_PUBLISH

static final String PERMISSION_COURSE_SITE_PUBLISH

See Also:

Constant Field Values

SITE_PROPERTY_COURSE_SITE_PUBLISHED

static final String SITE_PROPERTY_COURSE_SITE_PUBLISHED

See Also:

Constant Field Values

Method Detail

publishCourseSites

int publishCourseSites(int numDaysBeforeTermStarts)

publishes course sites whose terms are about to begin. Before a term begins, existing, unpublished course sites are published so that they are then available to the students enrolled in the courses. The courses will be published a number of days before the start of the term, whose value is specified by the course_site_publish_service.num_days_before_term_starts sakai property.

Parameters:

numDaysBeforeTermStarts - number of days before a term starts that course sites should be published.

Returns:

the number of course sites that were published.