blackboard.data.course
Class Course

java.lang.Object
  blackboard.data.BbObject
      blackboard.data.course.Course

All Implemented Interfaces:

Available, IBbObject, java.lang.Cloneable

Direct Known Subclasses:

Organization

public class Course
extends BbObject
implements Available

The Course class provides a representation of a course (course or organization) within the Blackboard application.

Since:

Bb 5.5

Version:

$Revision: #1 $ $Date: 2005/06/27 $

Nested Class Summary

static class	Course.Duration Specifies the intended length of the course.
static class	Course.Enrollment
static class	Course.NavStyle Defines the navigation style for this course.
static class	Course.Pace Defines the intended educational pace set for this course.
static class	Course.ServiceLevel

Field Summary

static DataType	COURSE_DATA_TYPE Deprecated. Use the constant DATA_TYPE instead
static DataType	DATA_TYPE Object data type constant used in brokering loaders and persisters

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

Course()
Creates an instance of Course with default property values.

Method Summary

static ListFilter	createAvailabilityFilter(boolean targetAvailability) Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon course "availability".
static ListFilter	createDurationFilter(java.util.Date availDate, BbList membershipList) Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon the course duration availability.
static ListFilter	createMembershipRoleFilter(BbList membershipList, CourseMembership.Role targetRole) Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon the role of a user within those courses.
static ListFilter	createMembershipRoleFilter(BbList membershipList, CourseMembership.Role targetRole, boolean bIsAvailable) Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon the role of a user within those courses.
static ListFilter	createServiceLevelFilter(Course.ServiceLevel targetServiceLevel) Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon course service level (as returned by getServiceLevelType()).
long	getAbsoluteLimit() Returns the absolute storage limit for this Course.
boolean	getAllowEmailEnrollRequests() Deprecated.
boolean	getAllowGuests() Returns the allow guests flag for this Course.
boolean	getAllowObservers() Returns the allow observers flag for this Course.
BbFile	getBannerImageFile() Returns the banner image file associated with this Course.
java.lang.String	getBatchUid() Returns the batch uid associated with this Course.
ButtonStyle	getButtonStyle() Returns the ButtonStyle associated with this Course.
Id	getButtonStyleId() Returns the button style Id associated with this Course.
Cartridge	getCartridge() Returns the Cartridge associated with this Course.
Id	getCartridgeId() Returns the cartridge Id associated with this Course.
Classification	getClassification() Returns the Classification associated with this Course.
Id	getClassificationId() Returns the classification Id associated with this Course.
java.lang.String	getCourseId() Returns the course Id (not pk) associated with this Course.
Id	getDataSourceId() Returns the data source Id associated with this Course.
DataType	getDataType() Returns the DataType identifier for this object.
java.lang.String	getDescription() Returns the description associated with this Course.
Course.Duration	getDurationType() Returns the duration type for this Course.
java.util.Calendar	getEndDate() Returns the date on which this Course will/has end(ed).
java.lang.String	getEnrollmentAccessCode() Returns the enrollment access code associated with this Course.
java.util.Calendar	getEnrollmentEndDate() Returns the date on which enrollment in this Course ends.
java.util.Calendar	getEnrollmentStartDate() Returns the date on which enrollment in this Course starts.
Course.Enrollment	getEnrollmentType() Returns the enrollment type for this Course.
float	getFee() Returns the fee (cost) for this Course.
boolean	getHasDescriptionPage() Returns the has description page flag for this Course.
Id	getInstitutionId() Deprecated.
java.lang.String	getInstitutionName() Returns the institution name associated with this Course.
boolean	getIsAvailable() Returns the availability flag for this Course.
boolean	getIsLocaleEnforced() Returns the enforced locale flag for this Course.
boolean	getIsLockedOut() Returns the locked out flag for this Course.
boolean	getIsNavCollapsible() Returns the "is navigation collapsible" flag for this Course.
java.lang.String	getLocale() Returns the locale of this Course object.
java.lang.String	getNavColorBg() Returns the background color that is used for rendering the navigation links that appear on the left hand side of the course page.
java.lang.String	getNavColorFg() Returns the foreground color (color of text) that is used for rendering the navigation links that appear on the left hand side of the course page.
Course.NavStyle	getNavStyle() Returns the navigation style for this Course.
int	getNumDaysOfUse() Returns the number of days this Course can be used.
Course.Pace	getPaceType() Returns the pace type for this Course.
Registry	getRegistry() Returns the Registry associated with this Course.
boolean	getRequireAccountToEnroll() Deprecated.
Course.ServiceLevel	getServiceLevelType() Returns the service level type for this Course.
boolean	getShowEmailInSR() Deprecated.
boolean	getShowFirstNameInSR() Deprecated.
boolean	getShowInCatalog() Returns the show in catalog flag for this Course.
boolean	getShowLastNameInSR() Deprecated.
boolean	getShowPhone1InSR() Deprecated.
boolean	getShowStudentIdInSR() Deprecated.
long	getSoftLimit() Returns the soft storage limit for this Course.
java.util.Calendar	getStartDate() Returns the date on which this Course will/has start(ed).
Id	getTargetAudienceId() Deprecated.
java.lang.String	getTitle() Returns the title associated with this Course.
long	getUploadLimit() Returns the upload storage limit for this Course.
void	setAbsoluteLimit(long lAbsoluteLimit) Sets the absolute storage limit for this Course.
void	setAllowEmailEnrollRequests(boolean bAllowEmailEnrollRequests) Deprecated.
void	setAllowGuests(boolean bAllowGuests) Sets the allow guests flag for this Course.
void	setAllowObservers(boolean bAllowObservers) Sets the allow observers flag for this Course.
void	setBannerImageFile(BbFile bannerImageFile) Sets the banner image file associated with this Course.
void	setBatchUid(java.lang.String strBatchUid) Sets the batch uid associated with this Course.
void	setButtonStyle(ButtonStyle bstyle) Sets the ButtonStyle value for this Course.
void	setButtonStyleId(Id iButtonStyleId) Sets the button style Id value for this Course.
void	setCartridge(Cartridge cartridge) Sets the Cartridge value for this Course.
void	setCartridgeId(Id iCartridgeId) Sets the cartridge Id value for this Course.
void	setClassification(Classification classif) Sets Classification associated with this Course.
void	setClassificationId(Id iClassificationId) Sets the classification Id value for this Course.
void	setCourseId(java.lang.String strCourseId) Sets the course Id (not pk) associated with this Course.
void	setDataSourceId(Id iDataSourceId) Sets the data source Id value for this Course.
void	setDescription(java.lang.String strDescription) Sets the description associated with this Course.
void	setDurationType(Course.Duration eDurationType) Sets the duration type for this Course.
void	setEndDate(java.util.Calendar cEndDate) Sets the end date for this Course.
void	setEnrollmentAccessCode(java.lang.String strEnrollmentAccessCode) Sets the enrollment access code associated with this Course.
void	setEnrollmentEndDate(java.util.Calendar cEnrollmentEndDate) Sets the enrollment end date for this Course.
void	setEnrollmentStartDate(java.util.Calendar cEnrollmentStartDate) Sets the enrollment start date for this Course.
void	setEnrollmentType(Course.Enrollment eEnrollmentType) Sets the enrollment type for this Course.
void	setFee(float fFee) Sets the fee (cost) for this Course.
void	setHasDescriptionPage(boolean bHasDescriptionPage) Sets the has description page flag for this Course.
void	setInstitutionId(Id iInstitutionId) Deprecated.
void	setInstitutionName(java.lang.String strInstitutionName) Sets the institution name associated with this Course.
void	setIsAvailable(boolean bIsAvailable) Sets the availability flag for this Course.
void	setIsLocaleEnforced(boolean bIsEnforced) Sets the enforced locale flag for this Course.
void	setIsLockedOut(boolean bIsLockedOut) Sets the locked out flag for this Course.
void	setIsNavCollapsible(boolean bIsNavCollapsible) Sets the "is navigation collapsible" flag for this Course.
void	setLocale(java.lang.String strLocale) Sets the locale value for this Course object.
void	setNavColorBg(java.lang.String strNavColorBg) Sets the background color that should be used for rendering the navigation links that appear on the left hand side of the course page.
void	setNavColorFg(java.lang.String strNavColorFg) Sets the foreground color (color of text) that should be used for rendering the navigation links that appear on the left hand side of the course page.
void	setNavStyle(Course.NavStyle eNavStyle) Sets the navigation style for this Course.
void	setNumDaysOfUse(int nNumDaysOfUse) Sets the number of days of use for this Course.
void	setPaceType(Course.Pace ePaceType) Sets the pace type for this Course.
void	setRegistry(Registry reg) Sets the Registry associated with this Course.
void	setRequireAccountToEnroll(boolean bRequireAccountToEnroll) Deprecated.
void	setServiceLevelType(Course.ServiceLevel eServiceLevelType) Sets the service level type for this Course.
void	setShowEmailInSR(boolean bShowEmailInSR) Deprecated.
void	setShowFirstNameInSR(boolean bShowFirstNameInSR) Deprecated.
void	setShowInCatalog(boolean bShowInCatalog) Sets the show in catalog flag for this Course.
void	setShowLastNameInSR(boolean bShowLastNameInSR) Deprecated.
void	setShowPhone1InSR(boolean bShowPhone1InSR) Deprecated.
void	setShowStudentIdInSR(boolean bShowStudentIdInSR) Deprecated.
void	setSoftLimit(long lSoftLimit) Sets the soft storage limit for this Course.
void	setStartDate(java.util.Calendar cStartDate) Sets the start date for this Course.
void	setTargetAudienceId(Id iTargetAudienceId) Deprecated.
void	setTitle(java.lang.String strTitle) Sets the title associated with this Course.
void	setUploadLimit(long lUploadLimit) Sets the upload storage limit for this Course.
void	validate() Validates the contents of this Course.

