blackboard.admin.data.course
Class AdminCourse

java.lang.Object
  extended by blackboard.data.BbObject
      extended by blackboard.data.course.Course
          extended by blackboard.admin.data.course.AdminCourse
All Implemented Interfaces:
IAdminObject, Available, IBbObject, Identifiable, java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
CourseSite, Organization

public abstract class AdminCourse
extends Course
implements IAdminObject

The AdminCourse class is a representation of Course definition within the Bb Course Management System.

Since:
Bb 6.0
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class blackboard.data.course.Course
Course.AssessmentUpgradeVersion, Course.ContentView, Course.Duration, Course.Enrollment, Course.NavStyle, Course.Pace, Course.ServiceLevel
 
Nested classes/interfaces inherited from interface blackboard.admin.data.IAdminObject
IAdminObject.RecStatus, IAdminObject.RowStatus
 
Field Summary
 
Fields inherited from class blackboard.data.course.Course
DATA_TYPE
 
Fields inherited from class blackboard.data.BbObject
_bbAttributes
 
Constructor Summary
AdminCourse()
          Creates an instance of AdminCourse with default property values.
 
Method Summary
 java.lang.String getClassificationBatchUid()
          Returns the batch_uid attribute of this AdminCourse that corresponds to a valid Classification
 java.lang.String getDataSourceBatchUid()
          Returns the data source batch_uid of this AdminCourse
 IAdminObject.RecStatus getRecStatus()
          Returns the record status of this AdminCourse
 java.lang.String getReplacementBatchUid()
          Returns the replacement batch_uid of this AdminCourse
 IAdminObject.RowStatus getRowStatus()
          Returns the row status of this AdminCourse
 java.lang.String getSourcedidSource()
          gets the sourcedid Source associated with this Course.
 java.lang.String getTemplateBatchUid()
          Returns the template batch_uid of this AdminCourse
static char[] getValidChars()
           
 boolean isAssociationRefreshRequired()
           
 void setAssociationRefreshRequired(boolean associationRefreshRequired)
           
 void setClassification(blackboard.data.course.Classification classif)
          Sets Classification associated with this Course.
 void setClassificationBatchUid(java.lang.String batchUid)
          Sets the batch_uid attribute of this AdminCourse that corresponds to a valid Classification
 void setClassificationId(Id iClassificationId)
          Sets the classification Id value for this Course.
 void setDataSourceBatchUid(java.lang.String batchUid)
          Sets the data source batch_uid of this AdminCourse
 void setDataSourceId(Id iDataSourceId)
          Sets the data source Id value for this AdminCourse
 void setRecStatus(IAdminObject.RecStatus eRecStatus)
          Sets the record status of this AdminCourse
 void setReplacementBatchUid(java.lang.String batchUid)
          Sets that replacement batch_uid of this AdminCourse
 void setRowStatus(IAdminObject.RowStatus eRowStatus)
          Sets the row status of this AdminCourse
 void setServiceLevel(Course.ServiceLevel eLevel)
          Sets the service level Course.ServiceLevel for this AdminCourse Method is overriden for AdminCourse to always be Course.ServiceLevel.FULL
 void setSourcedidSource(java.lang.String sourcedidSource)
          Sets the sourcedid Source associated with this Course.
 void setTemplateBatchUid(java.lang.String batchUid)
          Sets that template batch_uid of this AdminCourse
 void validate()
          Validates the contents of this AdminCourse.
 
