org.kuali.student.enrollment.courseofferingset.service
Interface CourseOfferingSetService

All Superinterfaces:

CourseOfferingSetServiceBusinessLogic

All Known Implementing Classes:

CourseOfferingSetServiceDecorator, CourseOfferingSetServiceImpl, CourseOfferingSetServiceMockImpl, CourseOfferingSetServiceMockImplWithDataLoaded, CourseOfferingSetServiceValidationDecorator

public interface CourseOfferingSetService
extends CourseOfferingSetServiceBusinessLogic

Course Offering Set Service allows the user to create Sets of Offered Courses or SOCs. These sets are all dynamic. By default there is one main Soc per term that includes all the courses in that term.

Version:

0.0.7

Author:

nwright

Method Summary

StatusInfo	changeSocRolloverResultItemState(String socRolloverResultItemId, String nextStateKey, ContextInfo contextInfo) Changes the state of an existing SocRolloverResultItem to another state provided that it is valid to do so.
StatusInfo	changeSocRolloverResultState(String socRolloverResultStateId, String nextStateKey, ContextInfo contextInfo) Changes the state of an existing SocRolloverResultState to another state provided that it is valid to do so.
StatusInfo	changeSocState(String socId, String nextStateKey, ContextInfo contextInfo) Changes the state of an existing Set of CourseOfferings to another state provided that it is valid to do so.
SocInfo	createSoc(String termId, String socTypeKey, SocInfo socInfo, ContextInfo context) Creates a new Soc for a term Fields in course offering will be initialized with data from the canonical.
SocRolloverResultInfo	createSocRolloverResult(String socRolloverResultTypeKey, SocRolloverResultInfo socRolloverResultInfo, ContextInfo context) Creates a new SocRolloverResult
SocRolloverResultItemInfo	createSocRolloverResultItem(String socRolloverResultId, String socRolloverResultItemTypeKey, SocRolloverResultItemInfo socRolloverResultItemInfo, ContextInfo context) Creates a new SocRolloverResultItem
Integer	createSocRolloverResultItems(String socRolloverResultId, String socRolloverResultItemTypeKey, List<SocRolloverResultItemInfo> socRolloverResultItemInfos, ContextInfo context) Bulk create of SocRolloverResultItems All must be for the same result and type.
Integer	deleteCourseOfferingsBySoc(String socId, ContextInfo context) Delete all the course offerings associated with the Soc
StatusInfo	deleteSoc(String socId, ContextInfo context) Deletes an existing Soc.
StatusInfo	deleteSocRolloverResult(String socRolloverResultId, ContextInfo context) Deletes an existing SocRolloverResult.
StatusInfo	deleteSocRolloverResultItem(String socRolloverResultItemId, ContextInfo context) Deletes an existing SocRolloverResultItem.
List<String>	getCourseOfferingIdsBySoc(String socId, ContextInfo context) Retrieve course offering ids associated with the soc
List<String>	getCourseOfferingIdsWithUnscheduledFinalExamsBySoc(String socId, ContextInfo context) Deprecated.
List<String>	getPublishedCourseOfferingIdsBySoc(String socId, ContextInfo context) Deprecated.
SocInfo	getSoc(String socId, ContextInfo context) Retrieve information about a Soc
List<String>	getSocIdsByCourseOffering(String courseOfferingId, ContextInfo context) Retrieve Soc Ids that contain the specified course offering
List<String>	getSocIdsByTerm(String termId, ContextInfo context) Retrieve ids of the Soc for the term This could return multiple Socs but should always return the default main SOC for that term.
List<String>	getSocIdsByTermAndSubjectArea(String termId, String subjectArea, ContextInfo context) Deprecated.
List<String>	getSocIdsByTermAndUnitsContentOwner(String termId, String unitsContentOwnerId, ContextInfo context) Deprecated.
List<String>	getSocIdsByType(String typeKey, ContextInfo context) Retrieve Soc Ids by type
SocRolloverResultInfo	getSocRolloverResult(String rolloverResultId, ContextInfo context) Retrieves the result of a rollover.
List<String>	getSocRolloverResultIdsBySourceSoc(String sourceSocId, ContextInfo context) Retrieves the rollover results associated with the specified source Soc id
List<String>	getSocRolloverResultIdsByTargetSoc(String targetSocId, ContextInfo context) Retrieves the rollover results associated with the specified target Soc id
SocRolloverResultItemInfo	getSocRolloverResultItem(String socRolloverResultItemId, ContextInfo context) Retrieve information about a SocRolloverResultItem
List<SocRolloverResultItemInfo>	getSocRolloverResultItemsByIds(List<String> rolloverResultItemIds, ContextInfo context) Retrieves a list of rollover results items by id list.
List<SocRolloverResultItemInfo>	getSocRolloverResultItemsByResultId(String socRolloverResultId, ContextInfo context) Retrieves a list of rollover result items by result id
List<SocRolloverResultItemInfo>	getSocRolloverResultItemsByResultIdAndSourceCourseOfferingId(String socRolloverResultId, String sourceCourseOfferingId, ContextInfo context) Retrieves a list of rollover result items by result id and source course offering id
List<SocRolloverResultItemInfo>	getSocRolloverResultItemsByResultIdAndTargetCourseOfferingId(String socRolloverResultId, String targetCourseOfferingId, ContextInfo context) Retrieves a list of rollover result items by result id and target course offering id
List<SocRolloverResultInfo>	getSocRolloverResultsByIds(List<String> rolloverResultIds, ContextInfo context) Retrieves a list of rollover results by id list.
List<SocRolloverResultInfo>	getSocRolloverResultsBySourceAndTargetSocs(String sourceSocId, String targetSocId, ContextInfo context) Retrieves the rollover results associated with the specified source and target Soc ids
List<SocInfo>	getSocsByIds(List<String> socIds, ContextInfo context) Retrieves a list of course offerings by id list.
List<String>	getUnpublishedActivityOfferingIdsBySoc(String socId, ContextInfo context) Deprecated.
List<String>	getUnpublishedCourseOfferingIdsBySoc(String socId, ContextInfo context) Deprecated.
List<String>	getUnscheduledActivityOfferingIdsBySoc(String socId, ContextInfo context) Deprecated.
Boolean	isCourseOfferingInSoc(String socId, String courseOfferingId, ContextInfo context) Checks if the specified course offering is or is not in the specified soc.
SocRolloverResultInfo	reverseRollover(String rolloverResultId, List<String> optionKeys, ContextInfo context) Requests that the rollover identified by the result be reversed.
SocInfo	rolloverSoc(String sourceSocId, String targetTermId, List<String> optionKeys, ContextInfo context) Creates a new SOC for the target term that corresponds to the source soc and then rolls over all the course offerings in source Soc to the new soc using the supplied options.
List<String>	searchForSocIds(QueryByCriteria criteria, ContextInfo context) Search for Set of Course Ids
List<String>	searchForSocRolloverResultIds(QueryByCriteria criteria, ContextInfo context) Searches for soc rollover result ids using a free form search criteria.
List<String>	searchForSocRolloverResultItemIds(QueryByCriteria criteria, ContextInfo context) Searches for soc rollover result item ids using a free form search criteria.
List<SocRolloverResultItemInfo>	searchForSocRolloverResultItems(QueryByCriteria criteria, ContextInfo context) Searches for soc rollover result items using a free form search criteria
List<SocRolloverResultInfo>	searchForSocRolloverResults(QueryByCriteria criteria, ContextInfo context) Searches for soc rollover results using a free form search criteria
List<SocInfo>	searchForSocs(QueryByCriteria criteria, ContextInfo context) Search for Sets of Courses
StatusInfo	startScheduleSoc(String socId, List<String> optionKeys, ContextInfo context) Requests that the course offerings in this Soc be submitted to the scheduler.
SocInfo	updateSoc(String socId, SocInfo socInfo, ContextInfo context) Updates an existing Soc.
SocRolloverResultInfo	updateSocRolloverProgress(String socRolloverResultId, Integer itemsProcessed, ContextInfo context) Update progress information
SocRolloverResultInfo	updateSocRolloverResult(String socRolloverResultId, SocRolloverResultInfo socRolloverResultInfo, ContextInfo context) Updates an existing SocRolloverResult.
SocRolloverResultItemInfo	updateSocRolloverResultItem(String socRolloverResultItemId, SocRolloverResultItemInfo socRolloverResultItemInfo, ContextInfo context) Updates an existing SocRolloverResultItem.
List<ValidationResultInfo>	validateSoc(String validationType, SocInfo socInfo, ContextInfo context) Validates a Soc.
List<ValidationResultInfo>	validateSocRolloverResult(String validationType, SocRolloverResultInfo socRolloverResultInfo, ContextInfo context) Validates a SocRolloverResult.
List<ValidationResultInfo>	validateSocRolloverResultItem(String validationType, SocRolloverResultItemInfo socRolloverResultItemInfo, ContextInfo context) Validates a SocRolloverResultItem.