Methods inherited from class blackboard.data.BbObject

clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, persist, setCreatedDate, setId, setModifiedDate, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DATA_TYPE

public static final DataType DATA_TYPE

Object data type constant used in brokering loaders and persisters

COURSE_DATA_TYPE

public static final DataType COURSE_DATA_TYPE

Deprecated. Use the constant DATA_TYPE instead

Constructor Detail

Course

public Course()

Creates an instance of Course with default property values.

Method Detail

getButtonStyleId

public Id getButtonStyleId()

Returns the button style Id associated with this Course.

Returns:

button style Id value for this Course

setButtonStyleId

public void setButtonStyleId(Id iButtonStyleId)

Sets the button style Id value for this Course.

Parameters:

iButtonStyleId - a button style Id value to use for this Course

getCartridgeId

public Id getCartridgeId()

Returns the cartridge Id associated with this Course.

Returns:

cartridge Id value for this Course

setCartridgeId

public void setCartridgeId(Id iCartridgeId)

Sets the cartridge Id value for this Course.

Parameters:

iCartridgeId - a cartridge Id value to use for this Course

getClassificationId

public Id getClassificationId()

Returns the classification Id associated with this Course.

Returns:

classification Id value for this Course

setClassificationId

public void setClassificationId(Id iClassificationId)

