org.kuali.student.r2.lum.course.service.impl

Class CourseServiceImpl

java.lang.Object

org.kuali.student.r2.lum.course.service.impl.CourseServiceImpl

All Implemented Interfaces:

DictionaryService, CourseService

public class CourseServiceImpl
extends Object
implements CourseService

CourseServiceImpl implements CourseService Interface by mapping DTOs in CourseInfo to underlying entity DTOs like CluInfo and CluCluRelationInfo. For Credits, there are three credit types that are set with a combination of type and dynamic attributes To set a variable(range) credit option, set the ResultComponentInfo type to CourseAssemblerConstants.COURSE_RESULT_COMP_TYPE_CREDIT_VARIABLE and add the dynamic attributes CourseAssemblerConstants.COURSE_RESULT_COMP_ATTR_MIN_CREDIT_VALUE and CourseAssemblerConstants.COURSE_RESULT_COMP_ATTR_MAX_CREDIT_VALUE with respective credit min and max values. To set a fixed credit option, set the ResultComponentInfo type to CourseAssemblerConstants.COURSE_RESULT_COMP_TYPE_CREDIT_FIXED and add the dynamic attribute CourseAssemblerConstants.COURSE_RESULT_COMP_ATTR_FIXED_CREDIT_VALUE with the fixed credit value To Set multiple credit options, set the ResultComponentInfo type to CourseAssemblerConstants.COURSE_RESULT_COMP_TYPE_CREDIT_MULTIPLE and add each credit as a numeric ResultValue on the ResultComponentInfo for each credit you desire

Author:

Kuali Student Team

Constructor Summary

Constructors

Constructor and Description
CourseServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
CourseInfo	createCourse(CourseInfo courseInfo, ContextInfo contextInfo) Creates a Course
StatementTreeViewInfo	createCourseStatement(String courseId, StatementTreeViewInfo statementTreeViewInfo, ContextInfo contextInfo) Creates the Statement for a Course.
CourseInfo	createNewCourseVersion(String versionIndCourseId, String versionComment, ContextInfo contextInfo) Creates a new Course version based on the current course
StatusInfo	deleteCourse(String courseId, ContextInfo contextInfo) Deletes a Course.
StatusInfo	deleteCourseStatement(String courseId, StatementTreeViewInfo statementTreeViewInfo, ContextInfo contextInfo) Delete the Statement for a Course.
CluService	getCluService()
CourseInfo	getCourse(String courseId, ContextInfo contextInfo) Retrieves a Course
List<ActivityInfo>	getCourseActivities(String formatId)
List<ActivityInfo>	getCourseActivitiesByCourseFormat(String formatId, ContextInfo contextInfo) Retrieves the Activities for a Course.
CourseAssembler	getCourseAssembler()
List<FormatInfo>	getCourseFormats(String courseId)
List<FormatInfo>	getCourseFormatsByCourse(String courseId, ContextInfo contextInfo) Retrieves the formats for a Course.
List<LoDisplayInfo>	getCourseLearningObjectivesByCourse(String courseId, ContextInfo contextInfo) Retrieves the Learning Objectives for a Course.
List<LoDisplayInfo>	getCourseLos(String courseId)
List<CourseInfo>	getCoursesByIds(List<String> courseIds, ContextInfo contextInfo) Retrieves a list of courses by Ids
BusinessServiceMethodInvoker	getCourseServiceMethodInvoker()
List<StatementTreeViewInfo>	getCourseStatements(String courseId, String nlUsageTypeKey, String language, ContextInfo contextInfo) Retrieves the Statements of a Course.
VersionDisplayInfo	getCurrentVersion(String refObjectTypeURI, String refObjectId, ContextInfo contextInfo) Retrieves current version associated with the objectId.
VersionDisplayInfo	getCurrentVersionOnDate(String refObjectTypeURI, String refObjectId, Date date, ContextInfo contextInfo)
DictionaryService	getDictionaryServiceDelegate()
VersionDisplayInfo	getFirstVersion(String refObjectTypeURI, String refObjectId, ContextInfo contextInfo)
VersionDisplayInfo	getLatestVersion(String refObjectTypeURI, String refObjectId, ContextInfo contextInfo)
ObjectStructureDefinition	getObjectStructure(String objectTypeKey)
List<String>	getObjectTypes()
StatementService	getStatementService()
ValidatorFactory	getValidatorFactory()
VersionDisplayInfo	getVersionBySequenceNumber(String refObjectTypeURI, String refObjectId, Long sequence, ContextInfo contextInfo)
List<VersionDisplayInfo>	getVersions(String refObjectTypeURI, String refObjectId, ContextInfo contextInfo)
List<VersionDisplayInfo>	getVersionsInDateRange(String refObjectTypeURI, String refObjectId, Date from, Date to, ContextInfo contextInfo)
List<String>	searchForCourseIds(org.kuali.rice.core.api.criteria.QueryByCriteria criteria, ContextInfo contextInfo) Searches for courses based on the criteria and returns a list of Comment identifiers which match the search criteria.
List<CourseInfo>	searchForCourses(org.kuali.rice.core.api.criteria.QueryByCriteria criteria, ContextInfo contextInfo) Searches for courses based on the criteria and returns a list of Comments which match the search criteria.
void	setCluService(CluService cluService)
void	setCourseAssembler(CourseAssembler courseAssembler)
void	setCourseServiceMethodInvoker(BusinessServiceMethodInvoker courseServiceMethodInvoker)
StatusInfo	setCurrentCourseVersion(String courseVersionId, Date currentVersionStart, ContextInfo contextInfo) Sets a specific version of the Course as current.
void	setDictionaryServiceDelegate(DictionaryService dictionaryServiceDelegate)
void	setStatementService(StatementService statementService)
void	setValidatorFactory(ValidatorFactory validatorFactory)
CourseInfo	updateCourse(String courseId, CourseInfo courseInfo, ContextInfo contextInfo) Updates a Course.
StatementTreeViewInfo	updateCourseStatement(String courseId, String statementId, StatementTreeViewInfo statementTreeViewInfo, ContextInfo contextInfo) Updates the Statement for a Course.
List<ValidationResultInfo>	validateCourse(String validationType, CourseInfo courseInfo, ContextInfo contextInfo) Validates a course based on its dictionary
List<ValidationResultInfo>	validateCourseStatement(String courseId, StatementTreeViewInfo statementTreeViewInfo, ContextInfo contextInfo) Validates the Statement for a Course.