Method Detail

getSoc

SocInfo getSoc(String socId,
               ContextInfo context)
               throws DoesNotExistException,
                      InvalidParameterException,
                      MissingParameterException,
                      OperationFailedException,
                      PermissionDeniedException

Retrieve information about a Soc

Parameters:

socId - Unique Id of the Soc

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

Throws:

DoesNotExistException - socId not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getSocsByIds

List<SocInfo> getSocsByIds(List<String> socIds,
                           ContextInfo context)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException

Retrieves a list of course offerings by id list.

Parameters:

socIds - List of unique Ids of Soc

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

Throws:

DoesNotExistException - socId in the list not found

InvalidParameterException - invalid socIds

MissingParameterException - missing socIds

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getSocIdsByTerm

List<String> getSocIdsByTerm(String termId,
                             ContextInfo context)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Retrieve ids of the Soc for the term This could return multiple Socs but should always return the default main SOC for that term.

Parameters:

termId - Unique Id of the term

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

Throws:

DoesNotExistException - termId not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getSocIdsByTermAndSubjectArea

@Deprecated
List<String> getSocIdsByTermAndSubjectArea(String termId,
                                                      String subjectArea,
                                                      ContextInfo context)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Deprecated.

Retrieve Soc Ids for a given term and subject area. A Soc will have an official and "other" subject areas, this operation will the course offering ids with either official or other subject area that match. THIS IS A PLACEHOLDER for DEPARTMENTAL SOCS