Sets the classification Id value for this Course.

Parameters:

iClassificationId - a classification Id value to use for this Course

getInstitutionId

public Id getInstitutionId()

Deprecated.

This field no longer exists as of Bb6 and should not be used.

setInstitutionId

public void setInstitutionId(Id iInstitutionId)

Deprecated.

This field no longer exists as of Bb6 and should not be used.

getTargetAudienceId

public Id getTargetAudienceId()

Deprecated.

This field no longer exists as of Bb6 and should not be used.

setTargetAudienceId

public void setTargetAudienceId(Id iTargetAudienceId)

Deprecated.

This field no longer exists as of Bb6 and should not be used.

getDataSourceId

public Id getDataSourceId()

Returns the data source Id associated with this Course.

Returns:

data source Id value for this Course

setDataSourceId

public void setDataSourceId(Id iDataSourceId)

Sets the data source Id value for this Course.

Parameters:

iDataSourceId - a data source Id value to use for this Course

getBatchUid

public java.lang.String getBatchUid()

Returns the batch uid associated with this Course. The batch uid value is used by the integration component to uniquely mark records for automatic updating/processing through the advanced integration process.

Returns:

the batch uid value of this Course as a String

setBatchUid

public void setBatchUid(java.lang.String strBatchUid)

Sets the batch uid associated with this Course. Setting this value is not necessary when creating a Course for persisting to the database since either the database persister or the database will set this value.

Parameters:

strBatchUid - a String containing the batch uid for this Course

getEnrollmentType

public Course.Enrollment getEnrollmentType()

Returns the enrollment type for this Course.

Returns:

a type value as defined in Course.Enrollment

See Also:

Course.Enrollment

setEnrollmentType

public void setEnrollmentType(Course.Enrollment eEnrollmentType)