Methods inherited from class java.lang.Object

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

Constructor Detail

CourseServiceImpl

public CourseServiceImpl()

Method Detail

createCourse

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public CourseInfo createCourse(CourseInfo courseInfo,
                                                                                                                        ContextInfo contextInfo)
                        throws DataValidationErrorException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException,
                               VersionMismatchException

Description copied from interface: CourseService

Creates a Course

Specified by:

createCourse in interface CourseService

Parameters:

courseInfo - courseInfo

Returns:

the created course

Throws:

DataValidationErrorException - One or more values invalid for this operation

InvalidParameterException - invalid course

MissingParameterException - missing Course

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException

updateCourse

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public CourseInfo updateCourse(String courseId,
                                                                                                                        CourseInfo courseInfo,
                                                                                                                        ContextInfo contextInfo)
                        throws DataValidationErrorException,
                               DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               VersionMismatchException,
                               OperationFailedException,
                               PermissionDeniedException,
                               UnsupportedActionException,
                               DependentObjectsExistException,
                               AlreadyExistsException,
                               CircularRelationshipException,
                               CircularReferenceException,
                               ReadOnlyException

Description copied from interface: CourseService

Updates a Course.

Specified by:

updateCourse in interface CourseService

courseInfo - courseInfo

Returns:

updated Course

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - course not found

InvalidParameterException - invalid course

MissingParameterException - missing course

VersionMismatchException - The action was attempted on an out of date version.

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedActionException

DependentObjectsExistException

AlreadyExistsException

CircularRelationshipException

CircularReferenceException

ReadOnlyException

deleteCourse

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public StatusInfo deleteCourse(String courseId,
                                                                                                                        ContextInfo contextInfo)
                        throws DoesNotExistException,
                               InvalidParameterException,
                               MissingParameterException,
                               OperationFailedException,
                               PermissionDeniedException,
                               VersionMismatchException,
                               DataValidationErrorException,
                               AlreadyExistsException,
                               UnsupportedActionException,
                               DependentObjectsExistException,
                               CircularRelationshipException,
                               CircularReferenceException,
                               ReadOnlyException

Description copied from interface: CourseService

Deletes a Course.

Specified by:

deleteCourse in interface CourseService

Parameters:

courseId - identifier for Course.Maps to cluId

Returns:

status of the operation (success or failure)

Throws:

DoesNotExistException - Course does not exist

InvalidParameterException - invalid courseId

MissingParameterException - invalid courseId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedActionException

DependentObjectsExistException

CircularRelationshipException

CircularReferenceException

VersionMismatchException

