CourseOfferingService (Kuali Student 2.0.0-M6-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.kuali.student.enrollment.courseoffering.service
Interface CourseOfferingService

All Superinterfaces:: CourseOfferingServiceBusinessLogic

All Known Implementing Classes:: CourseOfferingServiceAOTOverrideImpl, CourseOfferingServiceAuthorizationDecorator, CourseOfferingServiceDecorator, CourseOfferingServiceImpl, CourseOfferingServiceValidationDecorator

public interface CourseOfferingService
extends CourseOfferingServiceBusinessLogic
extends CourseOfferingServiceBusinessLogic

Course Offering is a class II service supporting the process of offering courses for student registration.

Courses are offered for a specific term which is associated with a specific Academic Calendar. At the canonical level a course is defined by formats for which the course will be offered. Each format describes the activity types that comprise that format, e.g., lecture and lab.

The purpose of multiple formats is to support different formats based on a term type, e.g., Fall versus Spring offering, or to offer multiple formats in the same term, e.g., in person (traditional) versus online. Offering a course is the process of creating specific instances of the course, and for each format to be offered in the selected term, creating a specified number of each activity type that comprises the format, e.g. five (5) lectures and ten (10) labs of Biology 101.

Individual activity offerings correspond to events in a scheduling system, each with a meeting pattern. The term 'section' varies by institution, but refers to either the individual activity offering, or it refers to the combination of activity offerings, when the course has more than one activity type, that the student registers in as part of that course.

To avoid confusion, this service introduces a new entity to capture the second definition of section. A registration group represents a valid combination of activity offerings, even if the number is one, in which a student registers. The design supports unrestricted matching, e.g., any lecture with any lab, as well as specific matching, e.g., lecture 1 with lab A or B, and lecture 2 with lab C or D.

Version: 1.0 (Dev)

Author:: Kuali Student Team (Kamal)

Method Summary
`StatusInfo`	`addSeatPoolDefinitionToActivityOffering(String seatPoolDefinitionId, String activityOfferingId, ContextInfo contextInfo)` Add a SeatPoolDefinition to an ActivityOffering
`Float`	`calculateInClassContactHoursForTerm(String activityOfferingId, ContextInfo context)` When/for how long does the offering meet in class during the term.
`Float`	`calculateOutofClassContactHoursForTerm(String activityOfferingId, ContextInfo context)` When/for how long does the offering meet out of class during the term.
`Float`	`calculateTotalContactHoursForTerm(String activityOfferingId, ContextInfo context)` When/for how long does the offering meet in total during the term.
`ActivityOfferingInfo`	`copyActivityOffering(String activityOfferingId, ContextInfo context)` Creates a new Activity Offering from another activity offering, the generated activity offering is the same format offering, type and canonical activity as the source activity fofering
`ActivityOfferingInfo`	`createActivityOffering(String formatOfferingId, String activityId, String activityOfferingTypeKey, ActivityOfferingInfo activityOfferingInfo, ContextInfo context)` Creates a new Activity Offering for a format offering.
`ActivityOfferingClusterInfo`	`createActivityOfferingCluster(String formatOfferingId, String activityOfferingClusterTypeKey, ActivityOfferingClusterInfo activityOfferingClusterInfo, ContextInfo contextInfo)` Creates a new Activity Offering Cluster from the given Format Offering
`ColocatedOfferingSetInfo`	`createColocatedOfferingSet(String colocatedOfferingSetTypeKey, ColocatedOfferingSetInfo colocatedOfferingSetInfo, ContextInfo contextInfo)` Creates a ColocatedOfferingSet
`CourseOfferingInfo`	`createCourseOffering(String courseId, String termId, String courseOfferingTypeKey, CourseOfferingInfo courseOfferingInfo, List<String> optionKeys, ContextInfo context)` Creates a new course offering from a canonical course.
`FormatOfferingInfo`	`createFormatOffering(String courseOfferingId, String formatId, String formatOfferingType, FormatOfferingInfo formatOfferingInfo, ContextInfo context)` Creates an Format Offering for a course offering
`RegistrationGroupInfo`	`createRegistrationGroup(String formatOfferingId, String activityOfferingClusterId, String registrationGroupType, RegistrationGroupInfo registrationGroupInfo, ContextInfo context)` Creates a new Registration Group.
`SeatPoolDefinitionInfo`	`createSeatPoolDefinition(SeatPoolDefinitionInfo seatPoolDefinitionInfo, ContextInfo context)` Creates a new Seat Pool
`StatusInfo`	`deleteActivityOffering(String activityOfferingId, ContextInfo context)` Deletes an existing ActivityOffering.
`StatusInfo`	`deleteActivityOfferingCascaded(String activityOfferingId, ContextInfo context)` Deletes an existing ActivityOffering cascaded style.
`StatusInfo`	`deleteActivityOfferingCluster(String activityOfferingClusterId, ContextInfo contextInfo)` Deletes an activity offering cluster based on the identifier
`StatusInfo`	`deleteActivityOfferingClusterCascaded(String activityOfferingClusterId, ContextInfo contextInfo)` Deletes an existing ActivityOfferingCluster cascaded style.
`StatusInfo`	`deleteColocatedOfferingSet(String colocatedOfferingSetId, ContextInfo contextInfo)` Removes a ColocatedOfferingSet.
`StatusInfo`	`deleteCourseOffering(String courseOfferingId, ContextInfo context)` Deletes an existing CourseOffering.
`StatusInfo`	`deleteCourseOfferingCascaded(String courseOfferingId, ContextInfo context)` Deletes an existing CourseOffering cascaded style.
`StatusInfo`	`deleteFormatOffering(String formatOfferingId, ContextInfo context)` Deletes an Format Offering
`StatusInfo`	`deleteFormatOfferingCascaded(String formatOfferingId, ContextInfo context)` Deletes an Format Offering with dependent Activity Offering and Registration group
`StatusInfo`	`deleteGeneratedRegistrationGroupsByFormatOffering(String formatOfferingId, ContextInfo context)` Deletes all generated Registration Groups for a Format Offering.
`StatusInfo`	`deleteRegistrationGroup(String registrationGroupId, ContextInfo context)` Deletes an existing Registration Group.
`StatusInfo`	`deleteRegistrationGroupsByFormatOffering(String formatOfferingId, ContextInfo context)` Deletes all Registration Groups for a Format Offering.
`StatusInfo`	`deleteRegistrationGroupsForCluster(String activityOfferingClusterId, ContextInfo contextInfo)` Deletes all Registration Groups associated with an Activity Offering Cluster
`StatusInfo`	`deleteSeatPoolDefinition(String seatPoolDefinitionId, ContextInfo context)` Deletes an existing SeatPoolDefinition.
`List<ActivityOfferingInfo>`	`generateActivityOfferings(String formatOfferingId, String activityOfferingType, Integer quantity, ContextInfo context)` Generates activity offerings based on a format offering.
`ActivityOfferingInfo`	`getActivityOffering(String activityOfferingId, ContextInfo context)` Retrieve information about an ActivityOffering
`ActivityOfferingClusterInfo`	`getActivityOfferingCluster(String activityOfferingClusterId, ContextInfo contextInfo)` Gets an Activity Offering Cluster based on the Identifier
`List<ActivityOfferingClusterInfo>`	`getActivityOfferingClustersByFormatOffering(String formatOfferingId, ContextInfo contextInfo)` Retrieves a list of ActivityOfferingClusters associated with a FormatOffering
`List<String>`	`getActivityOfferingClustersIdsByFormatOffering(String formatOfferingId, ContextInfo contextInfo)` Retrieves a list of ActivityOfferingCluster Id's associated with a FormatOffering
`ActivityOfferingDisplayInfo`	`getActivityOfferingDisplay(String activityOfferingId, ContextInfo contextInfo)` Retrieves a single ActivityOfferingDisplay by a ActivityOffering Id.
`List<ActivityOfferingDisplayInfo>`	`getActivityOfferingDisplaysByIds(List<String> activityOfferingIds, ContextInfo contextInfo)` Retrieve a list of ActivitAOfferingAdminDisplays corresponding to a list of ActivityOffering Ids.
`List<ActivityOfferingDisplayInfo>`	`getActivityOfferingDisplaysForCourseOffering(String courseOfferingId, ContextInfo contextInfo)` Retrieve a list of ActivityOfferingDisplays corresponding to a CourseOffering Id.
`List<ActivityOfferingInfo>`	`getActivityOfferingsByCluster(String activityOfferingClusterId, ContextInfo contextInfo)` Retrieves a list of ActivityOffering records that belongs to an ActivityOfferingCluster.
`List<ActivityOfferingInfo>`	`getActivityOfferingsByCourseOffering(String courseOfferingId, ContextInfo context)` Retrieves a list of ActivityOffering records that belongs to a CourseOffering.
`List<ActivityOfferingInfo>`	`getActivityOfferingsByFormatOffering(String formatOfferingId, ContextInfo context)` Retrieves a list of ActivityOffering records that belongs to a CourseOffering.
`List<ActivityOfferingInfo>`	`getActivityOfferingsByFormatOfferingWithoutRegGroup(String formatOfferingId, ContextInfo context)` Retrieves the Activity Offerings by actvity offering template id which don't have registration groups created for them yet.
`List<ActivityOfferingInfo>`	`getActivityOfferingsByIds(List<String> activityOfferingIds, ContextInfo context)` Retrieves a list of activity offerings by id list.
`List<ActivityOfferingInfo>`	`getActivityOfferingsWithoutClusterByFormatOffering(String formatOfferingId, ContextInfo contextInfo)` Retrieves a list of ActivityOffering records that belongs to a FormatOffering that are not associated with a cluster
`TypeInfo`	`getActivityOfferingType(String activityOfferingTypeKey, ContextInfo context)` This method returns the TypeInfo for a given activity offering type key.
`List<TypeInfo>`	`getActivityOfferingTypes(ContextInfo context)` This method returns the valid activity offering types.
`List<TypeInfo>`	`getActivityOfferingTypesForActivityType(String activityTypeKey, ContextInfo context)` This method returns the valid activity offering types for a given canonical activity type
`ColocatedOfferingSetInfo`	`getColocatedOfferingSet(String colocatedOfferingSetId, ContextInfo contextInfo)` Retrieves a ColocatedOfferingSet.
`List<String>`	`getColocatedOfferingSetIdsByType(String colocatedOfferingSetTypeKey, ContextInfo contextInfo)` Retrieves a list of ColocatedOfferingSet Ids by ColocatedOfferingSet Type.
`List<String>`	`getColocatedOfferingSetIdsForActivityOffering(String activityOfferingId, ContextInfo contextInfo)` Retrieves a list of ColocatedOfferingSets Ids corresponding to the given list of ColocatedOfferingSets that an Activity Offering with given activity offering id is part of.
`List<ColocatedOfferingSetInfo>`	`getColocatedOfferingSetsByIds(List<String> colocatedOfferingSetIds, ContextInfo contextInfo)` Retrieves a list of ColocatedOfferingSets corresponding to the given list of ColocatedOfferingSet Ids.
`CourseOfferingInfo`	`getCourseOffering(String courseOfferingId, ContextInfo contextInfo)` Retrieves a single CourseOffering by a CourseOffering Id.
`CourseOfferingDisplayInfo`	`getCourseOfferingDisplay(String courseOfferingId, ContextInfo contextInfo)` Retrieves a single CourseOfferingDisplayInfo by a CourseOffering Id.
`List<CourseOfferingDisplayInfo>`	`getCourseOfferingDisplaysByIds(List<String> courseOfferingIds, ContextInfo contextInfo)` Retrieve a list of CourseOfferingDisplays corresponding to a list of CourseOfferingIds.
`List<String>`	`getCourseOfferingIdsByTerm(String termId, Boolean useIncludedTerm, ContextInfo contextInfo)` Retrieves a list of CourseOffering Ids for CourseOfferings offered in a given term.
`List<String>`	`getCourseOfferingIdsByTermAndSubjectArea(String termId, String subjectArea, ContextInfo contextInfo)` Retrieve a list of CourseOffering Ids for CourseOfferings of a given subject area offered in the given Term.
`List<String>`	`getCourseOfferingIdsByTermAndUnitsContentOwner(String termId, String unitsContentOwnerId, ContextInfo contextInfo)` Retrieves a list of CourseOffering Ids for CourseOfferings offered in a given Term by a units content owner.
`List<String>`	`getCourseOfferingIdsByType(String courseOfferingTypeKey, ContextInfo contextInfo)` Retrieve a list of CourseOffering Ids by CourseOffering Type.
`List<CourseOfferingInfo>`	`getCourseOfferingsByCourse(String courseId, ContextInfo contextInfo)` Retrieve CourseOfferings by canonical Course Id across all Terms.
`List<CourseOfferingInfo>`	`getCourseOfferingsByCourseAndTerm(String courseId, String termId, ContextInfo contextInfo)` Retrieve a list of CourseOfferings by canonical Course Id and Term.
`List<CourseOfferingInfo>`	`getCourseOfferingsByIds(List<String> courseOfferingIds, ContextInfo contextInfo)` Retrieves a list of CourseOfferings from a list of CourseOffering Ids.
`List<CourseOfferingInfo>`	`getCourseOfferingsByTermAndInstructor(String termId, String instructorId, ContextInfo contextInfo)` Retrieves a list of CourseOfferings for a given Term and Instructor.
`TypeInfo`	`getCourseOfferingType(String courseOfferingTypeKey, ContextInfo contextInfo)` This method returns the TypeInfo for a given course offering type key.
`List<TypeInfo>`	`getCourseOfferingTypes(ContextInfo contextInfo)` This method returns the valid course offering types.
`FormatOfferingInfo`	`getFormatOffering(String formatOfferingId, ContextInfo context)` Gets an format offering based on Id.
`List<FormatOfferingInfo>`	`getFormatOfferingsByCourseOffering(String courseOfferingId, ContextInfo context)` Gets a list of format offering by a course offering id they belong to.
`List<TypeInfo>`	`getInstructorTypesForActivityOfferingType(String activityOfferingTypeKey, ContextInfo context)` This method returns the valid instructor (lpr) types for an activity offering type.
`List<TypeInfo>`	`getInstructorTypesForCourseOfferingType(String courseOfferingTypeKey, ContextInfo contextInfo)` This method returns the valid instructor (LPR) types for a CourseOffering type.
`RegistrationGroupInfo`	`getRegistrationGroup(String registrationGroupId, ContextInfo context)` Retrieve a RegistrationGroup based on id
`List<RegistrationGroupInfo>`	`getRegistrationGroupsByActivityOfferingCluster(String activityOfferingClusterId, ContextInfo contextInfo)` Retrieves a list of RegistrationGroup records that belongs to a specified ActivityOfferingCluster.
`List<RegistrationGroupInfo>`	`getRegistrationGroupsByFormatOffering(String formatOfferingId, ContextInfo context)` Retrieves a list of RegistrationGroup records that belongs to a CourseOffering for a given canonical format type
`List<RegistrationGroupInfo>`	`getRegistrationGroupsByIds(List<String> registrationGroupIds, ContextInfo context)` Retrieves a list of registration group by id list.
`List<RegistrationGroupInfo>`	`getRegistrationGroupsForCourseOffering(String courseOfferingId, ContextInfo context)` Retrieves a list of RegistrationGroup records that belongs to a CourseOffering
`List<RegistrationGroupInfo>`	`getRegistrationGroupsWithActivityOfferings(List<String> activityOfferingIds, ContextInfo context)` Retrieves a list of RegistrationGroup records that contain all the activity offerings in the input list.
`SeatPoolDefinitionInfo`	`getSeatPoolDefinition(String seatPoolDefinitionId, ContextInfo context)` Retrieve information about a SeatPoolDefinition
`List<SeatPoolDefinitionInfo>`	`getSeatPoolDefinitionsForActivityOffering(String activityOfferingId, ContextInfo context)` Retrieves a list of SeatPoolDefinitions records that belongs to an ActivityOffering.
`List<String>`	`getValidCanonicalCourseToCourseOfferingOptionKeys(ContextInfo contextInfo)` Get the valid options that can be specified to control canonical Course to CourseOffering operations.
`List<String>`	`getValidRolloverOptionKeys(ContextInfo contextInfo)` Get the valid rollover option keys.
`StatusInfo`	`removeSeatPoolDefinitionFromActivityOffering(String seatPoolDefinitionId, String activityOfferingId, ContextInfo contextInfo)` Removes a SeatPoolDefinition from an ActivityOffering.
`SocRolloverResultItemInfo`	`rolloverCourseOffering(String sourceCourseOfferingId, String targetTermId, List<String> optionKeys, ContextInfo context)` Creates a new course offering based on the source course offering.
`StatusInfo`	`scheduleActivityOffering(String activityOfferingId, ContextInfo contextInfo)` Attempt to schedule a single Activity Offering using the Scheduling Service.
`List<String>`	`searchForActivityOfferingClusterIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for Activity Offering Clusters that meet the given search criteria.
`List<ActivityOfferingClusterInfo>`	`searchForActivityOfferingClusters(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for Activity Offering Clusters that meet the given search criteria.
`List<String>`	`searchForActivityOfferingIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for ActivityOfferings that meet the given search criteria.
`List<ActivityOfferingInfo>`	`searchForActivityOfferings(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for ActivityOfferings that meet the given search criteria.
`List<String>`	`searchForColocatedOfferingSetIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for ColocatedOfferingSets based on the criteria and returns a list of ColocatedOfferingSet identifiers which match the search criteria.
`List<ColocatedOfferingSetInfo>`	`searchForColocatedOfferingSets(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for ColocatedOfferingSets based on the criteria and returns a list of ColocatedOfferingSets which match the search criteria.
`List<String>`	`searchForCourseOfferingIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for CourseOfferings that meet the given search criteria.
`List<CourseOfferingInfo>`	`searchForCourseOfferings(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for CourseOfferings that meet the given search criteria.
`List<String>`	`searchForFormatOfferingIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for FormatOfferings that meet the given search criteria.
`List<FormatOfferingInfo>`	`searchForFormatOfferings(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for FormatOfferings that meet the given search criteria.
`List<String>`	`searchForRegistrationGroupIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for RegistrationGroups that meet the given search criteria.
`List<RegistrationGroupInfo>`	`searchForRegistrationGroups(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for RegistrationGroups that meet the given search criteria.
`List<String>`	`searchForSeatpoolDefinitionIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for SeatPoolDefinitions that meet the given search criteria.
`List<SeatPoolDefinitionInfo>`	`searchForSeatpoolDefinitions(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for SeatPoolDefinitions that meet the given search criteria.
`ActivityOfferingInfo`	`updateActivityOffering(String activityOfferingId, ActivityOfferingInfo activityOfferingInfo, ContextInfo context)` Updates an existing ActivityOffering.
`ActivityOfferingClusterInfo`	`updateActivityOfferingCluster(String formatOfferingId, String activityOfferingClusterId, ActivityOfferingClusterInfo activityOfferingClusterInfo, ContextInfo contextInfo)` Updates an ActivityOfferingCluster based on the info object
`StatusInfo`	`updateActivityOfferingClusterState(String activityOfferingClusterId, String nextStateKey, ContextInfo contextInfo)` Updates the state of an existing ActivityOfferingCluster to another state provided that it is valid to do so.
`StatusInfo`	`updateActivityOfferingState(String activityOfferingId, String nextStateKey, ContextInfo contextInfo)` Updates the state of an existing ActivityOffering to another state provided that it is valid to do so.
`ColocatedOfferingSetInfo`	`updateColocatedOfferingSet(String colocatedOfferingSetId, ColocatedOfferingSetInfo colocatedOfferingSetInfo, ContextInfo contextInfo)` Updates a ColocatedOfferingSet.
`CourseOfferingInfo`	`updateCourseOffering(String courseOfferingId, CourseOfferingInfo courseOfferingInfo, ContextInfo context)` Updates an existing CourseOffering.
`CourseOfferingInfo`	`updateCourseOfferingFromCanonical(String courseOfferingId, List<String> optionKeys, ContextInfo context)` Updates an existing CourseOffering from its canonical.
`StatusInfo`	`updateCourseOfferingState(String courseOfferingId, String nextStateKey, ContextInfo contextInfo)` Updates the state of an existing CourseOffering into another state provided that it is valid to do so.
`FormatOfferingInfo`	`updateFormatOffering(String formatOfferingId, FormatOfferingInfo formatOfferingInfo, ContextInfo context)` Update a Format Offering
`StatusInfo`	`updateFormatOfferingState(String formatOfferingId, String nextStateKey, ContextInfo contextInfo)` Updates the state of an existing FormatOffering to another state provided that it is valid to do so.
`RegistrationGroupInfo`	`updateRegistrationGroup(String registrationGroupId, RegistrationGroupInfo registrationGroupInfo, ContextInfo context)` Updates an existing RegistrationGroup.
`StatusInfo`	`updateRegistrationGroupState(String registrationGroupId, String nextStateKey, ContextInfo contextInfo)` Updates the state of an existing RegistrationGroup to another state provided that it is valid to do so.
`SeatPoolDefinitionInfo`	`updateSeatPoolDefinition(String seatPoolDefinitionId, SeatPoolDefinitionInfo seatPoolDefinitionInfo, ContextInfo context)` Updates an existing SeatPoolDefinition.
`StatusInfo`	`updateSeatPoolDefinitionState(String seatPoolDefinitionId, String nextStateKey, ContextInfo contextInfo)` Updates the state of an existing SeatPoolDefinition to another state provided that it is valid to do so.
`List<ValidationResultInfo>`	`validateActivityOffering(String validationType, ActivityOfferingInfo activityOfferingInfo, ContextInfo context)` Validates an activity offering.
`List<ValidationResultInfo>`	`validateActivityOfferingCluster(String validationTypeKey, String formatOfferingId, ActivityOfferingClusterInfo activityOfferingClusterInfo, ContextInfo contextInfo)` Validates an Activity Offering Cluster.
`List<ValidationResultInfo>`	`validateColocatedOfferingSet(String validationTypeKey, String colocatedOfferingSetTypeKey, ColocatedOfferingSetInfo colocatedOfferingSetInfo, ContextInfo contextInfo)` Validates a ColocatedOfferingSet.
`List<ValidationResultInfo>`	`validateCourseOffering(String validationTypeKey, CourseOfferingInfo courseOfferingInfo, ContextInfo contextInfo)` Validates a CourseOffering.
`List<ValidationResultInfo>`	`validateCourseOfferingFromCanonical(CourseOfferingInfo courseOfferingInfo, List<String> optionKeys, ContextInfo context)` Validates / Compares a course offering against it's canonical course.
`List<ValidationResultInfo>`	`validateFormatOffering(String validationType, FormatOfferingInfo formatOfferingInfo, ContextInfo context)` Validates a format offering.
`List<ValidationResultInfo>`	`validateRegistrationGroup(String validationType, String activityOfferingClusterId, String registrationGroupType, RegistrationGroupInfo registrationGroupInfo, ContextInfo contextInfo)` Validates a registration group.
`List<ValidationResultInfo>`	`validateSeatPoolDefinition(String validationTypeKey, SeatPoolDefinitionInfo seatPoolDefinitionInfo, ContextInfo context)` Validate a seat pool definition
`AOClusterVerifyResultsInfo`	`verifyActivityOfferingClusterForGeneration(String activityOfferingClusterId, ContextInfo contextInfo)` Verifies an Activity Offering Cluster completeness for generation, verifying that each of the created RegGroups will be legitimate
`List<ValidationResultInfo>`	`verifyRegistrationGroup(String registrationGroupId, ContextInfo contextInfo)` Verifies a Registration Group applying rules such as: (1) Reg Group has one of each AO type (2) AO's don't meet at the same time (if scheduling has already happened) (3) AO's are all offered at the same campus (4) AO's don't have conflicting seatpool/enrollment restrictions

Methods inherited from interface org.kuali.student.enrollment.courseoffering.service.CourseOfferingServiceBusinessLogic
`generateRegistrationGroupsForCluster, generateRegistrationGroupsForFormatOffering`

Method Detail

getCourseOfferingType

TypeInfo getCourseOfferingType(String courseOfferingTypeKey,
                               ContextInfo contextInfo)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

This method returns the TypeInfo for a given course offering type key.

Parameters:: courseOfferingTypeKey - the unique identifier for the type; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the type requested
Throws:: DoesNotExistException - courseOfferingTypeKey is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - courseOfferingTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCourseOfferingTypes

List<TypeInfo> getCourseOfferingTypes(ContextInfo contextInfo)
                                      throws InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

This method returns the valid course offering types.

Parameters:: contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid CourseOffering Types
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getInstructorTypesForCourseOfferingType

List<TypeInfo> getInstructorTypesForCourseOfferingType(String courseOfferingTypeKey,
                                                       ContextInfo contextInfo)
                                                       throws DoesNotExistException,
                                                              InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

This method returns the valid instructor (LPR) types for a CourseOffering type.

Parameters:: courseOfferingTypeKey - a unqiue identifier for a CourseOffering type; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid instructor types
Throws:: DoesNotExistException - deprecated; InvalidParameterException - contextInfo is not valid; MissingParameterException - courseOfferingTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCourseOffering

CourseOfferingInfo getCourseOffering(String courseOfferingId,
                                     ContextInfo contextInfo)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Retrieves a single CourseOffering by a CourseOffering Id.

Parameters:: courseOfferingId - the identifier for the CourseOffering to be retrieved; contextInfo - information containing the principalId and locale information about the caller of service operation
Throws:: DoesNotExistException - courseOfferingId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - courseOfferingId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCourseOfferingDisplay

CourseOfferingDisplayInfo getCourseOfferingDisplay(String courseOfferingId,
                                                   ContextInfo contextInfo)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Retrieves a single CourseOfferingDisplayInfo by a CourseOffering Id.

Parameters:: courseOfferingId - an identifier for a CourseOffering; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the CourseOfferingDisplay requested
Throws:: DoesNotExistException - courseOfferingId does not exist; InvalidParameterException - contextInfo is not valid; MissingParameterException - courseOfferingId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCourseOfferingsByIds

List<CourseOfferingInfo> getCourseOfferingsByIds(List<String> courseOfferingIds,
                                                 ContextInfo contextInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Retrieves a list of CourseOfferings from a list of CourseOffering Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Parameters:: courseOfferingIds - a list of CourseOffering identifiers; contextInfo - information containing the principalId and locale information about the caller of service operation
Throws:: DoesNotExistException - a courseOfferingId in the list is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - courseOfferingIds, an Id in the courseOfferingIds, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCourseOfferingDisplaysByIds

List<CourseOfferingDisplayInfo> getCourseOfferingDisplaysByIds(List<String> courseOfferingIds,
                                                               ContextInfo contextInfo)
                                                               throws DoesNotExistException,
                                                                      InvalidParameterException,
                                                                      MissingParameterException,
                                                                      OperationFailedException,
                                                                      PermissionDeniedException

Retrieve a list of CourseOfferingDisplays corresponding to a list of CourseOfferingIds. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Parameters:: courseOfferingIds - a list of CourseOffering identifiers; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CourseOfferingDisplays
Throws:: DoesNotExistException - a courseOfferingId in the list not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - courseOfferingIds, an Id in courseOfferingIds, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCourseOfferingIdsByType

List<String> getCourseOfferingIdsByType(String courseOfferingTypeKey,
                                        ContextInfo contextInfo)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Retrieve a list of CourseOffering Ids by CourseOffering Type.

Parameters:: courseOfferingTypeKey - the identifier for a CourseOffering Type; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CourseOffering identifiers matching courseOfferingTypeKey or an empty list if none found
Throws:: DoesNotExistException - deprecated; InvalidParameterException - contextInfo is not valid; MissingParameterException - courseOfferingTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCourseOfferingsByCourse

List<CourseOfferingInfo> getCourseOfferingsByCourse(String courseId,
                                                    ContextInfo contextInfo)
                                                    throws DoesNotExistException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Retrieve CourseOfferings by canonical Course Id across all Terms.

Parameters:: courseId - the identifier for a Course; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CourseOfferings of the given Course or an empty list if none found
Throws:: DoesNotExistException - courseId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - courseId orcontextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCourseOfferingsByCourseAndTerm

List<CourseOfferingInfo> getCourseOfferingsByCourseAndTerm(String courseId,
                                                           String termId,
                                                           ContextInfo contextInfo)
                                                           throws DoesNotExistException,
                                                                  InvalidParameterException,
                                                                  MissingParameterException,
                                                                  OperationFailedException,
                                                                  PermissionDeniedException

Retrieve a list of CourseOfferings by canonical Course Id and Term. There may be more than one CourseOffering for a Course in a single Term.

Parameters:: courseId - the identifier for a Course; termId - the identifier for a Term; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CourseOfferings of the given Course offered in the given Term or an empty list if none found
Throws:: DoesNotExistException - courseId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - courseId, termId, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occured

getCourseOfferingIdsByTerm

List<String> getCourseOfferingIdsByTerm(String termId,
                                        Boolean useIncludedTerm,
                                        ContextInfo contextInfo)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Retrieves a list of CourseOffering Ids for CourseOfferings offered in a given term. If useIncludedTerms is true, then include any CourseOfferings offered within child Terms of the given Term.

Parameters:: termId - the identifier for a Term; useIncludedTerm - true to include CourseOfferings of child Terms of the given Term, false to include only CourseOfferings offered in the given Term; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the list of CourseOffering Ids offered in the given Term or an empty list if none found
Throws:: DoesNotExistException - deprecated; InvalidParameterException - contextInfo is not valid; MissingParameterException - termId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCourseOfferingIdsByTermAndSubjectArea

List<String> getCourseOfferingIdsByTermAndSubjectArea(String termId,
                                                      String subjectArea,
                                                      ContextInfo contextInfo)
                                                      throws DoesNotExistException,
                                                             InvalidParameterException,
                                                             MissingParameterException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Retrieve a list of CourseOffering Ids for CourseOfferings of a given subject area offered in the given Term.

A CourseOffering will have an official and "other" subject areas> CourseOfferrings with either official or other subject area that match are returned.

Parameters:: termId - the identifier for a Term; subjectArea - a subject area; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CourseOffering Ids for CourseOfferings matching the give subject area and offered in the given Term or an empty list if none found
Throws:: DoesNotExistException - deprecated; InvalidParameterException - contextInfo is not valid; MissingParameterException - termId, subjectArea, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCourseOfferingsByTermAndInstructor

List<CourseOfferingInfo> getCourseOfferingsByTermAndInstructor(String termId,
                                                               String instructorId,
                                                               ContextInfo contextInfo)
                                                               throws DoesNotExistException,
                                                                      InvalidParameterException,
                                                                      MissingParameterException,
                                                                      OperationFailedException,
                                                                      PermissionDeniedException

Retrieves a list of CourseOfferings for a given Term and Instructor.

Parameters:: termId - the identifier for a Term; instructorId - the Person Id for an instructor; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CourseOfferings for the given Term and instructor or an empty list if none found
Throws:: DoesNotExistException - deprecated; InvalidParameterException - contextInfo is not valid; MissingParameterException - termId, instructorId, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCourseOfferingIdsByTermAndUnitsContentOwner

List<String> getCourseOfferingIdsByTermAndUnitsContentOwner(String termId,
                                                            String unitsContentOwnerId,
                                                            ContextInfo contextInfo)
                                                            throws DoesNotExistException,
                                                                   InvalidParameterException,
                                                                   MissingParameterException,
                                                                   OperationFailedException,
                                                                   PermissionDeniedException

Retrieves a list of CourseOffering Ids for CourseOfferings offered in a given Term by a units content owner.

Parameters:: termId - the identifier for a Term; unitsContentOwnerId - the Org Id of the units content owner; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CourseOffering Ids for CourseOfferings offered in the given Term by the given Org
Throws:: DoesNotExistException - deprecated; InvalidParameterException - contextInfo is not valid; MissingParameterException - termId, unisContentOwnerId, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForCourseOfferingIds

List<String> searchForCourseOfferingIds(QueryByCriteria criteria,
                                        ContextInfo contextInfo)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Searches for CourseOfferings that meet the given search criteria.

Parameters:: criteria - the search criteria; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CourseOffering Ids matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForCourseOfferings

List<CourseOfferingInfo> searchForCourseOfferings(QueryByCriteria criteria,
                                                  ContextInfo contextInfo)
                                                  throws InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Searches for CourseOfferings that meet the given search criteria.

Parameters:: criteria - the search criteria; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CourseOfferings matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getValidCanonicalCourseToCourseOfferingOptionKeys

List<String> getValidCanonicalCourseToCourseOfferingOptionKeys(ContextInfo contextInfo)
                                                               throws InvalidParameterException,
                                                                      MissingParameterException,
                                                                      OperationFailedException,
                                                                      PermissionDeniedException,
                                                                      ReadOnlyException

Get the valid options that can be specified to control canonical Course to CourseOffering operations.

This can happen in several situations: (1) when creating a CourseOffering from scratch that copies data from the canonical Course

(2) when a Course is rolled over and the "use canonical" option is specified in a rollover

(3) when a CourseOffering is explicitly asked to be updated based on the canonical Course

(4) when a course offering is explicitly asked to be validated against the canonical Course

These may identify fields to be copied or not copied or special checks or comparisons to be made, such as comparing that the credits of the course are consistent with the specified classroom hours.

TODO: The exact types that can be specified here have not yet been defined

Parameters:: contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: list of option keys used to to indicate the options to be used when copying data
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred; ReadOnlyException

getValidRolloverOptionKeys

List<String> getValidRolloverOptionKeys(ContextInfo contextInfo)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               ReadOnlyException

Get the valid rollover option keys.

This is the list of option keys supported by the rollover operation. Keys released with kuali student can be found here: https://wiki.kuali.org/display/STUDENT/Course+Offering+Set+Types+and+States#CourseOfferingSetTypesandStates-RolloverOptionKeys

Parameters:: contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of option keys
Throws:: InvalidParameterException - contextInfo is not valid; MissingParameterException - contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred; ReadOnlyException

validateCourseOffering

List<ValidationResultInfo> validateCourseOffering(String validationTypeKey,
                                                  CourseOfferingInfo courseOfferingInfo,
                                                  ContextInfo contextInfo)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Validates a CourseOffering. Depending on the value of validationType, this validation could be limited to tests on just the current CourseOffering and its directly contained sub-objects or expanded to perform all tests related to this CourseOffering. If an identifier is present for the CourseOffering (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the CourseOffering can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the object with the given data can be created.

Parameters:: validationTypeKey - the identifier for the validation Type; courseOfferingInfo - the CourseOffering to be validated; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of validation results or an empty list if validation succeeded
Throws:: DoesNotExistException - validationTypeKey or courseOfferingTypeKey is not found; InvalidParameterException - courseOfferingInfo or contextInfo is not valid; MissingParameterException - validationTypeKey, courseOfferingTypeKey, courseOfferingInfo, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

createCourseOffering

CourseOfferingInfo createCourseOffering(String courseId,
                                        String termId,
                                        String courseOfferingTypeKey,
                                        CourseOfferingInfo courseOfferingInfo,
                                        List<String> optionKeys,
                                        ContextInfo context)
                                        throws DoesNotExistException,
                                               DataValidationErrorException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               ReadOnlyException

Creates a new course offering from a canonical course.

Fields in course offering will be initialized with data from the canonical.

Parameters:: courseId - Canonical course Id of courseOffering Id that the ActivityOffering will belong to; termId - Unique key of the term in which the course is being offered course offering; optionKeys - options to use when copying data from the canonical; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: newly created CourseOfferingInfo
Throws:: DoesNotExistException - courseId not found; DataValidationErrorException - One or more values invalid for this operation; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; ReadOnlyException

rolloverCourseOffering

SocRolloverResultItemInfo rolloverCourseOffering(String sourceCourseOfferingId,
                                                 String targetTermId,
                                                 List<String> optionKeys,
                                                 ContextInfo context)
                                                 throws AlreadyExistsException,
                                                        DoesNotExistException,
                                                        DataValidationErrorException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException,
                                                        ReadOnlyException

Creates a new course offering based on the source course offering.

Fields in course offering will be initialized with data from the source course offering. .

Specified by:: rolloverCourseOffering in interface CourseOfferingServiceBusinessLogic

Parameters:: sourceCourseOfferingId - The id of the course offering to be rolled over.; targetTermId - Unique key of the term in which the course is rolled over into; optionKeys - keys that control optional processing; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: newly created CourseOfferingInfo
Throws:: DoesNotExistException - sourceCoId not found; AlreadyExistsException - if the course offering already exists in the target term and skip if already exists option is specified; DataValidationErrorException - data in system is not valid or not valid for an option key specified; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; ReadOnlyException

updateCourseOffering

CourseOfferingInfo updateCourseOffering(String courseOfferingId,
                                        CourseOfferingInfo courseOfferingInfo,
                                        ContextInfo context)
                                        throws DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               ReadOnlyException,
                                               VersionMismatchException

Updates an existing CourseOffering.

Parameters:: courseOfferingId - Id of CourseOffering to be updated; courseOfferingInfo - Details of updates to the CourseOffering; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: updated CourseOffering
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - the CourseOffering does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version.; ReadOnlyException

updateCourseOfferingState

StatusInfo updateCourseOfferingState(String courseOfferingId,
                                     String nextStateKey,
                                     ContextInfo contextInfo)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Updates the state of an existing CourseOffering into another state provided that it is valid to do so.

Parameters:: courseOfferingId - Id of the CourseOffering to be updated.; nextStateKey - The State Key into which the identified courseOffering will be placed if the operation succeeds.; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - the identified CourseOffering does not exist; InvalidParameterException - the contextInfo object is invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

updateCourseOfferingFromCanonical

CourseOfferingInfo updateCourseOfferingFromCanonical(String courseOfferingId,
                                                     List<String> optionKeys,
                                                     ContextInfo context)
                                                     throws DataValidationErrorException,
                                                            DoesNotExistException,
                                                            InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException,
                                                            PermissionDeniedException,
                                                            VersionMismatchException

Updates an existing CourseOffering from its canonical. This should reinitialize and overwrite any changes to the course offering that were made since its creation with the defaults from the canonical course

Specified by:: updateCourseOfferingFromCanonical in interface CourseOfferingServiceBusinessLogic

Parameters:: courseOfferingId - Id of CourseOffering to be updated; optionKeys - options to use when copying data from the canonical; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: updated CourseOffering
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - the CourseOffering does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version.

deleteCourseOffering

StatusInfo deleteCourseOffering(String courseOfferingId,
                                ContextInfo context)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException,
                                       DependentObjectsExistException

Deletes an existing CourseOffering.

Parameters:: courseOfferingId - the Id of the ActivityOffering to be deleted; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - the CourseOffering does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; DependentObjectsExistException - When one or more Format Offering, Activity Offering, Registration Group or Seat Pool Definition exist for course offering.

deleteCourseOfferingCascaded

StatusInfo deleteCourseOfferingCascaded(String courseOfferingId,
                                        ContextInfo context)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Deletes an existing CourseOffering cascaded style. Deleting a course offering cascaded style would also delete all the format offering, activity offerings, registration groups and seat pool definitions within it. Cross listed course offerings should also be deleted along with passed in courseOfferingId.

Parameters:: courseOfferingId - the Id of the ActivityOffering to be deleted; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - the CourseOffering does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateCourseOfferingFromCanonical

List<ValidationResultInfo> validateCourseOfferingFromCanonical(CourseOfferingInfo courseOfferingInfo,
                                                               List<String> optionKeys,
                                                               ContextInfo context)
                                                               throws DoesNotExistException,
                                                                      InvalidParameterException,
                                                                      MissingParameterException,
                                                                      OperationFailedException,
                                                                      PermissionDeniedException

Validates / Compares a course offering against it's canonical course.

Specified by:: validateCourseOfferingFromCanonical in interface CourseOfferingServiceBusinessLogic

Parameters:: courseOfferingInfo - the course offering information to be tested.; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the results from performing the validation
Throws:: DoesNotExistException - if the course associated with the course offering does not exist; InvalidParameterException - if a parameter is invalid; MissingParameterException - if a parameter is missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getFormatOffering

FormatOfferingInfo getFormatOffering(String formatOfferingId,
                                     ContextInfo context)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets an format offering based on Id.

Parameters:: formatOfferingId - The Format Offering identifier; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the FormatOffering identified by the identifier
Throws:: DoesNotExistException - The Format Offering doesn't exist; InvalidParameterException - Invalid formatOfferingId; MissingParameterException - Missing formatOfferingId; OperationFailedException - unable to complete request; PermissionDeniedException

getFormatOfferingsByCourseOffering

List<FormatOfferingInfo> getFormatOfferingsByCourseOffering(String courseOfferingId,
                                                            ContextInfo context)
                                                            throws DoesNotExistException,
                                                                   InvalidParameterException,
                                                                   MissingParameterException,
                                                                   OperationFailedException,
                                                                   PermissionDeniedException

Gets a list of format offering by a course offering id they belong to.

Parameters:: courseOfferingId - Course offering identifier; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: a list of FormatOffering by course offering
Throws:: DoesNotExistException - The course offering doesn't exist; InvalidParameterException - Invalid course offering id; MissingParameterException - Missing course offering id; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

createFormatOffering

FormatOfferingInfo createFormatOffering(String courseOfferingId,
                                        String formatId,
                                        String formatOfferingType,
                                        FormatOfferingInfo formatOfferingInfo,
                                        ContextInfo context)
                                        throws DoesNotExistException,
                                               DataValidationErrorException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               ReadOnlyException

Creates an Format Offering for a course offering

Parameters:: courseOfferingId - Course offering that the Format Offering belongs to; formatId - the identifier for the FormatOffering; formatOfferingType - the type key of the Format Offering template; formatOfferingInfo - The Format Offering info object
Returns:: the information about the FormatOffering created
Throws:: DataValidationErrorException; DoesNotExistException - if courseOfferingId or formatId does not exist for the course in the course offering; InvalidParameterException - Invalid course offering id; MissingParameterException - Missing course offering id, formatOfferingTemplate or formatOfferingType; OperationFailedException - unable to complete request; PermissionDeniedException; ReadOnlyException

updateFormatOffering

FormatOfferingInfo updateFormatOffering(String formatOfferingId,
                                        FormatOfferingInfo formatOfferingInfo,
                                        ContextInfo context)
                                        throws DataValidationErrorException,
                                               DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               ReadOnlyException,
                                               VersionMismatchException

Update a Format Offering

Parameters:: formatOfferingId - The Id formatOffering to be updated; formatOfferingInfo - The new formatOffering Info; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the updated information about the FormatOffering updated.
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - The formatOfferingId doesn't exist; InvalidParameterException - Invalid formatOfferingId or formatOffering; MissingParameterException - Missing formatOffering or formatOfferingId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - stale version being updated; ReadOnlyException

updateFormatOfferingState

StatusInfo updateFormatOfferingState(String formatOfferingId,
                                     String nextStateKey,
                                     ContextInfo contextInfo)
                                     throws DoesNotExistException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Updates the state of an existing FormatOffering to another state provided that it is valid to do so.

Parameters:: formatOfferingId - Id of the FormatOffering to be updated.; nextStateKey - The State Key into which the identified FormatOffering will be placed if the operation succeeds.; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - the identified FormatOffering does not exist; InvalidParameterException - the contextInfo object is invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateFormatOffering

List<ValidationResultInfo> validateFormatOffering(String validationType,
                                                  FormatOfferingInfo formatOfferingInfo,
                                                  ContextInfo context)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Validates a format offering. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object.

Parameters:: validationType - Identifier of the extent of validation; formatOfferingInfo - the format offering information to be tested.; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the results from performing the validation
Throws:: DoesNotExistException - validationTypeKey not found; InvalidParameterException - invalid validationTypeKey, formatOfferingInfo; MissingParameterException - missing validationTypeKey, formatOfferingInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

deleteFormatOffering

StatusInfo deleteFormatOffering(String formatOfferingId,
                                ContextInfo context)
                                throws DoesNotExistException,
                                       InvalidParameterException,
                                       MissingParameterException,
                                       OperationFailedException,
                                       PermissionDeniedException,
                                       DependentObjectsExistException

Deletes an Format Offering

Parameters:: formatOfferingId - The Id formatOffering to be deleted; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - The formatOfferingId doesn't exist; InvalidParameterException - Invalid formatOfferingId; MissingParameterException - Missing formatOfferingId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; DependentObjectsExistException - When one or more Activity Offering, Registration Group or Seat Pool Definition exist for the format offering.

deleteFormatOfferingCascaded

StatusInfo deleteFormatOfferingCascaded(String formatOfferingId,
                                        ContextInfo context)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Deletes an Format Offering with dependent Activity Offering and Registration group

Parameters:: formatOfferingId - The Id formatOffering to be deleted; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the status of the operation (success/fail)
Throws:: DoesNotExistException - The formatOfferingId doesn't exist; InvalidParameterException - Invalid formatOfferingId; MissingParameterException - Missing formatOfferingId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

searchForFormatOfferingIds

List<String> searchForFormatOfferingIds(QueryByCriteria criteria,
                                        ContextInfo contextInfo)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Searches for FormatOfferings that meet the given search criteria.

Parameters:: criteria - the search criteria; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CourseOffering Ids matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForFormatOfferings

List<FormatOfferingInfo> searchForFormatOfferings(QueryByCriteria criteria,
                                                  ContextInfo contextInfo)
                                                  throws InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Searches for FormatOfferings that meet the given search criteria.

Parameters:: criteria - the search criteria; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CourseOfferings matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getActivityOfferingType

TypeInfo getActivityOfferingType(String activityOfferingTypeKey,
                                 ContextInfo context)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

This method returns the TypeInfo for a given activity offering type key.

Parameters:: activityOfferingTypeKey - Key of the type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: Information about the Type
Throws:: DoesNotExistException - activityOfferingTypeKey not found; InvalidParameterException - invalid activityOfferingTypeKey; MissingParameterException - missing activityOfferingTypeKey; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getActivityOfferingTypes

List<TypeInfo> getActivityOfferingTypes(ContextInfo context)
                                        throws InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

This method returns the valid activity offering types.

Parameters:: context - Context information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid activity offering Types
Throws:: InvalidParameterException - invalid context; MissingParameterException - missing context; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getActivityOfferingTypesForActivityType

List<TypeInfo> getActivityOfferingTypesForActivityType(String activityTypeKey,
                                                       ContextInfo context)
                                                       throws DoesNotExistException,
                                                              InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

This method returns the valid activity offering types for a given canonical activity type

Parameters:: activityTypeKey - Key of the canonical activity type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid activity offering Types
Throws:: DoesNotExistException - activityOfferingTypeKey not found; InvalidParameterException - invalid context; MissingParameterException - missing context; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getInstructorTypesForActivityOfferingType

List<TypeInfo> getInstructorTypesForActivityOfferingType(String activityOfferingTypeKey,
                                                         ContextInfo context)
                                                         throws DoesNotExistException,
                                                                InvalidParameterException,
                                                                MissingParameterException,
                                                                OperationFailedException,
                                                                PermissionDeniedException

This method returns the valid instructor (lpr) types for an activity offering type.

Parameters:: activityOfferingTypeKey - a key for an activity offering type; context - information containing the principalId and locale information about the caller of service operation
Returns:: a list of valid instructor types
Throws:: DoesNotExistException - activityOfferingTypeKey not found; InvalidParameterException - context is not valud; MissingParameterException - activityOfferingTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getActivityOffering

ActivityOfferingInfo getActivityOffering(String activityOfferingId,
                                         ContextInfo context)
                                         throws DoesNotExistException,
                                                InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException,
                                                PermissionDeniedException

Retrieve information about an ActivityOffering

Parameters:: activityOfferingId - Unique Id of the ActivityOffering; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: ActivityOffering associated with the passed in Id
Throws:: DoesNotExistException - ActivityOffering with activityOfferingId not found; InvalidParameterException - invalid activityOfferingId; MissingParameterException - missing activityOfferingId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getActivityOfferingDisplay

ActivityOfferingDisplayInfo getActivityOfferingDisplay(String activityOfferingId,
                                                       ContextInfo contextInfo)
                                                       throws DoesNotExistException,
                                                              InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

Retrieves a single ActivityOfferingDisplay by a ActivityOffering Id.

Parameters:: activityOfferingId - an identifier for an ActivityOffering; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the ActivityOfferingDisplay requested
Throws:: DoesNotExistException - activityOfferingId does not exist; InvalidParameterException - contextInfo is not valid; MissingParameterException - activityOfferingId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getActivityOfferingsByIds

List<ActivityOfferingInfo> getActivityOfferingsByIds(List<String> activityOfferingIds,
                                                     ContextInfo context)
                                                     throws DoesNotExistException,
                                                            InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Retrieves a list of activity offerings by id list.

Parameters:: activityOfferingIds - List of unique Ids of ActivityCourseOffering; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: Activity offering list
Throws:: DoesNotExistException - activityOfferingId in the list not found; InvalidParameterException - invalid activityOfferingIds; MissingParameterException - missing activityOfferingIds; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getActivityOfferingDisplaysByIds

List<ActivityOfferingDisplayInfo> getActivityOfferingDisplaysByIds(List<String> activityOfferingIds,
                                                                   ContextInfo contextInfo)
                                                                   throws DoesNotExistException,
                                                                          InvalidParameterException,
                                                                          MissingParameterException,
                                                                          OperationFailedException,
                                                                          PermissionDeniedException

Retrieve a list of ActivitAOfferingAdminDisplays corresponding to a list of ActivityOffering Ids. The returned list may be in any order and if duplicate Ids are supplied, a unique set may or may not be returned.

Parameters:: activityOfferingIds - a list of ActivityOffering identifiers; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of ActivityOfferingDisplays
Throws:: DoesNotExistException - an activityOfferingId in the list not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - activityOfferingIds, an Id in activityOfferingId, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getActivityOfferingsByCourseOffering

List<ActivityOfferingInfo> getActivityOfferingsByCourseOffering(String courseOfferingId,
                                                                ContextInfo context)
                                                                throws DoesNotExistException,
                                                                       InvalidParameterException,
                                                                       MissingParameterException,
                                                                       OperationFailedException,
                                                                       PermissionDeniedException

Retrieves a list of ActivityOffering records that belongs to a CourseOffering.

Parameters:: courseOfferingId - Unique Id of the CourseOffering; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of ActivityOffering
Throws:: DoesNotExistException - courseOfferingId not found; InvalidParameterException - invalid courseOfferingId; MissingParameterException - missing courseOfferingId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getActivityOfferingDisplaysForCourseOffering

List<ActivityOfferingDisplayInfo> getActivityOfferingDisplaysForCourseOffering(String courseOfferingId,
                                                                               ContextInfo contextInfo)
                                                                               throws DoesNotExistException,
                                                                                      InvalidParameterException,
                                                                                      MissingParameterException,
                                                                                      OperationFailedException,
                                                                                      PermissionDeniedException

Retrieve a list of ActivityOfferingDisplays corresponding to a CourseOffering Id. Activity Offerings for all FormatOfferings within the given CourseOffering are used to assemble this administrative view.

Parameters:: courseOfferingId - the identifier for a CourseOffering; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of ActivityOfferingDisplayInfos
Throws:: DoesNotExistException - courseOfferingId is not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - courseOfferingId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getActivityOfferingsByCluster

List<ActivityOfferingInfo> getActivityOfferingsByCluster(String activityOfferingClusterId,
                                                         ContextInfo contextInfo)
                                                         throws DoesNotExistException,
                                                                InvalidParameterException,
                                                                MissingParameterException,
                                                                OperationFailedException,
                                                                PermissionDeniedException

Retrieves a list of ActivityOffering records that belongs to an ActivityOfferingCluster.

Parameters:: activityOfferingClusterId - Unique Id of the ActivityOfferingCluster; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of ActivityOfferings
Throws:: DoesNotExistException - activityOfferingClusterId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - activityOfferingClusterId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getActivityOfferingsByFormatOffering

List<ActivityOfferingInfo> getActivityOfferingsByFormatOffering(String formatOfferingId,
                                                                ContextInfo context)
                                                                throws DoesNotExistException,
                                                                       InvalidParameterException,
                                                                       MissingParameterException,
                                                                       OperationFailedException,
                                                                       PermissionDeniedException

Retrieves a list of ActivityOffering records that belongs to a CourseOffering.

Parameters:: formatOfferingId - Unique Id of the CourseOffering; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of ActivityOffering
Throws:: DoesNotExistException - formatOfferingId not found; InvalidParameterException - invalid courseOfferingId; MissingParameterException - missing courseOfferingId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getActivityOfferingsWithoutClusterByFormatOffering

List<ActivityOfferingInfo> getActivityOfferingsWithoutClusterByFormatOffering(String formatOfferingId,
                                                                              ContextInfo contextInfo)
                                                                              throws DoesNotExistException,
                                                                                     InvalidParameterException,
                                                                                     MissingParameterException,
                                                                                     OperationFailedException,
                                                                                     PermissionDeniedException

Retrieves a list of ActivityOffering records that belongs to a FormatOffering that are not associated with a cluster

Parameters:: formatOfferingId - Id of the CourseOffering; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of ActivityOfferings without cluster association
Throws:: DoesNotExistException - formatOfferingId not found; InvalidParameterException - invalid formatOfferingId; MissingParameterException - formatOfferingId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getActivityOfferingsByFormatOfferingWithoutRegGroup

List<ActivityOfferingInfo> getActivityOfferingsByFormatOfferingWithoutRegGroup(String formatOfferingId,
                                                                               ContextInfo context)
                                                                               throws DoesNotExistException,
                                                                                      InvalidParameterException,
                                                                                      MissingParameterException,
                                                                                      OperationFailedException,
                                                                                      PermissionDeniedException

Retrieves the Activity Offerings by actvity offering template id which don't have registration groups created for them yet.

Parameters:: formatOfferingId - The Id of the format offering; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of ActivityOfferings by format offering that don't have reg groups yet.
Throws:: DoesNotExistException - The formatOfferingId does not exist; InvalidParameterException - Invalid formatOfferingId; MissingParameterException - Missing formatOfferingId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

searchForActivityOfferingIds

List<String> searchForActivityOfferingIds(QueryByCriteria criteria,
                                          ContextInfo contextInfo)
                                          throws InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Searches for ActivityOfferings that meet the given search criteria.

Parameters:: criteria - the search criteria; contextInfo - context information containing the principalId and locale information about the caller of service operation
Returns:: a list of ActivityOffering Ids matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForActivityOfferings

List<ActivityOfferingInfo> searchForActivityOfferings(QueryByCriteria criteria,
                                                      ContextInfo contextInfo)
                                                      throws InvalidParameterException,
                                                             MissingParameterException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Searches for ActivityOfferings that meet the given search criteria.

Parameters:: criteria - the search criteria; contextInfo - context information containing the principalId and locale information about the caller of service operation
Returns:: a list of ActivityOfferings matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

createActivityOffering

ActivityOfferingInfo createActivityOffering(String formatOfferingId,
                                            String activityId,
                                            String activityOfferingTypeKey,
                                            ActivityOfferingInfo activityOfferingInfo,
                                            ContextInfo context)
                                            throws DoesNotExistException,
                                                   DataValidationErrorException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException,
                                                   ReadOnlyException

Creates a new Activity Offering for a format offering.

Parameters:: formatOfferingId - courseOffering that the ActivityOffering belongs to; activityId - the canonical activity this is associated with; activityOfferingInfo - Details of the ActivityOffering to be created; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: newly created ActivityOffering
Throws:: DoesNotExistException - if the format offering does not exist; DataValidationErrorException - One or more values invalid for this operation; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; ReadOnlyException

copyActivityOffering

ActivityOfferingInfo copyActivityOffering(String activityOfferingId,
                                          ContextInfo context)
                                          throws DoesNotExistException,
                                                 DataValidationErrorException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException,
                                                 ReadOnlyException

Creates a new Activity Offering from another activity offering, the generated activity offering is the same format offering, type and canonical activity as the source activity fofering

Parameters:: activityOfferingId - the activity offering used as source; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: newly created ActivityOffering
Throws:: DoesNotExistException - if the format offering does not exist; DataValidationErrorException - One or more values invalid for this operation; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; ReadOnlyException

generateActivityOfferings

List<ActivityOfferingInfo> generateActivityOfferings(String formatOfferingId,
                                                     String activityOfferingType,
                                                     Integer quantity,
                                                     ContextInfo context)
                                                     throws InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Generates activity offerings based on a format offering.

Parameters:: formatOfferingId - the identifier for the FormatOffering.; activityOfferingType - a key for an activity offering type; quantity - quantity of the activity offerings of that type; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: activity offerings based on format offering
Throws:: InvalidParameterException - formatOfferingId invalid; MissingParameterException - Missing formatOfferingId in the input; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

updateActivityOffering

ActivityOfferingInfo updateActivityOffering(String activityOfferingId,
                                            ActivityOfferingInfo activityOfferingInfo,
                                            ContextInfo context)
                                            throws DataValidationErrorException,
                                                   DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException,
                                                   VersionMismatchException,
                                                   ReadOnlyException

Updates an existing ActivityOffering.

Parameters:: activityOfferingId - Id of ActivitOffering to be updated; activityOfferingInfo - Details of updates to the ActivityOffering; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: updated ActivityOffering
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - the ActivityOffering does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version.; ReadOnlyException

updateActivityOfferingState

StatusInfo updateActivityOfferingState(String activityOfferingId,
                                       String nextStateKey,
                                       ContextInfo contextInfo)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Updates the state of an existing ActivityOffering to another state provided that it is valid to do so.

Parameters:: activityOfferingId - Id of the ActivityOffering to be updated.; nextStateKey - The State Key into which the identified ActivityOffering will be placed if the operation succeeds.; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - the identified ActivityOffering does not exist; InvalidParameterException - the contextInfo object is invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

deleteActivityOffering

StatusInfo deleteActivityOffering(String activityOfferingId,
                                  ContextInfo context)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         DependentObjectsExistException

Deletes an existing ActivityOffering. Deleting an activity will also delete any relation it has with course offerings. An activity offering cannot be deleted if it is being referenced in a registration group and will be DependentObjectsExistException. The registration group needs to be updated to drop the activity offering references before the activity offering can be deleted. The difference in behavior is because of the relationship nature is different between course offering to activity offering and registration group to activity offering. Course offering contains activity offering, so deleting an activity offering can be logically interpreted as removing the containing relationship. Registration group only references existing activity offerings and hence deleting an activity offering will leave the registration group in inconsistent state and updating registration group automatically will lead to unintended side effects.

Parameters:: activityOfferingId - the Id of the ActivityOffering to be deleted; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - the identified ActivityOffering does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; DependentObjectsExistException - when one or more Registration Group and/or Seat Pool Definitions dependencies exist.

deleteActivityOfferingCascaded

StatusInfo deleteActivityOfferingCascaded(String activityOfferingId,
                                          ContextInfo context)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Deletes an existing ActivityOffering cascaded style. Deleting an activity offering cascaded style would also delete all the registration groups and seat pools associated with it.

Parameters:: activityOfferingId - the Id of the ActivityOffering to be deleted; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - the identified Activity o does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

scheduleActivityOffering

StatusInfo scheduleActivityOffering(String activityOfferingId,
                                    ContextInfo contextInfo)
                                    throws DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException

Attempt to schedule a single Activity Offering using the Scheduling Service.

This is designed to be used for one-off scheduling of activity offerings created after the mass scheduling event.

The expectation is that this method is synchronous (i.e. it will block until the request is completed or fails).

We also assume that the underlying scheduling service call will not take an unbounded amount of time to solve but rather a quick one-off that will return in a short amount of time.

Parameters:: activityOfferingId - Id of the Activity Offering to be scheduled.; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the starting the scheduling process for the activityOffering (success, failed)
Throws:: DoesNotExistException - the identified activity offering does not exist.; InvalidParameterException - the contextInfo parameter object is invalid.; MissingParameterException - one or more of the method parameter's is missing.; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateActivityOffering

List<ValidationResultInfo> validateActivityOffering(String validationType,
                                                    ActivityOfferingInfo activityOfferingInfo,
                                                    ContextInfo context)
                                                    throws DoesNotExistException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Validates an activity offering. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the academic calendar and a record is found for that identifier, the validation checks if the academic calendar can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.

Parameters:: validationType - Identifier of the extent of validation; activityOfferingInfo - the activity offering information to be tested.; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: the results from performing the validation
Throws:: DoesNotExistException - validationTypeKey not found; InvalidParameterException - invalid validationTypeKey, academicCalendarInfo; MissingParameterException - missing validationTypeKey, academicCalendarInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

calculateInClassContactHoursForTerm

Float calculateInClassContactHoursForTerm(String activityOfferingId,
                                          ContextInfo context)
                                          throws DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

When/for how long does the offering meet in class during the term. Calculated by system based on meeting times and term length; may be validated against CLU.

Parameters:: activityOfferingId - the Id of the ActivityOffering to be used for contact hour calculation; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: in class contact hours for the term
Throws:: DoesNotExistException - the ActivityOffering with activityOfferingId does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

calculateOutofClassContactHoursForTerm

Float calculateOutofClassContactHoursForTerm(String activityOfferingId,
                                             ContextInfo context)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

When/for how long does the offering meet out of class during the term. Calculated by system based on meeting times and term length; may be validated against CLU.

Parameters:: activityOfferingId - the Id of the ActivityOffering to be used for contact hour calculation; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: out of class contact hours for the term
Throws:: DoesNotExistException - the ActivityOffering with activityOfferingId does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

calculateTotalContactHoursForTerm

Float calculateTotalContactHoursForTerm(String activityOfferingId,
                                        ContextInfo context)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

When/for how long does the offering meet in total during the term. Calculated by system based on meeting times and term length; may be validated against CLU.

Parameters:: activityOfferingId - the Id of the ActivityOffering to be used for contact hour calculation; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: total class contact hours for the term
Throws:: DoesNotExistException - the ActivityOffering with activityOfferingId does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getRegistrationGroup

RegistrationGroupInfo getRegistrationGroup(String registrationGroupId,
                                           ContextInfo context)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Retrieve a RegistrationGroup based on id

Parameters:: registrationGroupId - Unique Id of the RegistrationGroup; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: RegistrationGroup associated with the passed in Id
Throws:: DoesNotExistException - registrationGroupId not found; InvalidParameterException - invalid registrationGroupId; MissingParameterException - missing registrationGroupId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getRegistrationGroupsByIds

List<RegistrationGroupInfo> getRegistrationGroupsByIds(List<String> registrationGroupIds,
                                                       ContextInfo context)
                                                       throws DoesNotExistException,
                                                              InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

Retrieves a list of registration group by id list.

Parameters:: registrationGroupIds - List of unique Ids of RegistrationGroup; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: Registration Group list
Throws:: DoesNotExistException - registrationGroupId in the list not found; InvalidParameterException - invalid registrationGroupIds; MissingParameterException - missing registrationGroupIds; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getRegistrationGroupsForCourseOffering

List<RegistrationGroupInfo> getRegistrationGroupsForCourseOffering(String courseOfferingId,
                                                                   ContextInfo context)
                                                                   throws DoesNotExistException,
                                                                          InvalidParameterException,
                                                                          MissingParameterException,
                                                                          OperationFailedException,
                                                                          PermissionDeniedException

Retrieves a list of RegistrationGroup records that belongs to a CourseOffering

Parameters:: courseOfferingId - Unique Id of the CourseOffering; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of RegistrationGroups
Throws:: DoesNotExistException - courseOfferingId not found; InvalidParameterException - invalid courseOfferingId; MissingParameterException - missing courseOfferingId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getRegistrationGroupsWithActivityOfferings

List<RegistrationGroupInfo> getRegistrationGroupsWithActivityOfferings(List<String> activityOfferingIds,
                                                                       ContextInfo context)
                                                                       throws DoesNotExistException,
                                                                              InvalidParameterException,
                                                                              MissingParameterException,
                                                                              OperationFailedException,
                                                                              PermissionDeniedException

Retrieves a list of RegistrationGroup records that contain all the activity offerings in the input list.

Parameters:: activityOfferingIds - List of activityOffering Identifiers; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: a list of RegistrationGroup records that contain all the activity offerings in the input list.
Throws:: DoesNotExistException - One or more of the activityOfferingIds doesn't exist; InvalidParameterException - One or more invalid activityOfferingIds; MissingParameterException - Missing activityOfferingIds; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getRegistrationGroupsByFormatOffering

List<RegistrationGroupInfo> getRegistrationGroupsByFormatOffering(String formatOfferingId,
                                                                  ContextInfo context)
                                                                  throws DoesNotExistException,
                                                                         InvalidParameterException,
                                                                         MissingParameterException,
                                                                         OperationFailedException,
                                                                         PermissionDeniedException

Retrieves a list of RegistrationGroup records that belongs to a CourseOffering for a given canonical format type

Parameters:: formatOfferingId - Unique Id of the CourseOffering; context - information containing the principalId and locale information about the caller of service operation
Returns:: List of RegistrationGroups
Throws:: DoesNotExistException - courseOfferingId or formatTypeKey not found; InvalidParameterException - invalid courseOfferingId or formatTypeKey; MissingParameterException - missing courseOfferingId or formatTypeKey; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getRegistrationGroupsByActivityOfferingCluster

List<RegistrationGroupInfo> getRegistrationGroupsByActivityOfferingCluster(String activityOfferingClusterId,
                                                                           ContextInfo contextInfo)
                                                                           throws DoesNotExistException,
                                                                                  InvalidParameterException,
                                                                                  MissingParameterException,
                                                                                  OperationFailedException,
                                                                                  PermissionDeniedException

Retrieves a list of RegistrationGroup records that belongs to a specified ActivityOfferingCluster.

Parameters:: activityOfferingClusterId - Unique Id of the ActivityOfferingCluster; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: List of RegistrationGroups
Throws:: DoesNotExistException - No ActivityOfferingCluster exists for the specified activityOfferingClusterId.; InvalidParameterException - invalid contextInfo object; MissingParameterException - one or more method parameters are missing.; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

searchForRegistrationGroupIds

List<String> searchForRegistrationGroupIds(QueryByCriteria criteria,
                                           ContextInfo contextInfo)
                                           throws InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Searches for RegistrationGroups that meet the given search criteria.

Parameters:: criteria - the search criteria; contextInfo - context information containing the principalId and locale information about the caller of service operation
Returns:: a list of RegistrationGroup Ids matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForRegistrationGroups

List<RegistrationGroupInfo> searchForRegistrationGroups(QueryByCriteria criteria,
                                                        ContextInfo contextInfo)
                                                        throws InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Searches for RegistrationGroups that meet the given search criteria.

Parameters:: criteria - the search criteria; contextInfo - context information containing the principalId and locale information about the caller of service operation
Returns:: a list of RegistrationGroups matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

validateRegistrationGroup

List<ValidationResultInfo> validateRegistrationGroup(String validationType,
                                                     String activityOfferingClusterId,
                                                     String registrationGroupType,
                                                     RegistrationGroupInfo registrationGroupInfo,
                                                     ContextInfo contextInfo)
                                                     throws DoesNotExistException,
                                                            InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Validates a registration group. Depending on the value of validationType, this validation could be limited to tests on just the current object and its directly contained subobjects or expanded to perform all tests related to this object. If an identifier is present for the academic calendar and a record is found for that identifier, the validation checks if the academic calendar can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationType to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.

Parameters:: validationType - Identifier of the extent of validation; activityOfferingClusterId - Unique Id of the ActivityOfferingCluster; registrationGroupType - the identifier for the RegistrationGroup type; registrationGroupInfo - the registrationGroup information to be tested.; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: a list of validation results or an empty list if validation succeeded
Throws:: DoesNotExistException - validationTypeKey not found; InvalidParameterException - invalid validationTypeKey, academicCalendarInfo; MissingParameterException - missing validationTypeKey, academicCalendarInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

createRegistrationGroup

RegistrationGroupInfo createRegistrationGroup(String formatOfferingId,
                                              String activityOfferingClusterId,
                                              String registrationGroupType,
                                              RegistrationGroupInfo registrationGroupInfo,
                                              ContextInfo context)
                                              throws DoesNotExistException,
                                                     DataValidationErrorException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException,
                                                     ReadOnlyException

Creates a new Registration Group.

Parameters:: formatOfferingId - formatOfferingId that the RegistrationGroup is based on; activityOfferingClusterId - Unique Id of the ActivityOfferingCluster; registrationGroupType - the identifier for the RegistrationGroup type; registrationGroupInfo - Details of the RegistrationGroup to be created; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: newly created registrationGroup
Throws:: DoesNotExistException - courseOfferingId not found; DataValidationErrorException - One or more values invalid for this operation; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; ReadOnlyException

updateRegistrationGroup

RegistrationGroupInfo updateRegistrationGroup(String registrationGroupId,
                                              RegistrationGroupInfo registrationGroupInfo,
                                              ContextInfo context)
                                              throws DataValidationErrorException,
                                                     DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException,
                                                     ReadOnlyException,
                                                     VersionMismatchException

Updates an existing RegistrationGroup.

Parameters:: registrationGroupId - Id of RegistrationGroup to be updated; registrationGroupInfo - Details of updates to the RegistrationGroup; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: updated RegistrationGroup
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - the registrationGroupId does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version.; ReadOnlyException

updateRegistrationGroupState

StatusInfo updateRegistrationGroupState(String registrationGroupId,
                                        String nextStateKey,
                                        ContextInfo contextInfo)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Updates the state of an existing RegistrationGroup to another state provided that it is valid to do so.

Parameters:: registrationGroupId - Id of the RegistrationGroup to be updated.; nextStateKey - The State Key into which the identified RegistrationGroup will be placed if the operation succeeds.; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - the identified RegsitrationGroup does not exist; InvalidParameterException - the contextInfo object is invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

deleteRegistrationGroup

StatusInfo deleteRegistrationGroup(String registrationGroupId,
                                   ContextInfo context)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Deletes an existing Registration Group. Removes the relationship to the course offering and activity offering. The activity offerings are not automatically deleted

Parameters:: registrationGroupId - the Id of the RegistrationGroup to be deleted; context - Context information containing the principalId and locale information about the caller of service operation
Throws:: DoesNotExistException - the RegistrationGroup does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

deleteRegistrationGroupsByFormatOffering

StatusInfo deleteRegistrationGroupsByFormatOffering(String formatOfferingId,
                                                    ContextInfo context)
                                                    throws InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Deletes all Registration Groups for a Format Offering.

Parameters:: formatOfferingId - the Id of the FormatOffering; context - Context information containing the principalId and locale information about the caller of service operation
Throws:: InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

deleteGeneratedRegistrationGroupsByFormatOffering

StatusInfo deleteGeneratedRegistrationGroupsByFormatOffering(String formatOfferingId,
                                                             ContextInfo context)
                                                             throws InvalidParameterException,
                                                                    MissingParameterException,
                                                                    OperationFailedException,
                                                                    PermissionDeniedException

Deletes all generated Registration Groups for a Format Offering. A generated registration group is one whose isGenerated() flag is true.

Parameters:: formatOfferingId - the Id of the FormatOffering; context - Context information containing the principalId and locale information about the caller of service operation
Throws:: InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

deleteRegistrationGroupsForCluster

StatusInfo deleteRegistrationGroupsForCluster(String activityOfferingClusterId,
                                              ContextInfo contextInfo)
                                              throws InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Deletes all Registration Groups associated with an Activity Offering Cluster

Parameters:: activityOfferingClusterId - the Id of the FormatOffering; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: InvalidParameterException - invalid contextInfo; MissingParameterException - activityOfferingClusterId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure has occurred

verifyRegistrationGroup

List<ValidationResultInfo> verifyRegistrationGroup(String registrationGroupId,
                                                   ContextInfo contextInfo)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException

Verifies a Registration Group applying rules such as: (1) Reg Group has one of each AO type (2) AO's don't meet at the same time (if scheduling has already happened) (3) AO's are all offered at the same campus (4) AO's don't have conflicting seatpool/enrollment restrictions

Parameters:: registrationGroupId - the registrationGroup information to be tested.; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: a list of validation results or an empty list if validation succeeded
Throws:: DoesNotExistException - contextInfo not found; InvalidParameterException - invalid registrationGroupId or contextInfo; MissingParameterException - registrationGroupId or contextInfo is missing or null; OperationFailedException - unable to complete request

getActivityOfferingCluster

ActivityOfferingClusterInfo getActivityOfferingCluster(String activityOfferingClusterId,
                                                       ContextInfo contextInfo)
                                                       throws DoesNotExistException,
                                                              InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

Gets an Activity Offering Cluster based on the Identifier

Parameters:: activityOfferingClusterId - Identifier of the Activity Offering Cluster; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: ActivityOfferingCluster
Throws:: DoesNotExistException - activityOfferingClusterId does not exist; InvalidParameterException - Invalid contextInfo; MissingParameterException - activityOfferingClusterId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getActivityOfferingClustersByFormatOffering

List<ActivityOfferingClusterInfo> getActivityOfferingClustersByFormatOffering(String formatOfferingId,
                                                                              ContextInfo contextInfo)
                                                                              throws DoesNotExistException,
                                                                                     InvalidParameterException,
                                                                                     MissingParameterException,
                                                                                     OperationFailedException,
                                                                                     PermissionDeniedException

Retrieves a list of ActivityOfferingClusters associated with a FormatOffering

Parameters:: formatOfferingId - Id of the FormatOffering; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of ActivityOffering
Throws:: DoesNotExistException - courseOfferingId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - formatOfferingId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getActivityOfferingClustersIdsByFormatOffering

List<String> getActivityOfferingClustersIdsByFormatOffering(String formatOfferingId,
                                                            ContextInfo contextInfo)
                                                            throws DoesNotExistException,
                                                                   InvalidParameterException,
                                                                   MissingParameterException,
                                                                   OperationFailedException,
                                                                   PermissionDeniedException

Retrieves a list of ActivityOfferingCluster Id's associated with a FormatOffering

Parameters:: formatOfferingId - Id of the FormatOffering; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of ActivityOffering Id's
Throws:: DoesNotExistException - courseOfferingId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - formatOfferingId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

validateActivityOfferingCluster

List<ValidationResultInfo> validateActivityOfferingCluster(String validationTypeKey,
                                                           String formatOfferingId,
                                                           ActivityOfferingClusterInfo activityOfferingClusterInfo,
                                                           ContextInfo contextInfo)
                                                           throws DoesNotExistException,
                                                                  InvalidParameterException,
                                                                  MissingParameterException,
                                                                  OperationFailedException,
                                                                  PermissionDeniedException

Validates an Activity Offering Cluster. Depending on the value of validationTypeKey, this validation could be limited to tests on just the current object and its directly contained sub-objects or expanded to perform all tests related to this object. If an identifier is present for the academic calendar and a record is found for that identifier, the validation checks if the academic calendar can be shifted to the new values. If a record cannot be found for the identifier, it is assumed that the record does not exist and as such, the checks performed will be much shallower, typically mimicking those performed by setting the validationTypeKey to the current object. This is a slightly different pattern from the standard validation as the caller provides the identifier in the create statement instead of the server assigning an identifier.

Parameters:: validationTypeKey - Identifier of the extent of validation; formatOfferingId - Format Offering identifier; activityOfferingClusterInfo - the Activity Offering Cluster information to be validated.; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: the results from performing the validation
Throws:: DoesNotExistException - validationTypeKey or activityOfferingClusterTypeKey not found; InvalidParameterException - invalid activityOfferingClusterInfo or contextInfo; MissingParameterException - validationTypeKey, activityOfferingClusterTypeKey, activityOfferingClusterInfo or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

createActivityOfferingCluster

ActivityOfferingClusterInfo createActivityOfferingCluster(String formatOfferingId,
                                                          String activityOfferingClusterTypeKey,
                                                          ActivityOfferingClusterInfo activityOfferingClusterInfo,
                                                          ContextInfo contextInfo)
                                                          throws DataValidationErrorException,
                                                                 DoesNotExistException,
                                                                 InvalidParameterException,
                                                                 MissingParameterException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException,
                                                                 ReadOnlyException

Creates a new Activity Offering Cluster from the given Format Offering

Parameters:: formatOfferingId - Format Offering identifier; activityOfferingClusterTypeKey - Activity Offering Cluster type; activityOfferingClusterInfo - Details of the ActivityOfferingCluster to be created; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: newly created ActivityOfferingCluster
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - validationTypeKey or activityOfferingClusterTypeKey not found; InvalidParameterException - invalid activityOfferingClusterInfo or contextInfo; MissingParameterException - validationTypeKey, activityOfferingClusterTypeKey or activityOfferingClusterInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure has occurred; ReadOnlyException - an attempt at supplying information designated as read only

updateActivityOfferingCluster

ActivityOfferingClusterInfo updateActivityOfferingCluster(String formatOfferingId,
                                                          String activityOfferingClusterId,
                                                          ActivityOfferingClusterInfo activityOfferingClusterInfo,
                                                          ContextInfo contextInfo)
                                                          throws DataValidationErrorException,
                                                                 DoesNotExistException,
                                                                 InvalidParameterException,
                                                                 MissingParameterException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException,
                                                                 ReadOnlyException,
                                                                 VersionMismatchException

Updates an ActivityOfferingCluster based on the info object

Parameters:: formatOfferingId - Format Offering identifier; activityOfferingClusterId - Identifier of the Activity Offering Cluster; activityOfferingClusterInfo - ActivityOfferingCluster with new information; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: updated ActivityOfferingCluster
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - activityOfferingClusterId does not exist; InvalidParameterException - Invalid activityOfferingClusterInfo; MissingParameterException - activityOfferingClusterId or activityOfferingClusterInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure has occurred; ReadOnlyException - an attempt at supplying information designated as read only; VersionMismatchException - optimistic locking failure or the action was attempted on an out of date version

updateActivityOfferingClusterState

StatusInfo updateActivityOfferingClusterState(String activityOfferingClusterId,
                                              String nextStateKey,
                                              ContextInfo contextInfo)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Updates the state of an existing ActivityOfferingCluster to another state provided that it is valid to do so.

Parameters:: activityOfferingClusterId - Id of the ActivityOfferingCluster to be updated.; nextStateKey - The State Key into which the identified ActivityOfferingCluster will be placed if the operation succeeds.; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - the identified ActivityOfferingCluster does not exist; InvalidParameterException - the contextInfo object is invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

deleteActivityOfferingCluster

StatusInfo deleteActivityOfferingCluster(String activityOfferingClusterId,
                                         ContextInfo contextInfo)
                                         throws DoesNotExistException,
                                                InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException,
                                                PermissionDeniedException,
                                                DependentObjectsExistException

Deletes an activity offering cluster based on the identifier

Parameters:: activityOfferingClusterId - Identifier of the Activity Offering Cluster; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - activityOfferingClusterId does not exist; InvalidParameterException - Invalid contextInfo; MissingParameterException - activityOfferingClusterId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure has occurred; DependentObjectsExistException - Registration Groups exist for this cluster which prevents the delete from occuring.

deleteActivityOfferingClusterCascaded

StatusInfo deleteActivityOfferingClusterCascaded(String activityOfferingClusterId,
                                                 ContextInfo contextInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Deletes an existing ActivityOfferingCluster cascaded style. Deleting an activity offering cluster cascaded style would also delete all the registration groups associated with it.

Parameters:: activityOfferingClusterId - the Id of the ActivityOfferingCluster to be deleted; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - the identified Activity o does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

verifyActivityOfferingClusterForGeneration

AOClusterVerifyResultsInfo verifyActivityOfferingClusterForGeneration(String activityOfferingClusterId,
                                                                      ContextInfo contextInfo)
                                                                      throws DoesNotExistException,
                                                                             InvalidParameterException,
                                                                             MissingParameterException,
                                                                             OperationFailedException,
                                                                             PermissionDeniedException

Verifies an Activity Offering Cluster completeness for generation, verifying that each of the created RegGroups will be legitimate

Parameters:: activityOfferingClusterId - Activity Offering Cluster to be verified; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: Information gleaned from verifying the ActivityOfferingCluster
Throws:: DoesNotExistException - activityOfferingClusterId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - activityOfferingClusterId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

searchForActivityOfferingClusterIds

List<String> searchForActivityOfferingClusterIds(QueryByCriteria criteria,
                                                 ContextInfo contextInfo)
                                                 throws InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Searches for Activity Offering Clusters that meet the given search criteria.

Parameters:: criteria - the search criteria; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CourseOffering Ids matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForActivityOfferingClusters

List<ActivityOfferingClusterInfo> searchForActivityOfferingClusters(QueryByCriteria criteria,
                                                                    ContextInfo contextInfo)
                                                                    throws InvalidParameterException,
                                                                           MissingParameterException,
                                                                           OperationFailedException,
                                                                           PermissionDeniedException

Searches for Activity Offering Clusters that meet the given search criteria.

Parameters:: criteria - the search criteria; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CourseOfferings matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getSeatPoolDefinition

SeatPoolDefinitionInfo getSeatPoolDefinition(String seatPoolDefinitionId,
                                             ContextInfo context)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Retrieve information about a SeatPoolDefinition

Parameters:: seatPoolDefinitionId - Unique Id of the SeatPoolDefinition; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: SeatPoolDefinition associated with the passed in Id
Throws:: DoesNotExistException - seatPoolDefinitionId not found; InvalidParameterException - invalid seatPoolDefinitionId; MissingParameterException - missing seatPoolDefinitionId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getSeatPoolDefinitionsForActivityOffering

List<SeatPoolDefinitionInfo> getSeatPoolDefinitionsForActivityOffering(String activityOfferingId,
                                                                       ContextInfo context)
                                                                       throws DoesNotExistException,
                                                                              InvalidParameterException,
                                                                              MissingParameterException,
                                                                              OperationFailedException,
                                                                              PermissionDeniedException

Retrieves a list of SeatPoolDefinitions records that belongs to an ActivityOffering. This should return SeatPoolDefinitions that apply globally across all RegistrationGroups in the ActivityOffering.

Parameters:: activityOfferingId - Unique Id of the ActivityOffering; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: List of SeatPoolDefinitions
Throws:: DoesNotExistException - activityOfferingId not found; InvalidParameterException - invalid activityOfferingId; MissingParameterException - missing activityOfferingId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

searchForSeatpoolDefinitionIds

List<String> searchForSeatpoolDefinitionIds(QueryByCriteria criteria,
                                            ContextInfo contextInfo)
                                            throws InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Searches for SeatPoolDefinitions that meet the given search criteria.

Parameters:: criteria - the search criteria; contextInfo - context information containing the principalId and locale information about the caller of service operation
Returns:: a list of SeatPoolDefinition Ids matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForSeatpoolDefinitions

List<SeatPoolDefinitionInfo> searchForSeatpoolDefinitions(QueryByCriteria criteria,
                                                          ContextInfo contextInfo)
                                                          throws InvalidParameterException,
                                                                 MissingParameterException,
                                                                 OperationFailedException,
                                                                 PermissionDeniedException

Searches for SeatPoolDefinitions that meet the given search criteria.

Parameters:: criteria - the search criteria; contextInfo - context information containing the principalId and locale information about the caller of service operation
Returns:: a list of SeatPoolDefinitions matching the criteria
Throws:: InvalidParameterException - criteria or contextInfo is not valid; MissingParameterException - criteria or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

createSeatPoolDefinition

SeatPoolDefinitionInfo createSeatPoolDefinition(SeatPoolDefinitionInfo seatPoolDefinitionInfo,
                                                ContextInfo context)
                                                throws DataValidationErrorException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException,
                                                       ReadOnlyException

Creates a new Seat Pool

Parameters:: seatPoolDefinitionInfo - Details of the SeatPoolDefinition to be created; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: newly created SeatPoolDefinition
Throws:: DataValidationErrorException - One or more values invalid for this operation; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; ReadOnlyException

updateSeatPoolDefinition

SeatPoolDefinitionInfo updateSeatPoolDefinition(String seatPoolDefinitionId,
                                                SeatPoolDefinitionInfo seatPoolDefinitionInfo,
                                                ContextInfo context)
                                                throws DataValidationErrorException,
                                                       DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException,
                                                       ReadOnlyException,
                                                       VersionMismatchException

Updates an existing SeatPoolDefinition.

Parameters:: seatPoolDefinitionId - Id of SeatPoolDefinition to be updated; seatPoolDefinitionInfo - Details of updates to the SeatPoolDefinition; context - Context information containing the principalId and locale information about the caller of service operation
Returns:: updated SeatPoolDefinition
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - the SeatPoolDefinition does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version.; ReadOnlyException

updateSeatPoolDefinitionState

StatusInfo updateSeatPoolDefinitionState(String seatPoolDefinitionId,
                                         String nextStateKey,
                                         ContextInfo contextInfo)
                                         throws DoesNotExistException,
                                                InvalidParameterException,
                                                MissingParameterException,
                                                OperationFailedException,
                                                PermissionDeniedException

Updates the state of an existing SeatPoolDefinition to another state provided that it is valid to do so.

Parameters:: seatPoolDefinitionId - Id of the SeatPoolDefinition to be updated.; nextStateKey - The State Key into which the identified SeatPoolDefinition will be placed if the operation succeeds.; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - the identified SeatPoolDefinition does not exist; InvalidParameterException - the contextInfo object is invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateSeatPoolDefinition

List<ValidationResultInfo> validateSeatPoolDefinition(String validationTypeKey,
                                                      SeatPoolDefinitionInfo seatPoolDefinitionInfo,
                                                      ContextInfo context)
                                                      throws DoesNotExistException,
                                                             InvalidParameterException,
                                                             MissingParameterException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Validate a seat pool definition

Parameters:: validationTypeKey - * @param seatPoolDefinitionInfo; context - Context information containing the principalId and locale information about the caller of service operation
Throws:: DoesNotExistException - if validation type key is not found; InvalidParameterException - the context or object is invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

deleteSeatPoolDefinition

StatusInfo deleteSeatPoolDefinition(String seatPoolDefinitionId,
                                    ContextInfo context)
                                    throws DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException

Deletes an existing SeatPoolDefinition.

Parameters:: seatPoolDefinitionId - the Id of the SeatPoolDefinition to be deleted; context - Context information containing the principalId and locale information about the caller of service operation
Throws:: DoesNotExistException - the SeatPoolDefinition does not exist; InvalidParameterException - One or more parameters invalid; MissingParameterException - One or more parameters missing; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

addSeatPoolDefinitionToActivityOffering

StatusInfo addSeatPoolDefinitionToActivityOffering(String seatPoolDefinitionId,
                                                   String activityOfferingId,
                                                   ContextInfo contextInfo)
                                                   throws AlreadyExistsException,
                                                          DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Add a SeatPoolDefinition to an ActivityOffering

Parameters:: seatPoolDefinitionId - a unique identifier for a SeatPoolDefinition; activityOfferingId - a unique identifier for an ActivityOffering; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: status
Throws:: AlreadyExistsException - seatPoolDefinitionId already related to activityOfferingId; DoesNotExistException - seatPoolDefinitionId or activityOfferingId not found; InvalidParameterException - invalid seatPoolDefinitionId, activityOfferingId, or contextInfo; MissingParameterException - missing seatPoolDefinitionId, activityOfferingId, or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

removeSeatPoolDefinitionFromActivityOffering

StatusInfo removeSeatPoolDefinitionFromActivityOffering(String seatPoolDefinitionId,
                                                        String activityOfferingId,
                                                        ContextInfo contextInfo)
                                                        throws DoesNotExistException,
                                                               InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Removes a SeatPoolDefinition from an ActivityOffering.

Parameters:: seatPoolDefinitionId - a unique identifier for a SeatPoolDefinition; activityOfferingId - a unique identifier for an ActivityOffering; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: status
Throws:: DoesNotExistException - seatPoolDefinitionId or activityOfferingId not found; InvalidParameterException - invalid seatPoolDefinitionId, activityOfferingId, or contextInfo; MissingParameterException - missing seatPoolDefinitionId, activityOfferingId, or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getColocatedOfferingSet

ColocatedOfferingSetInfo getColocatedOfferingSet(String colocatedOfferingSetId,
                                                 ContextInfo contextInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Retrieves a ColocatedOfferingSet.

Parameters:: colocatedOfferingSetId - unique Id of a ColocatedOfferingSet; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: the ColocatedOfferingSet
Throws:: DoesNotExistException - ColocatedOfferingSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - ColocatedOfferingSetId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getColocatedOfferingSetsByIds

List<ColocatedOfferingSetInfo> getColocatedOfferingSetsByIds(List<String> colocatedOfferingSetIds,
                                                             ContextInfo contextInfo)
                                                             throws DoesNotExistException,
                                                                    InvalidParameterException,
                                                                    MissingParameterException,
                                                                    OperationFailedException,
                                                                    PermissionDeniedException

Retrieves a list of ColocatedOfferingSets corresponding to the given list of ColocatedOfferingSet Ids.

Parameters:: colocatedOfferingSetIds - list of ColocatedOfferingSets to be retrieved; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: a list of ColocatedOfferingSets
Throws:: DoesNotExistException - a ColocatedOfferingSetIds in list is not found; InvalidParameterException - invalid contextInfo; MissingParameterException - ColocatedOfferingSetIds or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getColocatedOfferingSetIdsByType

List<String> getColocatedOfferingSetIdsByType(String colocatedOfferingSetTypeKey,
                                              ContextInfo contextInfo)
                                              throws InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Retrieves a list of ColocatedOfferingSet Ids by ColocatedOfferingSet Type.

Parameters:: colocatedOfferingSetTypeKey - an identifier for a ColocatedOfferingSet Type; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: a list of ColocatedOfferingSet identifiers matching ColocatedOfferingSetTypeKey or an empty list if none found
Throws:: InvalidParameterException - invalid contextInfo; MissingParameterException - ColocatedOfferingSetTypeKey or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForColocatedOfferingSetIds

List<String> searchForColocatedOfferingSetIds(QueryByCriteria criteria,
                                              ContextInfo contextInfo)
                                              throws InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:: criteria - the search criteria; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of ColocatedOfferingSet Ids
Throws:: InvalidParameterException - invalid criteria or contextInfo; MissingParameterException - missing criteria or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

searchForColocatedOfferingSets

List<ColocatedOfferingSetInfo> searchForColocatedOfferingSets(QueryByCriteria criteria,
                                                              ContextInfo contextInfo)
                                                              throws InvalidParameterException,
                                                                     MissingParameterException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

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

Parameters:: criteria - the search criteria; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of ColocatedOfferingSets
Throws:: InvalidParameterException - invalid criteria or contextInfo; MissingParameterException - missing criteria or contextInfo; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateColocatedOfferingSet

List<ValidationResultInfo> validateColocatedOfferingSet(String validationTypeKey,
                                                        String colocatedOfferingSetTypeKey,
                                                        ColocatedOfferingSetInfo colocatedOfferingSetInfo,
                                                        ContextInfo contextInfo)
                                                        throws DoesNotExistException,
                                                               InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Validates a ColocatedOfferingSet. Depending on the value of validationType, this validation could be limited to tests on just the current ColocatedOfferingSet and its directly contained sub-objects or expanded to perform all tests related to this ColocatedOfferingSet. If an identifier is present for the ColocatedOfferingSet (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the ColocatedOfferingSet can be updated to the new values. If an identifier is not present or a record does not exist, the validation checks if the object with the given data can be created.

Parameters:: validationTypeKey - the identifier for the validation Type; colocatedOfferingSetTypeKey - the identifier for the ColocatedOfferingSet Type; colocatedOfferingSetInfo - detailed information about the ColocatedOfferingSet; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: a list of validation results or an empty list if validation succeeded
Throws:: DoesNotExistException - validationTypeKey, ColocatedOfferingSetId, not found; InvalidParameterException - invalid ColocatedOfferingSetInfo or contextInfo; MissingParameterException - validationTypeKey, ColocatedOfferingSetId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

createColocatedOfferingSet

ColocatedOfferingSetInfo createColocatedOfferingSet(String colocatedOfferingSetTypeKey,
                                                    ColocatedOfferingSetInfo colocatedOfferingSetInfo,
                                                    ContextInfo contextInfo)
                                                    throws DataValidationErrorException,
                                                           DoesNotExistException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException,
                                                           ReadOnlyException

Creates a ColocatedOfferingSet

Parameters:: colocatedOfferingSetTypeKey - the identifier for the ColocatedOfferingSet Type; colocatedOfferingSetInfo - detailed information about the ColocatedOfferingSet; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: detailed information about the ColocatedOfferingSet
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - ColocatedOfferingSetId does not exist; InvalidParameterException - invalid ColocatedOfferingSetInfo or contextInfo; MissingParameterException - ColocatedOfferingSetId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred; ReadOnlyException - an attempt at supplying information designated as read only

updateColocatedOfferingSet

ColocatedOfferingSetInfo updateColocatedOfferingSet(String colocatedOfferingSetId,
                                                    ColocatedOfferingSetInfo colocatedOfferingSetInfo,
                                                    ContextInfo contextInfo)
                                                    throws DataValidationErrorException,
                                                           DoesNotExistException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException,
                                                           ReadOnlyException,
                                                           VersionMismatchException

Updates a ColocatedOfferingSet.

Parameters:: colocatedOfferingSetId - identifier of the ColocatedOfferingSet to be updated; colocatedOfferingSetInfo - information about the object ColocatedOfferingSetInfo to be updated; contextInfo - context information containing the principalId and locale information about the caller of service operation
Returns:: updated ColocatedOfferingSet information
Throws:: DataValidationErrorException - one or more values invalid for this operation; DoesNotExistException - ColocatedOfferingSetId not found; InvalidParameterException - invalid ColocatedOfferingSetInfo or contextInfo; MissingParameterException - ColocatedOfferingSetId, ColocatedOfferingSetInfo or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred; ReadOnlyException - an attempt at supplying information designated as read-only; VersionMismatchException - optimistic locking failure or the action was attempted on an out of date version

deleteColocatedOfferingSet

StatusInfo deleteColocatedOfferingSet(String colocatedOfferingSetId,
                                      ContextInfo contextInfo)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Removes a ColocatedOfferingSet.

Parameters:: colocatedOfferingSetId - ColocatedOfferingSet identifier; contextInfo - context information containing the principalId and locale information about the caller of service operation
Returns:: status of the operation (success, failed)
Throws:: DoesNotExistException - ColocatedOfferingSetId not found; InvalidParameterException - invalid contextInfo; MissingParameterException - ColocatedOfferingSetId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getColocatedOfferingSetIdsForActivityOffering

List<String> getColocatedOfferingSetIdsForActivityOffering(String activityOfferingId,
                                                           ContextInfo contextInfo)
                                                           throws DoesNotExistException,
                                                                  InvalidParameterException,
                                                                  MissingParameterException,
                                                                  OperationFailedException,
                                                                  PermissionDeniedException

Retrieves a list of ColocatedOfferingSets Ids corresponding to the given list of ColocatedOfferingSets that an Activity Offering with given activity offering id is part of.

Parameters:: activityOfferingId - the identifier for an ActivityOffering; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of ColocatedOfferingSet identifiers for the Activity Offering, or an empty list if none found
Throws:: DoesNotExistException - deprecated; InvalidParameterException - contextInfo is not valid; MissingParameterException - activityOfferingId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.kuali.student.enrollment.courseoffering.service Interface CourseOfferingService

getCourseOfferingType

getCourseOfferingTypes

getInstructorTypesForCourseOfferingType

getCourseOffering

getCourseOfferingDisplay

getCourseOfferingsByIds

getCourseOfferingDisplaysByIds

getCourseOfferingIdsByType

getCourseOfferingsByCourse

getCourseOfferingsByCourseAndTerm

getCourseOfferingIdsByTerm

getCourseOfferingIdsByTermAndSubjectArea

getCourseOfferingsByTermAndInstructor

getCourseOfferingIdsByTermAndUnitsContentOwner

searchForCourseOfferingIds

searchForCourseOfferings

getValidCanonicalCourseToCourseOfferingOptionKeys

getValidRolloverOptionKeys

validateCourseOffering

createCourseOffering

rolloverCourseOffering

updateCourseOffering

updateCourseOfferingState

updateCourseOfferingFromCanonical

deleteCourseOffering

deleteCourseOfferingCascaded

validateCourseOfferingFromCanonical

getFormatOffering

getFormatOfferingsByCourseOffering

createFormatOffering

updateFormatOffering

updateFormatOfferingState

validateFormatOffering

deleteFormatOffering

deleteFormatOfferingCascaded

searchForFormatOfferingIds

searchForFormatOfferings

getActivityOfferingType

getActivityOfferingTypes

getActivityOfferingTypesForActivityType

getInstructorTypesForActivityOfferingType

getActivityOffering

getActivityOfferingDisplay

getActivityOfferingsByIds

getActivityOfferingDisplaysByIds

getActivityOfferingsByCourseOffering

getActivityOfferingDisplaysForCourseOffering

getActivityOfferingsByCluster

getActivityOfferingsByFormatOffering

getActivityOfferingsWithoutClusterByFormatOffering

getActivityOfferingsByFormatOfferingWithoutRegGroup

searchForActivityOfferingIds

searchForActivityOfferings

createActivityOffering

copyActivityOffering

generateActivityOfferings

updateActivityOffering

updateActivityOfferingState

deleteActivityOffering

deleteActivityOfferingCascaded

scheduleActivityOffering

validateActivityOffering

calculateInClassContactHoursForTerm

calculateOutofClassContactHoursForTerm

calculateTotalContactHoursForTerm

getRegistrationGroup

getRegistrationGroupsByIds

getRegistrationGroupsForCourseOffering

getRegistrationGroupsWithActivityOfferings

getRegistrationGroupsByFormatOffering

getRegistrationGroupsByActivityOfferingCluster

searchForRegistrationGroupIds

searchForRegistrationGroups

validateRegistrationGroup

createRegistrationGroup

updateRegistrationGroup

updateRegistrationGroupState

deleteRegistrationGroup

deleteRegistrationGroupsByFormatOffering

org.kuali.student.enrollment.courseoffering.service
Interface CourseOfferingService