Parameters:

termId - Unique key of the term in which the course is being offered

subjectArea - subject area

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

Returns:

List of Soc Ids

Throws:

DoesNotExistException - termId or subject area not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getSocIdsByTermAndUnitsContentOwner

@Deprecated
List<String> getSocIdsByTermAndUnitsContentOwner(String termId,
                                                            String unitsContentOwnerId,
                                                            ContextInfo context)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Deprecated.

Retrieve Soc Ids for a given term and unit content owner THIS IS A PLACEHOLDER for DEPARTMENTAL SOCS

Parameters:

termId - Unique key of the term in which the course is being offered

unitsContentOwnerId - Org Id of the Units content owner

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

Returns:

List of Soc Ids

Throws:

DoesNotExistException - termId or unitsContentOwnerid not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getSocIdsByType

List<String> getSocIdsByType(String typeKey,
                             ContextInfo context)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Retrieve Soc Ids by type

Parameters:

typeKey - Unique key type of Soc

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

Returns:

List of Soc Ids

Throws:

DoesNotExistException - typeKey not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

searchForSocs

List<SocInfo> searchForSocs(QueryByCriteria criteria,
                            ContextInfo context)
                            throws InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException

Search for Sets of Courses

Parameters:

criteria - What to search for in SocInfo table

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

Returns:

A list of SocInfo objects matching criteria. Empty list if none matches

Throws:

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

searchForSocIds

List<String> searchForSocIds(QueryByCriteria criteria,
                             ContextInfo context)
                             throws InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Search for Set of Course Ids

Parameters:

criteria - What to search for in SocInfo table

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

Returns:

A list of SocInfo object IDs matching criteria. Empty list if none matches

Throws:

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

createSoc

SocInfo createSoc(String termId,
                  String socTypeKey,
                  SocInfo socInfo,
                  ContextInfo context)
                  throws DoesNotExistException,
                         DataValidationErrorException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException,
                         ReadOnlyException

Creates a new Soc for a term Fields in course offering will be initialized with data from the canonical.

Parameters:

termId - Unique key of the term in which the course is being offered course offering

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

Returns:

newly created SocInfo

Throws:

DoesNotExistException - termId or socTypeKey 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

updateSoc

SocInfo updateSoc(String socId,
                  SocInfo socInfo,
                  ContextInfo context)
                  throws DataValidationErrorException,
                         DoesNotExistException,
                         InvalidParameterException,
                         MissingParameterException,
                         OperationFailedException,
                         PermissionDeniedException,
                         ReadOnlyException,
                         VersionMismatchException

Updates an existing Soc.

Parameters:

socId - Id of Soc to be updated

socInfo - Details of updates to the Soc

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

Returns:

updated Soc

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - the Soc does not exist

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

ReadOnlyException - if trying to update the state or type

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

changeSocState

StatusInfo changeSocState(String socId,
                          String nextStateKey,
                          ContextInfo contextInfo)
                          throws DoesNotExistException,
                                 InvalidParameterException,
                                 MissingParameterException,
                                 OperationFailedException,
                                 PermissionDeniedException

Changes the state of an existing Set of CourseOfferings to another state provided that it is valid to do so.

Parameters:

socId - of the Set of CourseOffering's to be changed.