DataValidationErrorException

AlreadyExistsException

ReadOnlyException

getCourse

@Transactional(readOnly=true)
public CourseInfo getCourse(String courseId,
                                         ContextInfo contextInfo)
                     throws DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException,
                            PermissionDeniedException

Description copied from interface: CourseService

Retrieves a Course

Specified by:

getCourse in interface CourseService

Parameters:

courseId - Unique Id of the Course. Maps to cluId

Returns:

the created course

Throws:

DoesNotExistException - Course does not exist

InvalidParameterException - invalid course

MissingParameterException - missing Course

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getCourseActivities

@Transactional(readOnly=true)
public List<ActivityInfo> getCourseActivities(String formatId)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

getCourseFormats

@Transactional(readOnly=true)
public List<FormatInfo> getCourseFormats(String courseId)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

getCourseLos

@Transactional(readOnly=true)
public List<LoDisplayInfo> getCourseLos(String courseId)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

getCourseStatements

@Transactional(readOnly=true)
public List<StatementTreeViewInfo> getCourseStatements(String courseId,
                                                                    String nlUsageTypeKey,
                                                                    String language,
                                                                    ContextInfo contextInfo)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Description copied from interface: CourseService

Retrieves the Statements of a Course.

Specified by:

getCourseStatements in interface CourseService

Parameters:

courseId - Unique Id of the Course. Maps to cluId

nlUsageTypeKey - Natural language usage type key (context)

language - Translation language e.g en, es, gr

Returns:

a list of Statement tree Structures

Throws:

DoesNotExistException - Course does not exist

InvalidParameterException - invalid courseId

MissingParameterException - invalid courseId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

validateCourse

@Transactional(readOnly=true)
public List<ValidationResultInfo> validateCourse(String validationType,
                                                              CourseInfo courseInfo,
                                                              ContextInfo contextInfo)
                                          throws InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException

Description copied from interface: CourseService

Validates a course based on its dictionary

Specified by:

validateCourse in interface CourseService

Parameters:

validationType - identifier of the extent of validation

courseInfo - Course to be validated

Returns:

results from performing the validation

Throws:

InvalidParameterException - invalid courseId

MissingParameterException - invalid courseId

OperationFailedException - unable to complete request

createCourseStatement

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public StatementTreeViewInfo createCourseStatement(String courseId,
                                                                                                                                            StatementTreeViewInfo statementTreeViewInfo,
                                                                                                                                            ContextInfo contextInfo)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException,
                                                   DataValidationErrorException

Description copied from interface: CourseService

Creates the Statement for a Course.

Specified by:

createCourseStatement in interface CourseService

Parameters:

courseId - Unique Id of the Course. Maps to cluId

Returns:

created Statementree Structures

Throws:

DoesNotExistException - Course does not exist

InvalidParameterException - invalid courseId

MissingParameterException - invalid courseId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

DataValidationErrorException

