ProgramService (Kuali Student 2.1.0-fr1-SNAPSHOT API)

All Superinterfaces:

DictionaryService, SearchService, VersionManagementService

All Known Implementing Classes:

ProgramServiceDecorator, ProgramServiceImpl
```
public interface ProgramService
extends SearchService, VersionManagementService, DictionaryService
```
The Program Service allows for the creation and management of programs.

Version:

2.0

Method Summary

Methods
Modifier and Type	Method and Description
`CoreProgramInfo`	`createCoreProgram(String coreProgramTypeKey, CoreProgramInfo coreProgramInfo, ContextInfo contextInfo)` Creates a Core Program
`CredentialProgramInfo`	`createCredentialProgram(String credentialProgramTypeKey, CredentialProgramInfo credentialProgramInfo, ContextInfo contextInfo)` Creates a Credential Program
`HonorsProgramInfo`	`createHonorsProgram(String honorsProgramTypeKey, HonorsProgramInfo honorsProgramInfo, ContextInfo contextInfo)` Creates a Honors Program
`MajorDisciplineInfo`	`createMajorDiscipline(String majorDisciplineTypeKey, MajorDisciplineInfo majorDisciplineInfo, ContextInfo contextInfo)` Creates a Major Discipline Program
`MinorDisciplineInfo`	`createMinorDiscipline(String minorDisciplineTypeKey, MinorDisciplineInfo minorDisciplineInfo, ContextInfo contextInfo)` Creates a Minor Discipline Program
`CoreProgramInfo`	`createNewCoreProgramVersion(String coreProgramId, String versionComment, ContextInfo contextInfo)` Creates a new Core Program version based on the current Core Program
`CredentialProgramInfo`	`createNewCredentialProgramVersion(String credentialProgramId, String versionComment, ContextInfo contextInfo)` Creates a new Credential Program version based on the current Credential Program
`MajorDisciplineInfo`	`createNewMajorDisciplineVersion(String majorDisciplineId, String versionComment, ContextInfo contextInfo)` Creates a new Major Discipline version based on the current Major
`ProgramRequirementInfo`	`createProgramRequirement(String programRequirementTypeKey, ProgramRequirementInfo programRequirementInfo, ContextInfo contextInfo)` Creates a Program Requirement
`StatusInfo`	`deleteCoreProgram(String coreProgramId, ContextInfo contextInfo)` Deletes a Core Program
`StatusInfo`	`deleteCredentialProgram(String credentialProgramId, ContextInfo contextInfo)` Deletes a Credential Program
`StatusInfo`	`deleteHonorsProgram(String honorsProgramId, ContextInfo contextInfo)` Deletes a Honors Program
`StatusInfo`	`deleteMajorDiscipline(String majorDisciplineId, ContextInfo contextInfo)` Deletes a Major Discipline
`StatusInfo`	`deleteMinorDiscipline(String minorDisciplineId, ContextInfo contextInfo)` Deletes a Minor Discipline
`StatusInfo`	`deleteProgramRequirement(String programRequirementId, ContextInfo contextInfo)` Deletes a Program Requirement
`CoreProgramInfo`	`getCoreProgram(String coreProgramId, ContextInfo contextInfo)` Retrieves a Core Program
`List<CoreProgramInfo>`	`getCoreProgramsByIds(List<String> coreProgramIds, ContextInfo contextInfo)` Retrieves a list of core program by Ids
`CredentialProgramInfo`	`getCredentialProgram(String credentialProgramId, ContextInfo contextInfo)` Retrieves a CredentialProgram
`List<CredentialProgramInfo>`	`getCredentialProgramsByIds(List<String> credentialProgramIds, ContextInfo contextInfo)` Retrieves a list of CredentialPrograms corresponding to the given list of CredentialProgram Ids
`List<String>`	`getHonorProgramIdsByCredentialProgramType(String programType, ContextInfo contextInfo)` Retrieves the list of Honors Program Program a given Credential Program Type.
`HonorsProgramInfo`	`getHonorsProgram(String honorsProgramId, ContextInfo contextInfo)` Retrieves a HonorsProgram
`List<HonorsProgramInfo>`	`getHonorsProgramsByIds(List<String> honorsProgramIds, ContextInfo contextInfo)` Retrieves a list of honors program by Ids
`MajorDisciplineInfo`	`getMajorDiscipline(String majorDisciplineId, ContextInfo contextInfo)` Retrieves a MajorDiscipline
`List<String>`	`getMajorDisciplineIdsByCredentialProgramType(String programType, ContextInfo contextInfo)` Retrieves the list of Major Discipline identifiers a given Credential Program Type.
`List<MajorDisciplineInfo>`	`getMajorDisciplinesByIds(List<String> majorDisciplineIds, ContextInfo contextInfo)` Retrieves a list of MajorDiscipline corresponding to the given list of major discipline Ids
`MinorDisciplineInfo`	`getMinorDiscipline(String minorDisciplineId, ContextInfo contextInfo)` Retrieves a MinorDiscipline
`List<String>`	`getMinorsByCredentialProgramType(String programType, ContextInfo contextInfo)` Retrieves the list of Minor Discipline Program a given Credential Program Type.
`ProgramRequirementInfo`	`getProgramRequirement(String programRequirementId, ContextInfo contextInfo)` Retrieves a ProgramRequirement
`List<ProgramRequirementInfo>`	`getProgramRequirementsByIds(List<String> programRequirementIds, ContextInfo contextInfo)` Retrieves a list of ProgramRequirements by Ids
`List<ProgramVariationInfo>`	`getProgramVariationsByMajorDiscipline(String majorDisciplineId, ContextInfo contextInfo)` Retrieves a list of program variations for a particular major
`List<ProgramVariationInfo>`	`getVariationsByMajorDisciplineId(String majorDisciplineId, ContextInfo contextInfo)` Deprecated.
`StatusInfo`	`setCurrentCoreProgramVersion(String coreProgramId, Date currentVersionStart, ContextInfo contextInfo)` Sets a specific version of the Core Program as current.
`StatusInfo`	`setCurrentCredentialProgramVersion(String credentialProgramId, Date currentVersionStart, ContextInfo contextInfo)` Sets a specific version of the Credential Program as current.
`StatusInfo`	`setCurrentMajorDisciplineVersion(String majorDisciplineId, Date currentVersionStart, ContextInfo contextInfo)` Sets a specific version of the Major as current.
`CoreProgramInfo`	`updateCoreProgram(String coreProgramId, String coreProgramTypeKey, CoreProgramInfo coreProgramInfo, ContextInfo contextInfo)` Updates a Core Program
`CredentialProgramInfo`	`updateCredentialProgram(String credentialProgramId, CredentialProgramInfo credentialProgramInfo, ContextInfo contextInfo)` Updates a Credential Program
`HonorsProgramInfo`	`updateHonorsProgram(String honorsProgramId, String honorsProgramTypeKey, HonorsProgramInfo honorsProgramInfo, ContextInfo contextInfo)` Updates a Honors Program
`MajorDisciplineInfo`	`updateMajorDiscipline(String majorDisciplineId, MajorDisciplineInfo majorDisciplineInfo, ContextInfo contextInfo)` Updates a Major Discipline
`MinorDisciplineInfo`	`updateMinorDiscipline(String minorDisciplineId, String minorDisciplineTypeKey, MinorDisciplineInfo minorDisciplineInfo, ContextInfo contextInfo)` Updates a Minor Discipline
`ProgramRequirementInfo`	`updateProgramRequirement(String programRequirementId, String programRequirementTypeKey, ProgramRequirementInfo programRequirementInfo, ContextInfo contextInfo)` Updates a Program Requirement
`List<ValidationResultInfo>`	`validateCoreProgram(String validationType, CoreProgramInfo coreProgramInfo, ContextInfo contextInfo)` Validates a Core Program against its data dictionary
`List<ValidationResultInfo>`	`validateCredentialProgram(String validationType, CredentialProgramInfo credentialProgramInfo, ContextInfo contextInfo)` Validates a Credential Program against its data dictionary
`List<ValidationResultInfo>`	`validateHonorsProgram(String validationType, HonorsProgramInfo honorsProgramInfo, ContextInfo contextInfo)` Validates a Honors Program against its data dictionary
`List<ValidationResultInfo>`	`validateMajorDiscipline(String validationType, MajorDisciplineInfo majorDisciplineInfo, ContextInfo contextInfo)` Validates a Major discipline against its data dictionary
`List<ValidationResultInfo>`	`validateMinorDiscipline(String validationType, MinorDisciplineInfo minorDisciplineInfo, ContextInfo contextInfo)` Validates a Minor discipline against its data dictionary
`List<ValidationResultInfo>`	`validateProgramRequirement(String validationType, ProgramRequirementInfo programRequirementInfo, ContextInfo contextInfo)` Validates a Program Requirement against its data dictionary