nextStateKey - The State Key into which the identified Set of CourseOffering's 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 Set of CourseOffering's does not exist

InvalidParameterException - the contextInfo object is invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

deleteSoc

StatusInfo deleteSoc(String socId,
                     ContextInfo context)
                     throws DependentObjectsExistException,
                            DoesNotExistException,
                            InvalidParameterException,
                            MissingParameterException,
                            OperationFailedException,
                            PermissionDeniedException

Deletes an existing Soc. Deleting the Soc does not automatically delete the course offerings in a soc

Parameters:

socId - 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 soc does not exist

DependentObjectsExistException - if course offerings exist and the implementation has the business rule that a course offering must have a Soc

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

validateSoc

List<ValidationResultInfo> validateSoc(String validationType,
                                       SocInfo socInfo,
                                       ContextInfo context)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException

Validates a Soc. 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

socInfo - the soc 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, socInfo

MissingParameterException - missing validationTypeKey, socInfo

OperationFailedException - unable to complete request

getSocIdsByCourseOffering

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

Retrieve Soc Ids that contain the specified course offering

Parameters:

courseOfferingId - Unique Id of the course offering

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

Throws:

DoesNotExistException - courseOfferingId not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getCourseOfferingIdsBySoc

List<String> getCourseOfferingIdsBySoc(String socId,
                                       ContextInfo context)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Retrieve course offering ids associated with the soc

Specified by:

getCourseOfferingIdsBySoc in interface CourseOfferingSetServiceBusinessLogic

Parameters:

socId - Unique Id of the soc

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

Returns:

list of course offering ids

Throws:

DoesNotExistException - courseId or termId not found

InvalidParameterException - invalid courseId or termId

MissingParameterException - missing courseId or termId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

deleteCourseOfferingsBySoc

Integer deleteCourseOfferingsBySoc(String socId,
                                   ContextInfo context)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Delete all the course offerings associated with the Soc

Specified by:

deleteCourseOfferingsBySoc in interface CourseOfferingSetServiceBusinessLogic

Parameters:

socId - Unique Id of the soc

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

Returns:

count of the course offerings deleted

Throws:

DoesNotExistException - socId not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

isCourseOfferingInSoc

Boolean isCourseOfferingInSoc(String socId,
                              String courseOfferingId,
                              ContextInfo context)
                              throws DoesNotExistException,
                                     InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Checks if the specified course offering is or is not in the specified soc.

Specified by:

isCourseOfferingInSoc in interface CourseOfferingSetServiceBusinessLogic

Parameters:

socId - Unique Id of the soc

courseOfferingId - Unique id of the course offering

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

Returns:

true if the course offering is in the soc else false.

Throws:

DoesNotExistException - either id is not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getPublishedCourseOfferingIdsBySoc

@Deprecated
List<String> getPublishedCourseOfferingIdsBySoc(String socId,
                                                           ContextInfo context)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Deprecated.

Retrieve published Course offering ids in this soc THIS IS A PLACEHOLDER FOR M5 AND NEEDS TO BE REVIEWED Not sure what it means to be "published"

Specified by:

getPublishedCourseOfferingIdsBySoc in interface CourseOfferingSetServiceBusinessLogic

Parameters:

socId - Unique Id of the soc

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

Returns:

list of Course offering ids

Throws:

DoesNotExistException - socId not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getUnpublishedCourseOfferingIdsBySoc

@Deprecated
List<String> getUnpublishedCourseOfferingIdsBySoc(String socId,
                                                             ContextInfo context)
                                                  throws DoesNotExistException,
                                                         InvalidParameterException,
                                                         MissingParameterException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Deprecated.

Retrieve unpublished Course offering ids in this soc THIS IS A PLACEHOLDER FOR M5 AND NEEDS TO BE REVIEWED Not sure what it means to be "unpublished"

Specified by:

getUnpublishedCourseOfferingIdsBySoc in interface CourseOfferingSetServiceBusinessLogic

Parameters:

socId - Unique Id of the soc

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

Returns:

list of Activity offering ids

Throws:

DoesNotExistException - socId not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getUnpublishedActivityOfferingIdsBySoc

@Deprecated
List<String> getUnpublishedActivityOfferingIdsBySoc(String socId,
                                                               ContextInfo context)
                                                    throws DoesNotExistException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Deprecated.

Retrieve unpublished Activity offering ids associated with the course offerings in this soc THIS IS A PLACEHOLDER FOR M5 AND NEEDS TO BE REVIEWED Not sure what it means to be "unpublished"

Specified by:

getUnpublishedActivityOfferingIdsBySoc in interface CourseOfferingSetServiceBusinessLogic

Parameters:

socId - Unique Id of the soc

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

Returns:

list of Activity offering ids

Throws:

DoesNotExistException - socId not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getUnscheduledActivityOfferingIdsBySoc

@Deprecated
List<String> getUnscheduledActivityOfferingIdsBySoc(String socId,
                                                               ContextInfo context)
                                                    throws DoesNotExistException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Deprecated.

Retrieve unscheduled Activity offering ids associated with the course offerings in this soc THIS IS A PLACEHOLDER FOR M5 AND NEEDS TO BE REVIEWED Not sure what it means to be "unscheduled"

Specified by:

getUnscheduledActivityOfferingIdsBySoc in interface CourseOfferingSetServiceBusinessLogic

Parameters:

socId - Unique Id of the soc

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

Returns:

list of Activity offering ids

Throws:

DoesNotExistException - socId not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getCourseOfferingIdsWithUnscheduledFinalExamsBySoc

@Deprecated
List<String> getCourseOfferingIdsWithUnscheduledFinalExamsBySoc(String socId,
                                                                           ContextInfo context)
                                                                throws DoesNotExistException,
                                                                       InvalidParameterException,
                                                                       MissingParameterException,
                                                                       OperationFailedException,
                                                                       PermissionDeniedException

Deprecated.

Get course offering ids associated with the soc that have an unscheduled final exam THIS IS A PLACEHOLDER FOR M5 AND NEEDS TO BE REVIEWED Not sure what it means to be "unscheduled final exam"

Parameters:

socId - Unique Id of the soc

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

Returns:

list of course offering ids

Throws:

DoesNotExistException - socId not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

startScheduleSoc

StatusInfo startScheduleSoc(String socId,
                            List<String> optionKeys,
                            ContextInfo context)
                            throws DoesNotExistException,
                                   InvalidParameterException,
                                   MissingParameterException,
                                   OperationFailedException,
                                   PermissionDeniedException

Requests that the course offerings in this Soc be submitted to the scheduler. This method starts what is know as the mass scheduling event. The expectation is that this method starts an asynchronous process to perform the scheduling that will complete or fail eventually independently of this method call. The optionKeys parameter can be used to alter the default processing behavior.

Specified by:

startScheduleSoc in interface CourseOfferingSetServiceBusinessLogic

Parameters:

socId - Id of the Set of Courses

optionKeys - keys that alter the default processing behavior.

context - 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 - socId not found

InvalidParameterException - contextInfo object is invalid

MissingParameterException - one or more missing parameters

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

rolloverSoc

SocInfo rolloverSoc(String sourceSocId,
                    String targetTermId,
                    List<String> optionKeys,
                    ContextInfo context)
                    throws DoesNotExistException,
                           InvalidParameterException,
                           MissingParameterException,
                           OperationFailedException,
                           PermissionDeniedException

Creates a new SOC for the target term that corresponds to the source soc and then rolls over all the course offerings in source Soc to the new soc using the supplied options.

Specified by:

rolloverSoc in interface CourseOfferingSetServiceBusinessLogic

Parameters:

sourceSocId - Unique Id of the source Soc

optionKeys - keys identifying optional processing to occur

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

Returns:

newly created Soc

Throws:

DoesNotExistException - sourceSocId or targetTermId not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getSocRolloverResult

SocRolloverResultInfo getSocRolloverResult(String rolloverResultId,
                                           ContextInfo context)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Retrieves the result of a rollover.

Parameters:

rolloverResultId - unique Id of the rollover result

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

Throws:

DoesNotExistException - rolloverResultId in the list not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getSocRolloverResultsByIds

List<SocRolloverResultInfo> getSocRolloverResultsByIds(List<String> rolloverResultIds,
                                                       ContextInfo context)
                                                       throws DoesNotExistException,
                                                              InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

Retrieves a list of rollover results by id list.

Parameters:

rolloverResultIds - List of unique Ids of the rollover result to be fetched

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

Throws:

DoesNotExistException - rolloverResultId in the list not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getSocRolloverResultItemsByIds

List<SocRolloverResultItemInfo> getSocRolloverResultItemsByIds(List<String> rolloverResultItemIds,
                                                               ContextInfo context)
                                                               throws DoesNotExistException,
                                                                      InvalidParameterException,
                                                                      MissingParameterException,
                                                                      OperationFailedException,
                                                                      PermissionDeniedException

Retrieves a list of rollover results items by id list.

Parameters:

rolloverResultItemIds - List of unique Ids of the rollover result items to be fetched

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

Throws:

DoesNotExistException - rolloverResultId in the list not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getSocRolloverResultItemsByResultId

List<SocRolloverResultItemInfo> getSocRolloverResultItemsByResultId(String socRolloverResultId,
                                                                    ContextInfo context)
                                                                    throws DoesNotExistException,
                                                                           InvalidParameterException,
                                                                           MissingParameterException,
                                                                           OperationFailedException,
                                                                           PermissionDeniedException

Retrieves a list of rollover result items by result id

Parameters:

socRolloverResultId - Unique Ids of the rollover result for which the items are to be fetched

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

Throws:

DoesNotExistException - rolloverResultId in the list not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getSocRolloverResultItemsByResultIdAndSourceCourseOfferingId

List<SocRolloverResultItemInfo> getSocRolloverResultItemsByResultIdAndSourceCourseOfferingId(String socRolloverResultId,
                                                                                             String sourceCourseOfferingId,
                                                                                             ContextInfo context)
                                                                                             throws DoesNotExistException,
                                                                                                    InvalidParameterException,
                                                                                                    MissingParameterException,
                                                                                                    OperationFailedException,
                                                                                                    PermissionDeniedException

Retrieves a list of rollover result items by result id and source course offering id

Parameters:

socRolloverResultId - Unique Id of the rollover result for which the items are to be fetched

sourceCourseOfferingId - Unique Id of source course offering id

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

Throws:

DoesNotExistException - rolloverResultId in the list not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getSocRolloverResultItemsByResultIdAndTargetCourseOfferingId

List<SocRolloverResultItemInfo> getSocRolloverResultItemsByResultIdAndTargetCourseOfferingId(String socRolloverResultId,
                                                                                             String targetCourseOfferingId,
                                                                                             ContextInfo context)
                                                                                             throws DoesNotExistException,
                                                                                                    InvalidParameterException,
                                                                                                    MissingParameterException,
                                                                                                    OperationFailedException,
                                                                                                    PermissionDeniedException

Retrieves a list of rollover result items by result id and target course offering id

Parameters:

socRolloverResultId - Unique Id of the rollover result for which the items are to be fetched

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

Throws:

DoesNotExistException - rolloverResultId in the list not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getSocRolloverResultsBySourceAndTargetSocs

List<SocRolloverResultInfo> getSocRolloverResultsBySourceAndTargetSocs(String sourceSocId,
                                                                       String targetSocId,
                                                                       ContextInfo context)
                                                                       throws DoesNotExistException,
                                                                              InvalidParameterException,
                                                                              MissingParameterException,
                                                                              OperationFailedException,
                                                                              PermissionDeniedException

Retrieves the rollover results associated with the specified source and target Soc ids

Parameters:

sourceSocId - source Soc Id

targetSocId - target Soc Id

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

Returns:

List of Rollover Results

Throws:

DoesNotExistException - courseId or termId not found

InvalidParameterException - invalid courseId or termId

MissingParameterException - missing courseId or termId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getSocRolloverResultIdsByTargetSoc

List<String> getSocRolloverResultIdsByTargetSoc(String targetSocId,
                                                ContextInfo context)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Retrieves the rollover results associated with the specified target Soc id

Parameters:

targetSocId - target Soc Id

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

Returns:

List of Rollover Result Ids

Throws:

DoesNotExistException - courseId or termId not found

InvalidParameterException - invalid courseId or termId

MissingParameterException - missing courseId or termId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

getSocRolloverResultIdsBySourceSoc

List<String> getSocRolloverResultIdsBySourceSoc(String sourceSocId,
                                                ContextInfo context)
                                                throws DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Retrieves the rollover results associated with the specified source Soc id

Parameters:

sourceSocId - Unique id of the source Soc

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

Returns:

List of Rollover Result Ids

Throws:

DoesNotExistException - courseId or termId not found

InvalidParameterException - invalid courseId or termId

MissingParameterException - missing courseId or termId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

reverseRollover

SocRolloverResultInfo reverseRollover(String rolloverResultId,
                                      List<String> optionKeys,
                                      ContextInfo context)
                                      throws DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Requests that the rollover identified by the result be reversed. This attempts to reverse or clear out the actions applied by the specified rollover result. Depending on whether or not the resulting course offerings have been updated and the optional processing flags a full reversal is not guaranteed.

Specified by:

reverseRollover in interface CourseOfferingSetServiceBusinessLogic

Parameters:

rolloverResultId - Unique Id of the rollover result

optionKeys - keys identifying optional processing to happen when clearing the result

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

Returns:

a Rollover Result indicating what reversal actions were successful or not

Throws:

DoesNotExistException - courseId or termId not found

InvalidParameterException - invalid courseId or termId

MissingParameterException - missing courseId or termId

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

createSocRolloverResult

SocRolloverResultInfo createSocRolloverResult(String socRolloverResultTypeKey,
                                              SocRolloverResultInfo socRolloverResultInfo,
                                              ContextInfo context)
                                              throws DoesNotExistException,
                                                     DataValidationErrorException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException,
                                                     ReadOnlyException

Creates a new SocRolloverResult

Parameters:

socRolloverResultTypeKey - soc rollover result type key

socRolloverResultInfo - object to be created

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

Returns:

newly created SocRolloverResultInfo

Throws:

DoesNotExistException - termId or socRolloverResultTypeKey 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

updateSocRolloverResult

SocRolloverResultInfo updateSocRolloverResult(String socRolloverResultId,
                                              SocRolloverResultInfo socRolloverResultInfo,
                                              ContextInfo context)
                                              throws DataValidationErrorException,
                                                     DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException,
                                                     ReadOnlyException,
                                                     VersionMismatchException

Updates an existing SocRolloverResult.

Parameters:

socRolloverResultId - Id of SocRolloverResult to be updated

socRolloverResultInfo - Details of updates to the SocRolloverResult

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

Returns:

updated SocRolloverResult

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - the SocRolloverResult 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

updateSocRolloverProgress

SocRolloverResultInfo updateSocRolloverProgress(String socRolloverResultId,
                                                Integer itemsProcessed,
                                                ContextInfo context)
                                                throws DataValidationErrorException,
                                                       DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException,
                                                       ReadOnlyException,
                                                       VersionMismatchException

Update progress information

Parameters:

socRolloverResultId - Id of SocRolloverResult to be updated

itemsProcessed - new count of the number of items processed

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

Returns:

StatusInfo indicates the update worked

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - the SocRolloverResult 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

changeSocRolloverResultState

StatusInfo changeSocRolloverResultState(String socRolloverResultStateId,
                                        String nextStateKey,
                                        ContextInfo contextInfo)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

Changes the state of an existing SocRolloverResultState to another state provided that it is valid to do so.

Parameters:

socRolloverResultStateId - of the SocRolloverResultState to be changed.

nextStateKey - The State Key into which the identified SocRolloverResultState 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 SocRolloverResultState does not exist

InvalidParameterException - the contextInfo object is invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

deleteSocRolloverResult

StatusInfo deleteSocRolloverResult(String socRolloverResultId,
                                   ContextInfo context)
                                   throws DoesNotExistException,
                                          DependentObjectsExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Deletes an existing SocRolloverResult.

Parameters:

socRolloverResultId - 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 SeatPoolDefinition does not exist

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

DependentObjectsExistException

validateSocRolloverResult

List<ValidationResultInfo> validateSocRolloverResult(String validationType,
                                                     SocRolloverResultInfo socRolloverResultInfo,
                                                     ContextInfo context)
                                                     throws DoesNotExistException,
                                                            InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException

Validates a SocRolloverResult. 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

socRolloverResultInfo - the socRolloverResult 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, socRolloverResultInfo

MissingParameterException - missing validationTypeKey, socRolloverResultInfo

OperationFailedException - unable to complete request

getSocRolloverResultItem

SocRolloverResultItemInfo getSocRolloverResultItem(String socRolloverResultItemId,
                                                   ContextInfo context)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Retrieve information about a SocRolloverResultItem

Parameters:

socRolloverResultItemId - Unique Id of the SocRolloverResultItem

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

Throws:

DoesNotExistException - socRolloverResultItemId not found

InvalidParameterException - invalid parameter

MissingParameterException - missing parameter

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

createSocRolloverResultItem

SocRolloverResultItemInfo createSocRolloverResultItem(String socRolloverResultId,
                                                      String socRolloverResultItemTypeKey,
                                                      SocRolloverResultItemInfo socRolloverResultItemInfo,
                                                      ContextInfo context)
                                                      throws DoesNotExistException,
                                                             DataValidationErrorException,
                                                             InvalidParameterException,
                                                             MissingParameterException,
                                                             OperationFailedException,
                                                             PermissionDeniedException,
                                                             ReadOnlyException

Creates a new SocRolloverResultItem

Parameters:

socRolloverResultId - Id of the corresponding soc rollover result

socRolloverResultItemTypeKey - soc rollover result type key

socRolloverResultItemInfo - object to be created

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

Returns:

newly created SocRolloverResultItemInfo

Throws:

DoesNotExistException - termId or socRolloverResultItemTypeKey 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