Sets the enrollment type for this Course.

Parameters:

eEnrollmentType - a valid type value as defined in Course.Enrollment

See Also:

Course.Enrollment

getRequireAccountToEnroll

public boolean getRequireAccountToEnroll()

Deprecated.

This field no longer exists as of Bb6 and should not be used.

setRequireAccountToEnroll

public void setRequireAccountToEnroll(boolean bRequireAccountToEnroll)

Deprecated.

This field no longer exists as of Bb6 and should not be used.

getIsAvailable

public boolean getIsAvailable()

Returns the availability flag for this Course. If a course is marked as not available, no students can access it, but the instructor can still access the course.

Specified by:

getIsAvailable in interface Available

Returns:

a boolean denoted whether this Course is available

setIsAvailable

public void setIsAvailable(boolean bIsAvailable)

Sets the availability flag for this Course. If a course is marked as not available, no students can access it, but the instructor can still access the course.

Specified by:

setIsAvailable in interface Available

Parameters:

bIsAvailable - true if the course is to be made available, false otherwise.

getShowInCatalog

public boolean getShowInCatalog()

Returns the show in catalog flag for this Course. is a carry over from Bb.com and currently (5/25/00) has no effect in Bb5.

Returns:

a boolean denoting whether this Course is (should be) shown in the catalog

setShowInCatalog

public void setShowInCatalog(boolean bShowInCatalog)

Sets the show in catalog flag for this Course. is a carry over from Bb.com and currently (5/25/00) has no effect in Bb5.

Parameters:

bShowInCatalog - true if the course is to be (should be) shown in the catalog, false otherwise.

getHasDescriptionPage

public boolean getHasDescriptionPage()

Returns the has description page flag for this Course. flag is a carry over from Bb.com and currently (5/25/00) has no effect in Bb5.

Returns:

a boolean denoting whether this Course has a special HTML page in which it is described.

setHasDescriptionPage

public void setHasDescriptionPage(boolean bHasDescriptionPage)

Sets the has description page flag for this Course. is a carry over from Bb.com and currently (5/25/00) has no effect in Bb5.

Parameters:

bHasDescriptionPage - true if the course has a special description page, false otherwise.

getDurationType

public Course.Duration getDurationType()

Returns the duration type for this Course.

Returns:

a type value as defines in Course.Duration

See Also:

Course.Duration

setDurationType

public void setDurationType(Course.Duration eDurationType)

Sets the duration type for this Course.

Parameters:

eDurationType - a valid type value as defined in Course.Duration

See Also:

Course.Duration

getAllowEmailEnrollRequests

public boolean getAllowEmailEnrollRequests()

Deprecated.

As of Bb6, this property no longer exists as a separate field. Instead, the functionality was made part of the method getEnrollmentType() and the new value Course.Enrollment.EMAIL_ENROLLMENT.

In its deprecated state, this method does its best to translate between the old way in which this method was used (the intent of it) and the new replacement method. This method returns true or false depending on whether the value returned by getEnrollmentType() equals Course.Enrollment.EMAIL_ENROLLMENT.

setAllowEmailEnrollRequests

public void setAllowEmailEnrollRequests(boolean bAllowEmailEnrollRequests)

Deprecated.

As of Bb6, this property no longer exists as a separate field. Instead, the functionality was made part of the setEnrollmentType(Course.Enrollment) method and the new value Course.Enrollment.EMAIL_ENROLLMENT.

In its deprecated state, this method does its best to translate between the old way in which this method was used (the intent of it) and the new replacement method. When the provided value is true, this tranlsates to a call to setEnrollmentType(Course.Enrollment) with the value Course.Enrollment.EMAIL_ENROLLMENT. A value of false translates to teh same method call but with a value of Course.Enrollment.INSTRUCTOR_LED.

getIsLockedOut

public boolean getIsLockedOut()

Returns the locked out flag for this Course. If a course is marked as locked out, no one (not even the instructor) can access it. The system admin should still be able to access the course. course setting does not seem to be used.

Returns:

a boolean denoting whether this Course is locked out

setIsLockedOut

public void setIsLockedOut(boolean bIsLockedOut)

Sets the locked out flag for this Course. If a course is marked as locked out, no one (not even the instructor) can access it. If the desired behavior is to only lock out students, see setIsAvailable(boolean). The system admin should still be able to access the course. course setting does not seem to be used.