Methods inherited from interface org.kuali.student.r2.core.search.service.SearchService
getSearchType, getSearchTypes, search

Methods inherited from interface org.kuali.student.r2.core.versionmanagement.service.VersionManagementService
getCurrentVersion, getCurrentVersionOnDate, getFirstVersion, getLatestVersion, getVersionBySequenceNumber, getVersions, getVersionsInDateRange

Methods inherited from interface org.kuali.student.r1.common.dictionary.service.DictionaryService
getObjectStructure, getObjectTypes

Method Detail

getCredentialProgram

CredentialProgramInfo getCredentialProgram(String credentialProgramId,
                                         ContextInfo contextInfo)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Retrieves a CredentialProgram

Parameters:: credentialProgramId - Unique Id of the CredentialProgram. Maps to cluId
Returns:: the created Credential Program
Throws:: DoesNotExistException - CredentialProgram does not exist; InvalidParameterException - invalid Credential Program; MissingParameterException - missing Credential Program; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; OperationFailedException; PermissionDeniedException

getCredentialProgramsByIds

List<CredentialProgramInfo> getCredentialProgramsByIds(List<String> credentialProgramIds,
                                                     ContextInfo contextInfo)
                                                       throws DoesNotExistException,
                                                              InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

Retrieves a list of CredentialPrograms corresponding to the given list of CredentialProgram Ids