createSocRolloverResultItems

Integer createSocRolloverResultItems(String socRolloverResultId,
                                     String socRolloverResultItemTypeKey,
                                     List<SocRolloverResultItemInfo> socRolloverResultItemInfos,
                                     ContextInfo context)
                                     throws DoesNotExistException,
                                            DataValidationErrorException,
                                            InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException,
                                            ReadOnlyException

Bulk create of SocRolloverResultItems All must be for the same result and type.

Parameters:

socRolloverResultId - Id of the corresponding soc rollover result

socRolloverResultItemTypeKey - soc rollover result type key

socRolloverResultItemInfos - objects to be created

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

Returns:

count of number of items created

Throws:

DoesNotExistException - termId or socRolloverResultItemTypeKey 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

updateSocRolloverResultItem

SocRolloverResultItemInfo updateSocRolloverResultItem(String socRolloverResultItemId,
                                                      SocRolloverResultItemInfo socRolloverResultItemInfo,
                                                      ContextInfo context)
                                                      throws DataValidationErrorException,
                                                             DoesNotExistException,
                                                             InvalidParameterException,
                                                             MissingParameterException,
                                                             OperationFailedException,
                                                             PermissionDeniedException,
                                                             ReadOnlyException,
                                                             VersionMismatchException

Updates an existing SocRolloverResultItem.

Parameters:

socRolloverResultItemId - Id of SocRolloverResultItem to be updated

socRolloverResultItemInfo - Details of updates to the SocRolloverResultItem

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

Returns:

updated SocRolloverResultItem

Throws:

DataValidationErrorException - One or more values invalid for this operation

DoesNotExistException - the SocRolloverResultItem 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

changeSocRolloverResultItemState

StatusInfo changeSocRolloverResultItemState(String socRolloverResultItemId,
                                            String nextStateKey,
                                            ContextInfo contextInfo)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Changes the state of an existing SocRolloverResultItem to another state provided that it is valid to do so.

Parameters:

socRolloverResultItemId - of the SocRolloverResultItem to be changed.

nextStateKey - The State Key into which the identified SocRolloverResultItem 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 SocRolloverResultItem does not exist

InvalidParameterException - the contextInfo object is invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

deleteSocRolloverResultItem

StatusInfo deleteSocRolloverResultItem(String socRolloverResultItemId,
                                       ContextInfo context)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Deletes an existing SocRolloverResultItem.

Parameters:

socRolloverResultItemId - 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 SeatPoolDefinition does not exist

InvalidParameterException - One or more parameters invalid

MissingParameterException - One or more parameters missing

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

validateSocRolloverResultItem

List<ValidationResultInfo> validateSocRolloverResultItem(String validationType,
                                                         SocRolloverResultItemInfo socRolloverResultItemInfo,
                                                         ContextInfo context)
                                                         throws DoesNotExistException,
                                                                InvalidParameterException,
                                                                MissingParameterException,
                                                                OperationFailedException

Validates a SocRolloverResultItem. 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

socRolloverResultItemInfo - the socRolloverResultItem 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, socRolloverResultItemInfo

MissingParameterException - missing validationTypeKey, socRolloverResultItemInfo

OperationFailedException - unable to complete request

searchForSocRolloverResultIds

List<String> searchForSocRolloverResultIds(QueryByCriteria criteria,
                                           ContextInfo context)
                                           throws InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Searches for soc rollover result ids using a free form search criteria.

Parameters:

criteria -

context -

Returns:

Throws:

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

searchForSocRolloverResults

List<SocRolloverResultInfo> searchForSocRolloverResults(QueryByCriteria criteria,
                                                        ContextInfo context)
                                                        throws InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Searches for soc rollover results using a free form search criteria

Parameters:

criteria -

context -

Throws:

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

searchForSocRolloverResultItemIds

List<String> searchForSocRolloverResultItemIds(QueryByCriteria criteria,
                                               ContextInfo context)
                                               throws InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Searches for soc rollover result item ids using a free form search criteria.

Parameters:

criteria -

context -

Returns:

Throws:

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException

searchForSocRolloverResultItems

List<SocRolloverResultItemInfo> searchForSocRolloverResultItems(QueryByCriteria criteria,
                                                                ContextInfo context)
                                                                throws InvalidParameterException,
                                                                       MissingParameterException,
                                                                       OperationFailedException,
                                                                       PermissionDeniedException

Searches for soc rollover result items using a free form search criteria

Parameters:

criteria -

context -

Throws:

InvalidParameterException

MissingParameterException

OperationFailedException

PermissionDeniedException