Parameters:

bIsLockedOut - true if the course is to be made available, false otherwise.

getPaceType

public Course.Pace getPaceType()

Returns the pace type for this Course.

Returns:

a type value as defined in Course.Pace

See Also:

Course.Pace

setPaceType

public void setPaceType(Course.Pace ePaceType)

Sets the pace type for this Course.

Parameters:

ePaceType - a valid type value as defined in Course.Pace

See Also:

Course.Pace

getServiceLevelType

public Course.ServiceLevel getServiceLevelType()

Returns the service level type for this Course.

Returns:

a type value as defined in Course.ServiceLevel

See Also:

Course.ServiceLevel

setServiceLevelType

public void setServiceLevelType(Course.ServiceLevel eServiceLevelType)

Sets the service level type for this Course.

Parameters:

eServiceLevelType - a valid type value as defined in Course.ServiceLevel

See Also:

Course.ServiceLevel

getShowEmailInSR

public boolean getShowEmailInSR()

Deprecated.

This field no longer exists as of Bb6 and should not be used.

setShowEmailInSR

public void setShowEmailInSR(boolean bShowEmailInSR)

Deprecated.

This field no longer exists as of Bb6 and should not be used.

getShowFirstNameInSR

public boolean getShowFirstNameInSR()

Deprecated.

This field no longer exists as of Bb6 and should not be used.

setShowFirstNameInSR

public void setShowFirstNameInSR(boolean bShowFirstNameInSR)

Deprecated.

This field no longer exists as of Bb6 and should not be used.

getShowLastNameInSR

public boolean getShowLastNameInSR()

Deprecated.

This field no longer exists as of Bb6 and should not be used.

setShowLastNameInSR

public void setShowLastNameInSR(boolean bShowLastNameInSR)

Deprecated.

This field no longer exists as of Bb6 and should not be used.

getShowPhone1InSR

public boolean getShowPhone1InSR()

Deprecated.

This field no longer exists as of Bb6 and should not be used.

setShowPhone1InSR

public void setShowPhone1InSR(boolean bShowPhone1InSR)

Deprecated.

This field no longer exists as of Bb6 and should not be used.

getShowStudentIdInSR

public boolean getShowStudentIdInSR()

Deprecated.

This field no longer exists as of Bb6 and should not be used.

setShowStudentIdInSR

public void setShowStudentIdInSR(boolean bShowStudentIdInSR)

Deprecated.

This field no longer exists as of Bb6 and should not be used.

getAllowGuests

public boolean getAllowGuests()

Returns the allow guests flag for this Course. This flag determines whether or not "guests" (users with the role guest) are allowed access to the course.

Returns:

a boolean denoting whether guests should be allowed in this course

setAllowGuests

public void setAllowGuests(boolean bAllowGuests)

Sets the allow guests flag for this Course. This flag determines whether or not "guests" (users with the role guest) are allowed access to the course.

Parameters:

bAllowGuests - true if guests should be allowed in this course, false otherwise

getAbsoluteLimit

public long getAbsoluteLimit()

Returns the absolute storage limit for this Course.

Returns:

a long representing the absolute storage limit of this Course

setAbsoluteLimit

public void setAbsoluteLimit(long lAbsoluteLimit)

Sets the absolute storage limit for this Course.

Parameters:

lAbsoluteLimit - a long representing the new absolute storage limit to set

getSoftLimit

public long getSoftLimit()

Returns the soft storage limit for this Course.

Returns:

a long representing the soft storage limit of this Course

setSoftLimit

public void setSoftLimit(long lSoftLimit)

Sets the soft storage limit for this Course.

Parameters:

lSoftLimit - a long representing the new soft storage limit to set

getUploadLimit

public long getUploadLimit()

Returns the upload storage limit for this Course.

Returns:

a long representing the upload storage limit of this Course

setUploadLimit

public void setUploadLimit(long lUploadLimit)

Sets the upload storage limit for this Course.

Parameters:

nUploadLimit - a long representing the new upload storage limit to set

getCourseId

public java.lang.String getCourseId()

Returns the course Id (not pk) associated with this Course.

Returns:

the course Id value of this Course as a String

setCourseId

public void setCourseId(java.lang.String strCourseId)

Sets the course Id (not pk) associated with this Course.

Parameters:

strCourseId - a String containing the course idfor this Course

getTitle

public java.lang.String getTitle()