Methods inherited from class blackboard.data.course.Course
createActAsInstructorRoleFilter, createAvailabilityFilter, createChangeCourseNameFilter, createDirectEnrollmentFilter, createDurationFilter, createMembershipAvailabilityFilter, createMembershipRoleFilter, createMembershipRoleFilter, createMembershipRoleFilter, createMyPlacesFilter, createObserverAccessFilter, createServiceLevelFilter, equals, getAbsoluteLimit, getAllowGuests, getAllowObservers, getAssessmentUpgradeFlags, getAssessmentUpgradeVersion, getBannerImageFile, getBatchUid, getButtonStyle, getButtonStyleId, getCartridge, getCartridgeId, getClassification, getClassificationId, getCourseId, getCourseThemeId, getCreatedDate, getDataSourceId, getDataType, getDefaultViewContent, getDescription, getDisplayTitle, getDurationType, getDurationType, getEndDate, getEndDate, getEnrollmentAccessCode, getEnrollmentEndDate, getEnrollmentStartDate, getEnrollmentType, getFee, getHasDescriptionPage, getHonorTermAvailability, getImportTaskId, getInstitutionName, getIsAvailable, getIsAvailable, getIsLocaleEnforced, getIsLockedOut, getIsNavCollapsible, getLocale, getNavColorBg, getNavColorFg, getNavStyle, getNumDaysOfUse, getNumDaysOfUse, getPaceType, getRegistry, getServiceLevelType, getShowInCatalog, getSoftLimit, getStartDate, getStartDate, getTitle, getUploadLimit, hashCode, isChild, isOrganization, isParent, setAbsoluteLimit, setAllowGuests, setAllowObservers, setAssessmentUpgradeFlags, setAssessmentUpgradeVersion, setBannerImageFile, setBatchUid, setButtonStyle, setButtonStyleId, setCartridge, setCartridgeId, setCourseId, setCourseThemeId, setCreatedDate, setDefaultViewContent, setDescription, setDurationType, setEndDate, setEnrollmentAccessCode, setEnrollmentEndDate, setEnrollmentStartDate, setEnrollmentType, setFee, setHasDescriptionPage, setHonorTermAvailability, setImportTaskId, setInstitutionName, setIsAvailable, setIsLocaleEnforced, setIsLockedOut, setIsNavCollapsible, setLocale, setNavColorBg, setNavColorFg, setNavStyle, setNumDaysOfUse, setPaceType, setRegistry, setServiceLevelType, setShowInCatalog, setSoftLimit, setStartDate, setTitle, setUploadLimit
 
Methods inherited from class blackboard.data.BbObject
clone, getBbAttributes, getId, getModifiedDate, matches, persist, setId, setModifiedDate, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface blackboard.admin.data.IAdminObject
getDataSourceId
 
Methods inherited from interface blackboard.data.IBbObject
getBbAttributes, getCreatedDate, getDataType, getModifiedDate, setCreatedDate, setModifiedDate
 
Methods inherited from interface blackboard.data.Identifiable
getId, setId
 

Constructor Detail

AdminCourse

public AdminCourse()
Creates an instance of AdminCourse with default property values.

Method Detail

getValidChars

public static char[] getValidChars()

setServiceLevel

public void setServiceLevel(Course.ServiceLevel eLevel)
Sets the service level Course.ServiceLevel for this AdminCourse Method is overriden for AdminCourse to always be Course.ServiceLevel.FULL

Parameters:
eLevel - a service level Course.ServiceLevel value for this AdminCourse.

getRowStatus

public IAdminObject.RowStatus getRowStatus()
Returns the row status of this AdminCourse

Specified by:
getRowStatus in interface IAdminObject
Returns:
a status value as defined in IAdminObject.RowStatus
See Also:
IAdminObject.RowStatus

setRowStatus

public void setRowStatus(IAdminObject.RowStatus eRowStatus)
Sets the row status of this AdminCourse

Specified by:
setRowStatus in interface IAdminObject
Parameters:
eRowStatus - a status value as defined in IAdminObject.RowStatus
See Also:
IAdminObject.RowStatus

getRecStatus

public IAdminObject.RecStatus getRecStatus()
Returns the record status of this AdminCourse

Specified by:
getRecStatus in interface IAdminObject
Returns:
a status value as defined in IAdminObject.RecStatus
See Also:
IAdminObject.RecStatus

setRecStatus

public void setRecStatus(IAdminObject.RecStatus eRecStatus)
Sets the record status of this AdminCourse