Parameters:: credentialProgramIds - list of CredentialPrograms to be retrieved; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of CredentialProgram
Throws:: DoesNotExistException - an commentKey in list not found; InvalidParameterException - invalid commentKey; MissingParameterException - commentIds, contextInfo not specified; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

validateCredentialProgram

List<ValidationResultInfo> validateCredentialProgram(String validationType,
                                                   CredentialProgramInfo credentialProgramInfo,
                                                   ContextInfo contextInfo)
                                                     throws InvalidParameterException,
                                                            MissingParameterException,
                                                            OperationFailedException

Validates a Credential Program against its data dictionary

Parameters:: validationType - identifier of the extent of validation; credentialProgramInfo - Credential Program information to be tested
Returns:: results from performing the validation
Throws:: InvalidParameterException - invalid validationTypeKey, cluInfo; MissingParameterException - missing validationTypeKey, cluInfo; OperationFailedException - unable to complete request

createCredentialProgram

CredentialProgramInfo createCredentialProgram(String credentialProgramTypeKey,
                                            CredentialProgramInfo credentialProgramInfo,
                                            ContextInfo contextInfo)
                                              throws AlreadyExistsException,
                                                     DataValidationErrorException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Creates a Credential Program

Parameters:: credentialProgramInfo - credentialProgramInfo
Returns:: the created Credential Program
Throws:: AlreadyExistsException - The Credential Program already exists; DataValidationErrorException - One or more values invalid for this operation; InvalidParameterException - invalid Credential Program; MissingParameterException - missing Credential Program; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

createNewCredentialProgramVersion

CredentialProgramInfo createNewCredentialProgramVersion(String credentialProgramId,
                                                      String versionComment,
                                                      ContextInfo contextInfo)
                                                        throws DoesNotExistException,
                                                               InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException,
                                                               PermissionDeniedException,
                                                               VersionMismatchException,
                                                               DataValidationErrorException,
                                                               ReadOnlyException

Creates a new Credential Program version based on the current Credential Program

Parameters:: credentialProgramId - identifier for the Credential Program to be versioned; versionComment - comment for the current version
Returns:: the new versioned Credential Program information
Throws:: DoesNotExistException - Credential Program does not exist; InvalidParameterException - invalid credentialProgramId; MissingParameterException - invalid credentialProgramId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version; DataValidationErrorException; ReadOnlyException

setCurrentCredentialProgramVersion
```
StatusInfo setCurrentCredentialProgramVersion(String credentialProgramId,
                                            Date currentVersionStart,
                                            ContextInfo contextInfo)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     IllegalVersionSequencingException,
                                                     OperationFailedException,
                                                     PermissionDeniedException,
                                                     DataValidationErrorException
```
Sets a specific version of the Credential Program as current. The sequence number must be greater than the existing current Credential Program version. This will truncate the current version's end date to the currentVersionStart param. If a Major exists which is set to become current in the future, that Major's currentVersionStart and CurrentVersionEnd will be nullified. The currentVersionStart must be in the future to prevent changing historic data.

Parameters:
credentialProgramId - Version Specific Id of the Credential Program
currentVersionStart - Date when this Credential Program becomes current. Must be in the future and be after the most current Credential Program's start date.

Returns:
status of the operation (success or failure)

Throws:

DoesNotExistException - Credential Program for credentialProgramId does not exist

InvalidParameterException - invalid credentialProgramId, currentVersionStart

MissingParameterException - invalid credentialProgramId

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

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

DataValidationErrorException

updateCredentialProgram

CredentialProgramInfo updateCredentialProgram(String credentialProgramId,
                                            CredentialProgramInfo credentialProgramInfo,
                                            ContextInfo contextInfo)
                                              throws DataValidationErrorException,
                                                     DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     VersionMismatchException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Updates a Credential Program

Parameters:: credentialProgramInfo - credentialProgramInfo
Returns:: updated Credential Program
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - Credential Program not found; InvalidParameterException - invalid Credential Program; MissingParameterException - missing Credential Program; VersionMismatchException - The action was attempted on an out of date version; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

deleteCredentialProgram

StatusInfo deleteCredentialProgram(String credentialProgramId,
                                 ContextInfo contextInfo)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Deletes a Credential Program

Parameters:: credentialProgramId - identifier for credentialProgramId.Maps to cluId
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - Credential Program does not exist; InvalidParameterException - invalid credentialProgramId; MissingParameterException - invalid credentialProgramId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getMajorDiscipline

MajorDisciplineInfo getMajorDiscipline(String majorDisciplineId,
                                     ContextInfo contextInfo)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Retrieves a MajorDiscipline

Parameters:: majorDisciplineId - Unique Id of the MajorDiscipline. Maps to cluId
Returns:: the created MajorDiscipline
Throws:: DoesNotExistException - MajorDiscipline does not exist; InvalidParameterException - invalid MajorDiscipline; MissingParameterException - missing MajorDiscipline; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getMajorDisciplinesByIds

List<MajorDisciplineInfo> getMajorDisciplinesByIds(List<String> majorDisciplineIds,
                                                 ContextInfo contextInfo)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Retrieves a list of MajorDiscipline corresponding to the given list of major discipline Ids

Parameters:: majorDisciplineIds - list of MajorDisciplines to be retrieved; contextInfo - Context information containing the principalId and locale information about the caller of service operation
Returns:: list of MajorDiscipline
Throws:: DoesNotExistException - an commentKey in list not found; InvalidParameterException - invalid commentKey; MissingParameterException - commentIds, contextInfo not specified; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getMajorDisciplineIdsByCredentialProgramType

List<String> getMajorDisciplineIdsByCredentialProgramType(String programType,
                                                        ContextInfo contextInfo)
                                                          throws DoesNotExistException,
                                                                 InvalidParameterException,
                                                                 MissingParameterException,
                                                                 OperationFailedException

Retrieves the list of Major Discipline identifiers a given Credential Program Type.

Parameters:: programType - Type of Credential Program
Returns:: List of Major Discipline identifiers for the given Credential Program Type
Throws:: DoesNotExistException - program type not found; InvalidParameterException - invalid program type; MissingParameterException - program type is not specified; OperationFailedException - unable to complete request

getProgramVariationsByMajorDiscipline

List<ProgramVariationInfo> getProgramVariationsByMajorDiscipline(String majorDisciplineId,
                                                               ContextInfo contextInfo)
                                                                 throws DoesNotExistException,
                                                                        InvalidParameterException,
                                                                        MissingParameterException,
                                                                        OperationFailedException

Retrieves a list of program variations for a particular major

Parameters:: majorDisciplineId - Major Discipline Identifier
Returns:: list of program variations associated with the specified Major
Throws:: DoesNotExistException - Major not found; InvalidParameterException - invalid majorDisciplineId; MissingParameterException - majorDisciplineId not specified; OperationFailedException - unable to complete request

validateMajorDiscipline

List<ValidationResultInfo> validateMajorDiscipline(String validationType,
                                                 MajorDisciplineInfo majorDisciplineInfo,
                                                 ContextInfo contextInfo)
                                                   throws InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Validates a Major discipline against its data dictionary

Parameters:: validationType - identifier of the extent of validation; majorDisciplineInfo - Major discipline information to be tested
Returns:: results from performing the validation
Throws:: InvalidParameterException - invalid validationTypeKey, cluInfo; MissingParameterException - missing validationTypeKey, cluInfo; OperationFailedException - unable to complete request; PermissionDeniedException

createMajorDiscipline

MajorDisciplineInfo createMajorDiscipline(String majorDisciplineTypeKey,
                                        MajorDisciplineInfo majorDisciplineInfo,
                                        ContextInfo contextInfo)
                                          throws AlreadyExistsException,
                                                 DataValidationErrorException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Creates a Major Discipline Program

Parameters:: majorDisciplineInfo - majorDisciplineInfo
Returns:: the created Major Discipline
Throws:: AlreadyExistsException - The Major already exists; DataValidationErrorException - One or more values invalid for this operation; InvalidParameterException - invalid Major; MissingParameterException - missing Major; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

updateMajorDiscipline

MajorDisciplineInfo updateMajorDiscipline(String majorDisciplineId,
                                        MajorDisciplineInfo majorDisciplineInfo,
                                        ContextInfo contextInfo)
                                          throws DataValidationErrorException,
                                                 DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 VersionMismatchException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Updates a Major Discipline

Parameters:: majorDisciplineInfo - majorDisciplineInfo
Returns:: updated Major Discipline
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - Major not found; InvalidParameterException - invalid Major; MissingParameterException - missing Major; VersionMismatchException - The action was attempted on an out of date version; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

deleteMajorDiscipline

StatusInfo deleteMajorDiscipline(String majorDisciplineId,
                               ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Deletes a Major Discipline

Parameters:: majorDisciplineId - identifier for majorDisciplineId.Maps to cluId
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - Major does not exist; InvalidParameterException - invalid majorDisciplineId; MissingParameterException - invalid majorDisciplineId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

createNewMajorDisciplineVersion

MajorDisciplineInfo createNewMajorDisciplineVersion(String majorDisciplineId,
                                                  String versionComment,
                                                  ContextInfo contextInfo)
                                                    throws DoesNotExistException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException,
                                                           VersionMismatchException,
                                                           DataValidationErrorException,
                                                           ReadOnlyException

Creates a new Major Discipline version based on the current Major

Parameters:: majorDisciplineId - identifier for the Major Discipline to be versioned; versionComment - comment for the current version
Returns:: the new versioned Major Discipline information
Throws:: DoesNotExistException - Major does not exist; InvalidParameterException - invalid majorDisciplineId; MissingParameterException - invalid majorDisciplineId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version; DataValidationErrorException; ReadOnlyException

getHonorsProgram

HonorsProgramInfo getHonorsProgram(String honorsProgramId,
                                 ContextInfo contextInfo)
                                   throws DoesNotExistException,
                                          InvalidParameterException,
                                          MissingParameterException,
                                          OperationFailedException,
                                          PermissionDeniedException

Retrieves a HonorsProgram

Parameters:: honorsProgramId - Unique Id of the HonorsProgram. Maps to cluId
Returns:: the created Honors Program
Throws:: DoesNotExistException - HonorsProgram does not exist; InvalidParameterException - invalid Honors Program; MissingParameterException - missing Honors Program; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getHonorsProgramsByIds

List<HonorsProgramInfo> getHonorsProgramsByIds(List<String> honorsProgramIds,
                                             ContextInfo contextInfo)
                                               throws DoesNotExistException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Retrieves a list of honors program by Ids

Parameters:: honorsProgramIds -; contextInfo -
Returns:
Throws:: DoesNotExistException; InvalidParameterException; MissingParameterException; OperationFailedException; PermissionDeniedException

getHonorProgramIdsByCredentialProgramType

List<String> getHonorProgramIdsByCredentialProgramType(String programType,
                                                     ContextInfo contextInfo)
                                                       throws DoesNotExistException,
                                                              InvalidParameterException,
                                                              MissingParameterException,
                                                              OperationFailedException

Retrieves the list of Honors Program Program a given Credential Program Type.

Parameters:: programType - Type of Credential Program
Returns:: List of Honors Programs for the given Credential Program Type
Throws:: DoesNotExistException - program type not found; InvalidParameterException - invalid program type; MissingParameterException - program type is not specified; OperationFailedException - unable to complete request

validateHonorsProgram

List<ValidationResultInfo> validateHonorsProgram(String validationType,
                                               HonorsProgramInfo honorsProgramInfo,
                                               ContextInfo contextInfo)
                                                 throws InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException

Validates a Honors Program against its data dictionary

Parameters:: validationType - identifier of the extent of validation; honorsProgramInfo - Honors Program information to be tested
Returns:: results from performing the validation
Throws:: InvalidParameterException - invalid validationTypeKey, cluInfo; MissingParameterException - missing validationTypeKey, cluInfo; OperationFailedException - unable to complete request

createHonorsProgram

HonorsProgramInfo createHonorsProgram(String honorsProgramTypeKey,
                                    HonorsProgramInfo honorsProgramInfo,
                                    ContextInfo contextInfo)
                                      throws AlreadyExistsException,
                                             DataValidationErrorException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Creates a Honors Program

Parameters:: honorsProgramInfo - honorsProgramInfo
Returns:: the created Honors Program
Throws:: AlreadyExistsException - The Honors Program already exists; DataValidationErrorException - One or more values invalid for this operation; InvalidParameterException - invalid Honors Program; MissingParameterException - missing Honors Program; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

updateHonorsProgram

HonorsProgramInfo updateHonorsProgram(String honorsProgramId,
                                    String honorsProgramTypeKey,
                                    HonorsProgramInfo honorsProgramInfo,
                                    ContextInfo contextInfo)
                                      throws DataValidationErrorException,
                                             DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             VersionMismatchException,
                                             OperationFailedException,
                                             PermissionDeniedException

Updates a Honors Program

Parameters:: honorsProgramInfo - honorsProgramInfo
Returns:: updated Honors Program
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - Honors Program not found; InvalidParameterException - invalid Honors Program; MissingParameterException - missing Honors Program; VersionMismatchException - The action was attempted on an out of date version; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

deleteHonorsProgram

StatusInfo deleteHonorsProgram(String honorsProgramId,
                             ContextInfo contextInfo)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

Deletes a Honors Program

Parameters:: honorsProgramId - identifier for honorsProgramId.Maps to cluId
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - Honors Program does not exist; InvalidParameterException - invalid honorsProgramId; MissingParameterException - invalid honorsProgramId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCoreProgram

CoreProgramInfo getCoreProgram(String coreProgramId,
                             ContextInfo contextInfo)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

Retrieves a Core Program

Parameters:: coreProgramId - Unique Id of the Core Program. Maps to cluId
Returns:: the Core Program
Throws:: DoesNotExistException - Program Requirement does not exist; InvalidParameterException - invalid Program Requirement; MissingParameterException - missing Program Requirement; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getCoreProgramsByIds

List<CoreProgramInfo> getCoreProgramsByIds(List<String> coreProgramIds,
                                         ContextInfo contextInfo)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Retrieves a list of core program by Ids

Parameters:: coreProgramIds -; contextInfo -
Returns:
Throws:: DoesNotExistException; InvalidParameterException; MissingParameterException; OperationFailedException; PermissionDeniedException

validateCoreProgram

List<ValidationResultInfo> validateCoreProgram(String validationType,
                                             CoreProgramInfo coreProgramInfo,
                                             ContextInfo contextInfo)
                                               throws InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException

Validates a Core Program against its data dictionary

Parameters:: validationType - identifier of the extent of validation; coreProgramInfo - Core Program information to be tested
Returns:: results from performing the validation
Throws:: InvalidParameterException - invalid validationTypeKey, cluInfo; MissingParameterException - missing validationTypeKey, cluInfo; OperationFailedException - unable to complete request

createCoreProgram

CoreProgramInfo createCoreProgram(String coreProgramTypeKey,
                                CoreProgramInfo coreProgramInfo,
                                ContextInfo contextInfo)
                                  throws AlreadyExistsException,
                                         DataValidationErrorException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         DoesNotExistException

Creates a Core Program

Parameters:: coreProgramInfo - coreProgramInfo
Returns:: the created Core Program
Throws:: AlreadyExistsException - The Core Program already exists; DataValidationErrorException - One or more values invalid for this operation; InvalidParameterException - invalid Core Program; MissingParameterException - missing Core Program; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; DoesNotExistException

createNewCoreProgramVersion

CoreProgramInfo createNewCoreProgramVersion(String coreProgramId,
                                          String versionComment,
                                          ContextInfo contextInfo)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException,
                                                   VersionMismatchException,
                                                   DataValidationErrorException,
                                                   ReadOnlyException

Creates a new Core Program version based on the current Core Program

Parameters:: coreProgramId - identifier for the Core Program to be versioned; versionComment - comment for the current version
Returns:: the new versioned Core Program information
Throws:: DoesNotExistException - Core Program does not exist; InvalidParameterException - invalid coreProgramId; MissingParameterException - invalid coreProgramId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure; VersionMismatchException - The action was attempted on an out of date version; DataValidationErrorException; ReadOnlyException

setCurrentCoreProgramVersion
```
StatusInfo setCurrentCoreProgramVersion(String coreProgramId,
                                      Date currentVersionStart,
                                      ContextInfo contextInfo)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               IllegalVersionSequencingException,
                                               OperationFailedException,
                                               PermissionDeniedException,
                                               DataValidationErrorException
```
Sets a specific version of the Core Program as current. The sequence number must be greater than the existing current Core Program version. This will truncate the current version's end date to the currentVersionStart param. If a Major exists which is set to become current in the future, that Major's currentVersionStart and CurrentVersionEnd will be nullified. The currentVersionStart must be in the future to prevent changing historic data.

Parameters:
coreProgramId - Version Specific Id of the Core Program
currentVersionStart - Date when this Core Program becomes current. Must be in the future and be after the most current major's start date.

Returns:
status of the operation (success or failure)

Throws:

DoesNotExistException - Core Program for coreProgramId does not exist

InvalidParameterException - invalid coreProgramId, currentVersionStart

MissingParameterException - invalid coreProgramId

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

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

DataValidationErrorException

updateCoreProgram

CoreProgramInfo updateCoreProgram(String coreProgramId,
                                String coreProgramTypeKey,
                                CoreProgramInfo coreProgramInfo,
                                ContextInfo contextInfo)
                                  throws DataValidationErrorException,
                                         DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         VersionMismatchException,
                                         OperationFailedException,
                                         PermissionDeniedException

Updates a Core Program

Parameters:: coreProgramInfo - coreProgramInfo
Returns:: updated Core Program
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - Core Program not found; InvalidParameterException - invalid Core Program; MissingParameterException - missing Core Program; VersionMismatchException - The action was attempted on an out of date version; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

deleteCoreProgram

StatusInfo deleteCoreProgram(String coreProgramId,
                           ContextInfo contextInfo)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Deletes a Core Program

Parameters:: coreProgramId - identifier for coreProgramId.Maps to cluId
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - Core Program does not exist; InvalidParameterException - invalid coreProgramId; MissingParameterException - invalid coreProgramId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getProgramRequirement

ProgramRequirementInfo getProgramRequirement(String programRequirementId,
                                           ContextInfo contextInfo)
                                             throws DoesNotExistException,
                                                    InvalidParameterException,
                                                    MissingParameterException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Retrieves a ProgramRequirement

Parameters:: programRequirementId - Unique Id of the ProgramRequirement. Maps to cluId
Returns:: the Program Requirement
Throws:: DoesNotExistException - Program Requirement does not exist; InvalidParameterException - invalid Program Requirement; MissingParameterException - missing Program Requirement; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getProgramRequirementsByIds

List<ProgramRequirementInfo> getProgramRequirementsByIds(List<String> programRequirementIds,
                                                       ContextInfo contextInfo)
                                                         throws DoesNotExistException,
                                                                InvalidParameterException,
                                                                MissingParameterException,
                                                                OperationFailedException,
                                                                PermissionDeniedException

Retrieves a list of ProgramRequirements by Ids

Parameters:: programRequirementIds -; contextInfo -
Returns:
Throws:: DoesNotExistException; InvalidParameterException; MissingParameterException; OperationFailedException; PermissionDeniedException

validateProgramRequirement

List<ValidationResultInfo> validateProgramRequirement(String validationType,
                                                    ProgramRequirementInfo programRequirementInfo,
                                                    ContextInfo contextInfo)
                                                      throws InvalidParameterException,
                                                             MissingParameterException,
                                                             OperationFailedException

Validates a Program Requirement against its data dictionary

Parameters:: validationType - identifier of the extent of validation; programRequirementInfo - Program Requirement information to be tested
Returns:: results from performing the validation
Throws:: InvalidParameterException - invalid validationTypeKey, cluInfo; MissingParameterException - missing validationTypeKey, cluInfo; OperationFailedException - unable to complete request

createProgramRequirement

ProgramRequirementInfo createProgramRequirement(String programRequirementTypeKey,
                                              ProgramRequirementInfo programRequirementInfo,
                                              ContextInfo contextInfo)
                                                throws AlreadyExistsException,
                                                       DataValidationErrorException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Creates a Program Requirement

Parameters:: programRequirementInfo - programRequirementInfo
Returns:: the created Program Requirement
Throws:: AlreadyExistsException - The Program Requirement already exists; DataValidationErrorException - One or more values invalid for this operation; InvalidParameterException - invalid Program Requirement; MissingParameterException - missing Program Requirement; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

updateProgramRequirement

ProgramRequirementInfo updateProgramRequirement(String programRequirementId,
                                              String programRequirementTypeKey,
                                              ProgramRequirementInfo programRequirementInfo,
                                              ContextInfo contextInfo)
                                                throws DataValidationErrorException,
                                                       DoesNotExistException,
                                                       InvalidParameterException,
                                                       MissingParameterException,
                                                       VersionMismatchException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Updates a Program Requirement

Parameters:: programRequirementInfo - programRequirementInfo
Returns:: updated Program Requirement
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - Program Requirement not found; InvalidParameterException - invalid Program Requirement; MissingParameterException - missing Program Requirement; VersionMismatchException - The action was attempted on an out of date version; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

deleteProgramRequirement

StatusInfo deleteProgramRequirement(String programRequirementId,
                                  ContextInfo contextInfo)
                                    throws DoesNotExistException,
                                           InvalidParameterException,
                                           MissingParameterException,
                                           OperationFailedException,
                                           PermissionDeniedException

Deletes a Program Requirement

Parameters:: programRequirementId - identifier for programRequirementId.Maps to cluId
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - Program Requirement does not exist; InvalidParameterException - invalid programRequirementId; MissingParameterException - invalid programRequirementId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

setCurrentMajorDisciplineVersion
```
StatusInfo setCurrentMajorDisciplineVersion(String majorDisciplineId,
                                          Date currentVersionStart,
                                          ContextInfo contextInfo)
                                            throws DoesNotExistException,
                                                   InvalidParameterException,
                                                   MissingParameterException,
                                                   IllegalVersionSequencingException,
                                                   OperationFailedException,
                                                   PermissionDeniedException,
                                                   DataValidationErrorException
```
Sets a specific version of the Major as current. The sequence number must be greater than the existing current Major version. This will truncate the current version's end date to the currentVersionStart param. If a Major exists which is set to become current in the future, that Major's currentVersionStart and CurrentVersionEnd will be nullified. The currentVersionStart must be in the future to prevent changing historic data.

Parameters:
majorDisciplineId - Version Specific Id of the Major Discipline
currentVersionStart - Date when this Major becomes current. Must be in the future and be after the most current major's start date.

Returns:
status of the operation (success or failure)

Throws:

DoesNotExistException - Major for majorVersionId does not exist

InvalidParameterException - invalid majorVersionId, currentVersionStart

MissingParameterException - invalid majorVersionId

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

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

DataValidationErrorException

getMinorDiscipline

MinorDisciplineInfo getMinorDiscipline(String minorDisciplineId,
                                     ContextInfo contextInfo)
                                       throws DoesNotExistException,
                                              InvalidParameterException,
                                              MissingParameterException,
                                              OperationFailedException,
                                              PermissionDeniedException

Retrieves a MinorDiscipline

Parameters:: minorDisciplineId - Unique Id of the MinorDiscipline. Maps to cluId
Returns:: the created MinorDiscipline
Throws:: DoesNotExistException - MinorDiscipline does not exist; InvalidParameterException - invalid MinorDiscipline; MissingParameterException - missing MinorDiscipline; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getMinorsByCredentialProgramType

List<String> getMinorsByCredentialProgramType(String programType,
                                            ContextInfo contextInfo)
                                              throws DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException

Retrieves the list of Minor Discipline Program a given Credential Program Type.

Parameters:: programType - Type of Credential Program
Returns:: List of Minor Disciplines for the given Credential Program Type
Throws:: DoesNotExistException - program type not found; InvalidParameterException - invalid program type; MissingParameterException - program type is not specified; OperationFailedException - unable to complete request

validateMinorDiscipline

List<ValidationResultInfo> validateMinorDiscipline(String validationType,
                                                 MinorDisciplineInfo minorDisciplineInfo,
                                                 ContextInfo contextInfo)
                                                   throws InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException

Validates a Minor discipline against its data dictionary

Parameters:: validationType - identifier of the extent of validation; minorDisciplineInfo - Minor discipline information to be tested
Returns:: results from performing the validation
Throws:: InvalidParameterException - invalid validationTypeKey, cluInfo; MissingParameterException - missing validationTypeKey, cluInfo; OperationFailedException - unable to complete request

createMinorDiscipline

MinorDisciplineInfo createMinorDiscipline(String minorDisciplineTypeKey,
                                        MinorDisciplineInfo minorDisciplineInfo,
                                        ContextInfo contextInfo)
                                          throws AlreadyExistsException,
                                                 DataValidationErrorException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Creates a Minor Discipline Program

Parameters:: minorDisciplineInfo - minorDisciplineInfo
Returns:: the created Minor Discipline
Throws:: AlreadyExistsException - The Minor already exists; DataValidationErrorException - One or more values invalid for this operation; InvalidParameterException - invalid Minor; MissingParameterException - missing Minor; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

updateMinorDiscipline

MinorDisciplineInfo updateMinorDiscipline(String minorDisciplineId,
                                        String minorDisciplineTypeKey,
                                        MinorDisciplineInfo minorDisciplineInfo,
                                        ContextInfo contextInfo)
                                          throws DataValidationErrorException,
                                                 DoesNotExistException,
                                                 InvalidParameterException,
                                                 MissingParameterException,
                                                 VersionMismatchException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Updates a Minor Discipline

Parameters:: minorDisciplineInfo - minorDisciplineInfo
Returns:: updated Minor Discipline
Throws:: DataValidationErrorException - One or more values invalid for this operation; DoesNotExistException - Minor not found; InvalidParameterException - invalid Minor; MissingParameterException - missing Minor; VersionMismatchException - The action was attempted on an out of date version; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

deleteMinorDiscipline

StatusInfo deleteMinorDiscipline(String minorDisciplineId,
                               ContextInfo contextInfo)
                                 throws DoesNotExistException,
                                        InvalidParameterException,
                                        MissingParameterException,
                                        OperationFailedException,
                                        PermissionDeniedException

Deletes a Minor Discipline

Parameters:: minorDisciplineId - identifier for minorDisciplineId.Maps to cluId
Returns:: status of the operation (success or failure)
Throws:: DoesNotExistException - Minor does not exist; InvalidParameterException - invalid minorDisciplineId; MissingParameterException - invalid minorDisciplineId; OperationFailedException - unable to complete request; PermissionDeniedException - authorization failure

getVariationsByMajorDisciplineId

@Deprecated
List<ProgramVariationInfo> getVariationsByMajorDisciplineId(String majorDisciplineId,
                                                                     ContextInfo contextInfo)
                                                            throws DoesNotExistException,
                                                                   InvalidParameterException,
                                                                   MissingParameterException,
                                                                   OperationFailedException

Deprecated.

Throws:: DoesNotExistException; InvalidParameterException; MissingParameterException; OperationFailedException

Interface ProgramService