Returns the title associated with this Course.

Returns:

the title value of this course as a String

setTitle

public void setTitle(java.lang.String strTitle)

Sets the title associated with this Course.

Parameters:

strTitle - a String containing the title for this course

getStartDate

public java.util.Calendar getStartDate()

Returns the date on which this Course will/has start(ed).

Returns:

a Calendar representing the start date of this Course

setStartDate

public void setStartDate(java.util.Calendar cStartDate)

Sets the start date for this Course.

Parameters:

cStartDate - a Calendar to use for the start date

getEndDate

public java.util.Calendar getEndDate()

Returns the date on which this Course will/has end(ed).

Returns:

a Calendar representing the end date of this Course

setEndDate

public void setEndDate(java.util.Calendar cEndDate)

Sets the end date for this Course.

Parameters:

cEndDate - a Calendar to use for the end date

getEnrollmentStartDate

public java.util.Calendar getEnrollmentStartDate()

Returns the date on which enrollment in this Course starts.

Returns:

a Calendar representing the enrollment start date of this Course

setEnrollmentStartDate

public void setEnrollmentStartDate(java.util.Calendar cEnrollmentStartDate)

Sets the enrollment start date for this Course.

Parameters:

cEnrollmentStartDate - a Calendar to use for the enrollment start date

getEnrollmentEndDate

public java.util.Calendar getEnrollmentEndDate()

Returns the date on which enrollment in this Course ends.

Returns:

a Calendar representing the enrollment end date of this Course

setEnrollmentEndDate

public void setEnrollmentEndDate(java.util.Calendar cEnrollmentEndDate)

Sets the enrollment end date for this Course.

Parameters:

cEnrollmentEndDate - a Calendar to use for the enrollment end date

getNumDaysOfUse

public int getNumDaysOfUse()

Returns the number of days this Course can be used.

Returns:

an int representing the number of days this Course can be used.

setNumDaysOfUse

public void setNumDaysOfUse(int nNumDaysOfUse)

Sets the number of days of use for this Course. This setting is only applicable if the course duration is a fixed number of days.

Parameters:

nNumDaysOfUse - a int representing the new number of days of use value

getFee

public float getFee()

Returns the fee (cost) for this Course.

Returns:

an float representing the fee (cost) of this Course

setFee

public void setFee(float fFee)

Sets the fee (cost) for this Course.

Parameters:

fFee - a float representing the new fee (cost) to set

getEnrollmentAccessCode

public java.lang.String getEnrollmentAccessCode()

Returns the enrollment access code associated with this Course.

Returns:

the enrollment access code value of this Course as a String

setEnrollmentAccessCode

public void setEnrollmentAccessCode(java.lang.String strEnrollmentAccessCode)

Sets the enrollment access code associated with this Course.

Parameters:

strEnrollmentAccessCode - a String containing the enrollment access codefor this Course

getBannerImageFile

public BbFile getBannerImageFile()

Returns the banner image file associated with this Course.

Returns:

the banner image value of this Course as a BbFile

setBannerImageFile

public void setBannerImageFile(BbFile bannerImageFile)

Sets the banner image file associated with this Course.

Parameters:

bannerImageFile - a BbFile containing the banner image for this Course

getInstitutionName

public java.lang.String getInstitutionName()

Returns the institution name associated with this Course.

Returns:

the institution name value of this Course as a String

setInstitutionName

public void setInstitutionName(java.lang.String strInstitutionName)

Sets the institution name associated with this Course.

Parameters:

strInstitutionName - a String containing the institution name for this Course

getDescription

public java.lang.String getDescription()

Returns the description associated with this Course.

Returns:

the description value of this course as a String

setDescription

public void setDescription(java.lang.String strDescription)

Sets the description associated with this Course.

Parameters:

strDescription - a String containing the description for this course

getLocale

public java.lang.String getLocale()

Returns the locale of this Course object.

Returns:

a String representing the locale of this course

setLocale

public void setLocale(java.lang.String strLocale)

Sets the locale value for this Course object.

Parameters:

strSettings - a String with the locale for this course

getIsLocaleEnforced

public boolean getIsLocaleEnforced()

Returns the enforced locale flag for this Course. If a course is identified as enforced, all students will be "forced" to use the locale specified by the course.

Returns:

a boolean denoted whether this Course locale is enforced.

setIsLocaleEnforced

public void setIsLocaleEnforced(boolean bIsEnforced)

Sets the enforced locale flag for this Course. If a course is identified as enforced, all students will be "forced" to use the locale specified by the course.

Parameters:

bIsAvailable - true if the course locale is to be enforced, false otherwise.

getAllowObservers

public boolean getAllowObservers()

Returns the allow observers flag for this Course. This flag determines whether or not "observers" (parents of a student in a course for example) are allowed access to the course.

Returns:

a boolean denoting whether observers should be allowed in this course

setAllowObservers

public void setAllowObservers(boolean bAllowObservers)

Sets the allow observers flag for this Course. This flag determines whether or not "observers" (parents of a student in a course for example) are allowed access to the course.

Parameters:

bAllowObservers - true if observers should be allowed in this course, false otherwise

getNavStyle

public Course.NavStyle getNavStyle()

Returns the navigation style for this Course.

Returns:

a navigation style value as defined in Course.NavStyle

See Also:

Course.NavStyle

setNavStyle

public void setNavStyle(Course.NavStyle eNavStyle)

Sets the navigation style for this Course.

Parameters:

eNavStyle - a valid navigation style value as defined in Course.NavStyle

See Also:

Course.NavStyle

getNavColorFg

public java.lang.String getNavColorFg()

Returns the foreground color (color of text) that is used for rendering the navigation links that appear on the left hand side of the course page. This value is only used if the navigation style (see getNavStyle()) for the course is set to Course.NavStyle.TEXT.

Returns:

a String containing the color value that is being used for rendering text on the navigation links. This string is an RGB color value specified as a hexadecimal number prefixed by a hash mark (i.e. white is "#FFFFFF", black is "#000000").

setNavColorFg

public void setNavColorFg(java.lang.String strNavColorFg)

Sets the foreground color (color of text) that should be used for rendering the navigation links that appear on the left hand side of the course page. This value is only used if the navigation style (see getNavStyle()) for the course is set to Course.NavStyle.TEXT.

Parameters:

strNavColorFg - a String containing the color value that should be used for rendering text on the navigation links. The expected value is an RGB color value specified as a hexadecimal number prefixed by a hash mark (i.e. white is "#FFFFFF", black is "#000000").

getNavColorBg

public java.lang.String getNavColorBg()

Returns the background color that is used for rendering the navigation links that appear on the left hand side of the course page. This value is only used if the navigation style (see getNavStyle()) for the course is set to Course.NavStyle.TEXT.

Returns:

a String containing the color value that is being used for rendering the background of the navigation links. This string is an RGB color value specified as a hexadecimal number prefixed by a hash mark (i.e. white is "#FFFFFF", black is "#000000").

setNavColorBg

public void setNavColorBg(java.lang.String strNavColorBg)

Sets the background color that should be used for rendering the navigation links that appear on the left hand side of the course page. This value is only used if the navigation style (see getNavStyle()) for the course is set to Course.NavStyle.TEXT.

Parameters:

strNavColorBg - a String containing the color value that should be used for rendering the background of the navigation links. The expected value is an RGB color value specified as a hexadecimal number prefixed by a hash mark (i.e. white is "#FFFFFF", black is "#000000").

getIsNavCollapsible

public boolean getIsNavCollapsible()

Returns the "is navigation collapsible" flag for this Course. This flag determines whether or not users of a course should be allowed to "collapse" (slide into the side) the navigation links which appear on the left hand side of the course page.

Returns:

a boolean denoting whether users should be able to collapse the the navigation buttons

setIsNavCollapsible

public void setIsNavCollapsible(boolean bIsNavCollapsible)

Sets the "is navigation collapsible" flag for this Course. This flag determines whether or not users of a course should be allowed to "collapse" (slide into the side) the navigation links which appear on the left hand side of the course page.

Parameters:

bIsNavCollapsible - true if users should be allowed to collapse the navigation buttons, false otherwise

getButtonStyle

public ButtonStyle getButtonStyle()

Returns the ButtonStyle associated with this Course.

This attribute is a "heavy" attribute and only contains a value if this Course was loaded using a "heavy" load method. Accessing this value when it has not been loaded is an error.

Returns:

ButtonStyle value for this course

setButtonStyle

public void setButtonStyle(ButtonStyle bstyle)

Sets the ButtonStyle value for this Course.

Parameters:

bstyle - a ButtonStyle value to use for this course

getCartridge

public Cartridge getCartridge()

Returns the Cartridge associated with this Course.

This attribute is a "heavy" attribute and only contains a value if this Course was loaded using a "heavy" load method. Accessing this value when it has not been loaded is an error.

Returns:

Cartridge value for this course

setCartridge

public void setCartridge(Cartridge cartridge)

Sets the Cartridge value for this Course.

Parameters:

cartridge - a Cartridge value to use for this course

getClassification

public Classification getClassification()

Returns the Classification associated with this Course.

This attribute is a "heavy" attribute and only contains a value if this Course was loaded using a "heavy" load method. Accessing this value when it has not been loaded is an error.

Returns:

Classification value for this course

setClassification

public void setClassification(Classification classif)

Sets Classification associated with this Course.

Parameters:

classif - a Classification value to use for this course

getRegistry

public Registry getRegistry()

Returns the Registry associated with this Course.

This attribute is a "heavy" attribute and only contains a value if this Course was loaded using a "heavy" load method. Accessing this value when it has not been loaded is an error.

Returns:

Registry value for this course

setRegistry

public void setRegistry(Registry reg)

Sets the Registry associated with this Course. The Registry provided should only contain CourseRegistryEntry values.

Parameters:

reg - a Registry value to use for this course

getDataType

public DataType getDataType()

Returns the DataType identifier for this object. Can be used to uniquely identify the "type" of this data object.

Specified by:

getDataType in interface IBbObject

Specified by:

getDataType in class BbObject

Returns:

the DataType for this object

validate

public void validate()
              throws ValidationException

Validates the contents of this Course. Internal consistency checks are also performed.

Specified by:

validate in interface IBbObject

Overrides:

validate in class BbObject

Throws:

ValidationException - if validation of this object fails

createAvailabilityFilter

public static final ListFilter createAvailabilityFilter(boolean targetAvailability)

Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon course "availability". Should be used with BbList.Iterator.

Parameters:

targetAvailability - true if "available" courses should be returned, false if "unavailable" courses should be returned

Returns:

a ListFilter instance that can filter on "availability"

createServiceLevelFilter

public static final ListFilter createServiceLevelFilter(Course.ServiceLevel targetServiceLevel)

Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon course service level (as returned by getServiceLevelType()). Should be used with BbList.Iterator.

Parameters:

targetServiceLevel - the Course.ServiceLevel of the courses that should be returned from a list

Returns:

a ListFilter instance that can filter on course service level

createMembershipRoleFilter

public static final ListFilter createMembershipRoleFilter(BbList membershipList,
                                                          CourseMembership.Role targetRole)

Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon the role of a user within those courses. Should be used with BbList.Iterator.

Parameters:

membershipList - a BbList of CourseMembership objects that will be used as the basis for determining a user's role within a course. The provided list of membership records should contain values for only the one user whose role you wish to filter on.

targetRole - the CourseMembership.Role value for courses that should be returned. If a record for the current course (that is being considered for filtering) exists in the provided membership list, and the role value for that membership record matches the target role value, the course will be returned.

Returns:

a ListFilter instance that can filter based upon the role of a user in a course

createMembershipRoleFilter

public static final ListFilter createMembershipRoleFilter(BbList membershipList,
                                                          CourseMembership.Role targetRole,
                                                          boolean bIsAvailable)

Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon the role of a user within those courses. Should be used with BbList.Iterator.

Parameters:

membershipList - a BbList of CourseMembership objects that will be used as the basis for determining a user's role within a course. The provided list of membership records should contain values for only the one user whose role you wish to filter on.

targetRole - the CourseMembership.Role value for courses that should be returned. If a record for the current course (that is being considered for filtering) exists in the provided membership list, and the role value for that membership record matches the target role value, the course will be returned.

bIsAvailable - Flag designating availability of CourseMembership desired.

Returns:

a ListFilter instance that can filter based upon the role of a user in a course

createDurationFilter

public static final ListFilter createDurationFilter(java.util.Date availDate,
                                                    BbList membershipList)

Factory method to create an instance of the ListFilter interface capable of filtering a list of Course objects based upon the course duration availability. Should be used with BbList.Iterator.

Parameters:

availDate - a Date that will be used as the basis for determining the availability of a course. The filtered list will contain courses that are available on the specified date given its duration settings.

Returns:

a ListFilter instance that can filter based upon the duration availability in a course