Specified by:
setRecStatus in interface IAdminObject
Parameters:
eRecStatus - a status value as defined in IAdminObject.RecStatus
See Also:
IAdminObject.RecStatus

getDataSourceBatchUid

public java.lang.String getDataSourceBatchUid()
Returns the data source batch_uid of this AdminCourse

Specified by:
getDataSourceBatchUid in interface IAdminObject
Returns:
data source batch_uid for this AdminCourse

setDataSourceBatchUid

public void setDataSourceBatchUid(java.lang.String batchUid)
Sets the data source batch_uid of this AdminCourse

Specified by:
setDataSourceBatchUid in interface IAdminObject
Parameters:
batchUid - a data source batch_uid value for this AdminCourse

setDataSourceId

public void setDataSourceId(Id iDataSourceId)
Sets the data source Id value for this AdminCourse

Specified by:
setDataSourceId in interface IAdminObject
Overrides:
setDataSourceId in class Course
Parameters:
iDataSourceId - a data source Id value to use for this AdminCourse

getReplacementBatchUid

public java.lang.String getReplacementBatchUid()
Returns the replacement batch_uid of this AdminCourse

Returns:
batch_uid replacement value for this AdminCourse

setReplacementBatchUid

public void setReplacementBatchUid(java.lang.String batchUid)
Sets that replacement batch_uid of this AdminCourse

Parameters:
batchUid - a batch_uid replacement value to use for this AdminCourse

getTemplateBatchUid

public java.lang.String getTemplateBatchUid()
Returns the template batch_uid of this AdminCourse

Returns:
batch_uid template value for this AdminCourse

setTemplateBatchUid

public void setTemplateBatchUid(java.lang.String batchUid)
Sets that template batch_uid of this AdminCourse

Parameters:
batchUid - a batch_uid template value to use for this AdminCourse

getClassificationBatchUid

public java.lang.String getClassificationBatchUid()
Returns the batch_uid attribute of this AdminCourse that corresponds to a valid Classification

Returns:
batch_uid value for Classification of this AdminCourse

setClassificationBatchUid

public void setClassificationBatchUid(java.lang.String batchUid)
Sets the batch_uid attribute of this AdminCourse that corresponds to a valid Classification

Parameters:
batchUid - a batch_uid for Classification to use for this AdminCourse

setClassificationId

public void setClassificationId(Id iClassificationId)
Sets the classification Id value for this Course.

Overrides:
setClassificationId in class Course
Parameters:
iClassificationId - a classification Id value to use for this Course

setClassification

public void setClassification(blackboard.data.course.Classification classif)
Sets Classification associated with this Course.

Overrides:
setClassification in class Course
Parameters:
classif - a Classification value to use for this course

setSourcedidSource

public void setSourcedidSource(java.lang.String sourcedidSource)
Sets the sourcedid Source associated with this Course. Setting this value is not necessary when creating a Course for persisting to the database since the database will not actually perist this value at this time. It is only used for lms integrations ( integrations with WebCT )

Parameters:
sourcedidSource - a String containing the Ims Sourcedid Source for this Course

getSourcedidSource

public java.lang.String getSourcedidSource()
gets the sourcedid Source associated with this Course. The database will not actually perist this value at this time. It is only used for lms integrations ( integrations with WebCT )

Returns:
sourcedidSource a String containing the Ims Sourcedid Source for this Course

setAssociationRefreshRequired

public void setAssociationRefreshRequired(boolean associationRefreshRequired)
Parameters:
associationRefreshRequired - whether existing associations should be cleared when this object is saved

isAssociationRefreshRequired

public boolean isAssociationRefreshRequired()
Returns:
whether existing associations should be cleared when this object is saved

validate

public void validate()
              throws ValidationException
Validates the contents of this AdminCourse. Internal consistency checks are also performed.

Specified by:
validate in interface IAdminObject
Specified by:
validate in interface IBbObject
Overrides:
validate in class Course
Throws:
ValidationException - if validation of this object fails


Copyright © 2012 Blackboard, Inc. All Rights Reserved.