deleteCourseStatement

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public StatusInfo deleteCourseStatement(String courseId,
                                                                                                                                 StatementTreeViewInfo statementTreeViewInfo,
                                                                                                                                 ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Description copied from interface: CourseService

Delete the Statement for a Course.

Specified by:

deleteCourseStatement in interface CourseService

Parameters:

courseId - Unique Id of the Course. Maps to cluId

Returns:

status of the operation (success or failure)

Throws:

DoesNotExistException - Course does not exist

InvalidParameterException - invalid courseId

MissingParameterException - invalid courseId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

updateCourseStatement

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public StatementTreeViewInfo updateCourseStatement(String courseId,
                                                                                                                                            String statementId,
                                                                                                                                            StatementTreeViewInfo statementTreeViewInfo,
                                                                                                                                            ContextInfo contextInfo)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException,
                                                   DataValidationErrorException,
                                                   VersionMismatchException

Description copied from interface: CourseService

Updates the Statement for a Course.

Specified by:

updateCourseStatement in interface CourseService

Parameters:

courseId - Unique Id of the Course. Maps to cluId

Returns:

updated Statementree Structures

Throws:

DoesNotExistException - Course does not exist

InvalidParameterException - invalid courseId

MissingParameterException - invalid courseId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

DataValidationErrorException

VersionMismatchException

validateCourseStatement

@Transactional(readOnly=true)
public List<ValidationResultInfo> validateCourseStatement(String courseId,
                                                                       StatementTreeViewInfo statementTreeViewInfo,
                                                                       ContextInfo contextInfo)
                                                   throws InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Description copied from interface: CourseService

Validates the Statement for a Course.

Specified by:

validateCourseStatement in interface CourseService

Parameters:

courseId - Unique Id of the Course. Maps to cluId

Returns:

results from performing the validation

Throws:

InvalidParameterException - invalid courseId or stratement tree view Id

MissingParameterException - invalid courseId or statement tree view Id

OperationFailedException - unable to complete request

PermissionDeniedException

getObjectStructure

public ObjectStructureDefinition getObjectStructure(String objectTypeKey)

Specified by:

getObjectStructure in interface DictionaryService

getObjectTypes

public List<String> getObjectTypes()

Specified by:

getObjectTypes in interface DictionaryService

getCourseAssembler

public CourseAssembler getCourseAssembler()

setCourseAssembler

public void setCourseAssembler(CourseAssembler courseAssembler)

getCourseServiceMethodInvoker

public BusinessServiceMethodInvoker getCourseServiceMethodInvoker()

setCourseServiceMethodInvoker

public void setCourseServiceMethodInvoker(BusinessServiceMethodInvoker courseServiceMethodInvoker)

getDictionaryServiceDelegate

public DictionaryService getDictionaryServiceDelegate()

setDictionaryServiceDelegate

public void setDictionaryServiceDelegate(DictionaryService dictionaryServiceDelegate)

getValidatorFactory

public ValidatorFactory getValidatorFactory()

setValidatorFactory

public void setValidatorFactory(ValidatorFactory validatorFactory)

getCluService

public CluService getCluService()

setCluService

public void setCluService(CluService cluService)

getStatementService

public StatementService getStatementService()

setStatementService

public void setStatementService(StatementService statementService)

createNewCourseVersion

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public CourseInfo createNewCourseVersion(String versionIndCourseId,
                                                                                                                                  String versionComment,
                                                                                                                                  ContextInfo contextInfo)
                                  throws DataValidationErrorException,
                                         DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         VersionMismatchException,
                                         ReadOnlyException

Description copied from interface: CourseService

Creates a new Course version based on the current course

Specified by:

createNewCourseVersion in interface CourseService

Parameters:

versionIndCourseId - identifier for the Course to be versioned

versionComment - comment for the current version

Returns:

the new versioned Course information

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - courseId not found

InvalidParameterException - invalid courseId

MissingParameterException - missing courseId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

VersionMismatchException - The action was attempted on an out of date version

ReadOnlyException

setCurrentCourseVersion

@Transactional(readOnly=false,
               noRollbackFor=DoesNotExistException.class,
               rollbackFor=java.lang.Throwable.class)
public StatusInfo setCurrentCourseVersion(String courseVersionId,
                                                                                                                                   Date currentVersionStart,
                                                                                                                                   ContextInfo contextInfo)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          IllegalVersionSequencingException,
                                          OperationFailedException,
                                          PermissionDeniedException,
                                          DataValidationErrorException

Description copied from interface: CourseService

Sets a specific version of the Course as current. The sequence number must be greater than the existing current Course version. This will truncate the current version's end date to the currentVersionStart param. If a Course exists which is set to become current in the future, that course's currentVersionStart and CurrentVersionEnd will be nullified. The currentVersionStart must be in the future to prevent changing historic data.

Specified by:

setCurrentCourseVersion in interface CourseService

Parameters:

courseVersionId - Version Specific Id of the Course

currentVersionStart - Date when this course becomes current. Must be in the future and be after the most current course's start date.

Returns:

status of the operation

Throws:

DoesNotExistException - courseVersionId not found

InvalidParameterException - invalid courseVersionId, previousState, newState

MissingParameterException - missing courseVersionId, previousState, newState

IllegalVersionSequencingException - a Course with higher sequence number from the one provided is marked current

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

DataValidationErrorException

getCurrentVersion

@Transactional(readOnly=true)
public VersionDisplayInfo getCurrentVersion(String refObjectTypeURI,
                                                         String refObjectId,
                                                         ContextInfo contextInfo)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Description copied from interface: CourseService

Retrieves current version associated with the objectId.

Specified by:

getCurrentVersion in interface CourseService

Parameters:

refObjectTypeURI - reference object type URI

refObjectId - reference object Id

Returns:

current version

Throws:

DoesNotExistException - specified refObjectId, refObjectTypeURI not found

InvalidParameterException - invalid refObjectId, refObjectTypeURI

MissingParameterException - refObjectId, refObjectTypeURI not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getCurrentVersionOnDate

@Transactional(readOnly=true)
public VersionDisplayInfo getCurrentVersionOnDate(String refObjectTypeURI,
                                                               String refObjectId,
                                                               Date date,
                                                               ContextInfo contextInfo)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

getFirstVersion

@Transactional(readOnly=true)
public VersionDisplayInfo getFirstVersion(String refObjectTypeURI,
                                                       String refObjectId,
                                                       ContextInfo contextInfo)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

getLatestVersion

@Transactional(readOnly=true)
public VersionDisplayInfo getLatestVersion(String refObjectTypeURI,
                                                        String refObjectId,
                                                        ContextInfo contextInfo)
                                    throws DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

getVersionBySequenceNumber

@Transactional(readOnly=true)
public VersionDisplayInfo getVersionBySequenceNumber(String refObjectTypeURI,
                                                                  String refObjectId,
                                                                  Long sequence,
                                                                  ContextInfo contextInfo)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

getVersions

@Transactional(readOnly=true)
public List<VersionDisplayInfo> getVersions(String refObjectTypeURI,
                                                         String refObjectId,
                                                         ContextInfo contextInfo)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Specified by:

getVersions in interface CourseService

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

getVersionsInDateRange

@Transactional(readOnly=true)
public List<VersionDisplayInfo> getVersionsInDateRange(String refObjectTypeURI,
                                                                    String refObjectId,
                                                                    Date from,
                                                                    Date to,
                                                                    ContextInfo contextInfo)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

getCoursesByIds

public List<CourseInfo> getCoursesByIds(List<String> courseIds,
                               ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Description copied from interface: CourseService

Retrieves a list of courses by Ids

Specified by:

getCoursesByIds in interface CourseService

Returns:

Throws:

DoesNotExistException

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

searchForCourseIds

public List<String> searchForCourseIds(org.kuali.rice.core.api.criteria.QueryByCriteria criteria,
                              ContextInfo contextInfo)
                                throws InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException

Description copied from interface: CourseService

Searches for courses based on the criteria and returns a list of Comment identifiers which match the search criteria.

Specified by:

searchForCourseIds in interface CourseService

Parameters:

criteria - the search criteria

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

list of Comment Ids

Throws:

InvalidParameterException - invalid parameter

MissingParameterException - criteria, contextInfo not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

searchForCourses

public List<CourseInfo> searchForCourses(org.kuali.rice.core.api.criteria.QueryByCriteria criteria,
                                ContextInfo contextInfo)
                                  throws InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException

Description copied from interface: CourseService

Searches for courses based on the criteria and returns a list of Comments which match the search criteria.

Specified by:

searchForCourses in interface CourseService

Parameters:

criteria - the search criteria

contextInfo - Context information containing the principalId and locale information about the caller of service operation

Returns:

list of Comment information

Throws:

InvalidParameterException - invalid parameter

MissingParameterException - criteria, contextInfo not specified

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getCourseFormatsByCourse

public List<FormatInfo> getCourseFormatsByCourse(String courseId,
                                        ContextInfo contextInfo)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Description copied from interface: CourseService

Retrieves the formats for a Course.

Specified by:

getCourseFormatsByCourse in interface CourseService

Parameters:

courseId - Unique Id of the Course. Maps to cluId

Returns:

a list of format info Structures

Throws:

DoesNotExistException - Course does not exist

InvalidParameterException - invalid courseId

MissingParameterException - invalid courseId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getCourseActivitiesByCourseFormat

public List<ActivityInfo> getCourseActivitiesByCourseFormat(String formatId,
                                                   ContextInfo contextInfo)
                                                     throws DoesNotExistException,
                                                            InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Description copied from interface: CourseService

Retrieves the Activities for a Course.

Specified by:

getCourseActivitiesByCourseFormat in interface CourseService

Parameters:

formatId - Unique Id of the Format. Maps to cluId

Returns:

a list of activity info Structures

Throws:

DoesNotExistException - Format does not exist

InvalidParameterException - invalid format

MissingParameterException - missing Format

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getCourseLearningObjectivesByCourse

public List<LoDisplayInfo> getCourseLearningObjectivesByCourse(String courseId,
                                                      ContextInfo contextInfo)
                                                        throws DoesNotExistException,
                                                               InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Description copied from interface: CourseService

Retrieves the Learning Objectives for a Course.

Specified by:

getCourseLearningObjectivesByCourse in interface CourseService

Parameters:

courseId - Unique Id of the Course. Maps to cluId

Returns:

a list of LoDisplay info Structures

Throws:

DoesNotExistException - Course does not exist

InvalidParameterException - invalid courseId

MissingParameterException - invalid courseId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure