ProgramService

Name Program
Version
Included Services VersionManagementService, SearchService, DictionaryService
Java Package org.kuali.student.r2.lum.program.service

The Program Service allows for the creation and management of programs.

Operations
Main Message Structures

Method getCredentialProgram
Description Retrieves a CredentialProgram
Parameters String credentialProgramId Unique Id of the CredentialProgram. Maps to
cluId
ContextInfo contextInfo ???
Return CredentialProgramInfo the created Credential Program
Errors DoesNotExistException CredentialProgram does not exist
InvalidParameterException invalid Credential Program
MissingParameterException missing Credential Program
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method getCredentialProgramsByIds
Description Retrieves a list of CredentialPrograms corresponding to the given list of
CredentialProgram Ids
Parameters StringList credentialProgramIds ???
ContextInfo contextInfo Context information containing the principalId and
locale information about the caller of service operation
Return CredentialProgramInfoList list of CredentialProgram
Errors DoesNotExistException an commentKey in list not found
InvalidParameterException invalid commentKey
MissingParameterException commentIds, contextInfo not specified
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method validateCredentialProgram
Description Validates a Credential Program against its data dictionary
Parameters String validationType identifier of the extent of validation
CredentialProgramInfo credentialProgramInfo Credential Program information to be tested
ContextInfo contextInfo ???
Return ValidationResultInfoList results from performing the validation
Errors InvalidParameterException invalid validationTypeKey, cluInfo
MissingParameterException missing validationTypeKey, cluInfo
OperationFailedException unable to complete request

Back to Operations

Method createCredentialProgram
Description Creates a Credential Program
Parameters String credentialProgramTypeKey ???
CredentialProgramInfo credentialProgramInfo credentialProgramInfo
ContextInfo contextInfo ???
Return CredentialProgramInfo the created Credential Program
Errors 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

Back to Operations

Method createNewCredentialProgramVersion
Description Creates a new Credential Program version based on the current Credential
Program
Parameters String credentialProgramId identifier for the Credential Program to be
versioned
String versionComment comment for the current version
ContextInfo contextInfo ???
Return CredentialProgramInfo the new versioned Credential Program information
Errors 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 ???

Back to Operations

Method setCurrentCredentialProgramVersion
Description 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 String credentialProgramId Version Specific Id of the Credential Program
Date currentVersionStart Date when this Credential Program becomes
current. Must be in the future and be after the most current
Credential Program's start date.
ContextInfo contextInfo ???
Return StatusInfo status of the operation (success or failure)
Errors 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 ???

Back to Operations

Method updateCredentialProgram
Description Updates a Credential Program
Parameters String credentialProgramId ???
CredentialProgramInfo credentialProgramInfo credentialProgramInfo
ContextInfo contextInfo ???
Return CredentialProgramInfo updated Credential Program
Errors 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

Back to Operations

Method deleteCredentialProgram
Description Deletes a Credential Program
Parameters String credentialProgramId identifier for credentialProgramId.Maps to
cluId
ContextInfo contextInfo ???
Return StatusInfo status of the operation (success or failure)
Errors DoesNotExistException Credential Program does not exist
InvalidParameterException invalid credentialProgramId
MissingParameterException invalid credentialProgramId
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method getMajorDiscipline
Description Retrieves a MajorDiscipline
Parameters String majorDisciplineId Unique Id of the MajorDiscipline. Maps to cluId
ContextInfo contextInfo ???
Return MajorDisciplineInfo the created MajorDiscipline
Errors DoesNotExistException MajorDiscipline does not exist
InvalidParameterException invalid MajorDiscipline
MissingParameterException missing MajorDiscipline
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method getMajorDisciplinesByIds
Description Retrieves a list of MajorDiscipline corresponding to the given list of
major discipline Ids
Parameters StringList majorDisciplineIds ???
ContextInfo contextInfo Context information containing the principalId and
locale information about the caller of service operation
Return MajorDisciplineInfoList list of MajorDiscipline
Errors DoesNotExistException an commentKey in list not found
InvalidParameterException invalid commentKey
MissingParameterException commentIds, contextInfo not specified
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method getMajorDisciplineIdsByCredentialProgramType
Description Retrieves the list of Major Discipline identifiers a given Credential
Program Type.
Parameters String programType Type of Credential Program
ContextInfo contextInfo ???
Return StringList List of Major Discipline identifiers for the given Credential
Program Type
Errors DoesNotExistException program type not found
InvalidParameterException invalid program type
MissingParameterException program type is not specified
OperationFailedException unable to complete request

Back to Operations

Method getProgramVariationsByMajorDiscipline
Description Retrieves a list of program variations for a particular major
Parameters String majorDisciplineId Major Discipline Identifier
ContextInfo contextInfo ???
Return ProgramVariationInfoList list of program variations associated with the specified Major
Errors DoesNotExistException Major not found
InvalidParameterException invalid majorDisciplineId
MissingParameterException majorDisciplineId not specified
OperationFailedException unable to complete request

Back to Operations

Method validateMajorDiscipline
Description Validates a Major discipline against its data dictionary
Parameters String validationType identifier of the extent of validation
MajorDisciplineInfo majorDisciplineInfo Major discipline information to be tested
ContextInfo contextInfo ???
Return ValidationResultInfoList results from performing the validation
Errors InvalidParameterException invalid validationTypeKey, cluInfo
MissingParameterException missing validationTypeKey, cluInfo
OperationFailedException unable to complete request
PermissionDeniedException ???

Back to Operations

Method createMajorDiscipline
Description Creates a Major Discipline Program
Parameters String majorDisciplineTypeKey ???
MajorDisciplineInfo majorDisciplineInfo majorDisciplineInfo
ContextInfo contextInfo ???
Return MajorDisciplineInfo the created Major Discipline
Errors 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

Back to Operations

Method updateMajorDiscipline
Description Updates a Major Discipline
Parameters String majorDisciplineId ???
MajorDisciplineInfo majorDisciplineInfo majorDisciplineInfo
ContextInfo contextInfo ???
Return MajorDisciplineInfo updated Major Discipline
Errors 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

Back to Operations

Method deleteMajorDiscipline
Description Deletes a Major Discipline
Parameters String majorDisciplineId identifier for majorDisciplineId.Maps to cluId
ContextInfo contextInfo ???
Return StatusInfo status of the operation (success or failure)
Errors DoesNotExistException Major does not exist
InvalidParameterException invalid majorDisciplineId
MissingParameterException invalid majorDisciplineId
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method createNewMajorDisciplineVersion
Description Creates a new Major Discipline version based on the current Major
Parameters String majorDisciplineId identifier for the Major Discipline to be
versioned
String versionComment comment for the current version
ContextInfo contextInfo ???
Return MajorDisciplineInfo the new versioned Major Discipline information
Errors 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 ???

Back to Operations

Method getHonorsProgram
Description Retrieves a HonorsProgram
Parameters String honorsProgramId Unique Id of the HonorsProgram. Maps to cluId
ContextInfo contextInfo ???
Return HonorsProgramInfo the created Honors Program
Errors DoesNotExistException HonorsProgram does not exist
InvalidParameterException invalid Honors Program
MissingParameterException missing Honors Program
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method getHonorsProgramsByIds
Description Retrieves a list of honors program by Ids
Parameters StringList honorsProgramIds ???
ContextInfo contextInfo ???
Return HonorsProgramInfoList ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException ???

Back to Operations

Method getHonorProgramIdsByCredentialProgramType
Description Retrieves the list of Honors Program Program a given Credential Program
Type.
Parameters String programType Type of Credential Program
ContextInfo contextInfo ???
Return StringList List of Honors Programs for the given Credential Program Type
Errors DoesNotExistException program type not found
InvalidParameterException invalid program type
MissingParameterException program type is not specified
OperationFailedException unable to complete request

Back to Operations

Method validateHonorsProgram
Description Validates a Honors Program against its data dictionary
Parameters String validationType identifier of the extent of validation
HonorsProgramInfo honorsProgramInfo Honors Program information to be tested
ContextInfo contextInfo ???
Return ValidationResultInfoList results from performing the validation
Errors InvalidParameterException invalid validationTypeKey, cluInfo
MissingParameterException missing validationTypeKey, cluInfo
OperationFailedException unable to complete request

Back to Operations

Method createHonorsProgram
Description Creates a Honors Program
Parameters String honorsProgramTypeKey ???
HonorsProgramInfo honorsProgramInfo honorsProgramInfo
ContextInfo contextInfo ???
Return HonorsProgramInfo the created Honors Program
Errors 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

Back to Operations

Method updateHonorsProgram
Description Updates a Honors Program
Parameters String honorsProgramId ???
String honorsProgramTypeKey ???
HonorsProgramInfo honorsProgramInfo honorsProgramInfo
ContextInfo contextInfo ???
Return HonorsProgramInfo updated Honors Program
Errors 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

Back to Operations

Method deleteHonorsProgram
Description Deletes a Honors Program
Parameters String honorsProgramId identifier for honorsProgramId.Maps to cluId
ContextInfo contextInfo ???
Return StatusInfo status of the operation (success or failure)
Errors DoesNotExistException Honors Program does not exist
InvalidParameterException invalid honorsProgramId
MissingParameterException invalid honorsProgramId
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method getCoreProgram
Description Retrieves a Core Program
Parameters String coreProgramId Unique Id of the Core Program. Maps to cluId
ContextInfo contextInfo ???
Return CoreProgramInfo the Core Program
Errors DoesNotExistException Program Requirement does not exist
InvalidParameterException invalid Program Requirement
MissingParameterException missing Program Requirement
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method getCoreProgramsByIds
Description Retrieves a list of core program by Ids
Parameters StringList coreProgramIds ???
ContextInfo contextInfo ???
Return CoreProgramInfoList ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException ???

Back to Operations

Method validateCoreProgram
Description Validates a Core Program against its data dictionary
Parameters String validationType identifier of the extent of validation
CoreProgramInfo coreProgramInfo Core Program information to be tested
ContextInfo contextInfo ???
Return ValidationResultInfoList results from performing the validation
Errors InvalidParameterException invalid validationTypeKey, cluInfo
MissingParameterException missing validationTypeKey, cluInfo
OperationFailedException unable to complete request

Back to Operations

Method createCoreProgram
Description Creates a Core Program
Parameters String coreProgramTypeKey ???
CoreProgramInfo coreProgramInfo coreProgramInfo
ContextInfo contextInfo ???
Return CoreProgramInfo the created Core Program
Errors 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 ???

Back to Operations

Method createNewCoreProgramVersion
Description Creates a new Core Program version based on the current Core Program
Parameters String coreProgramId identifier for the Core Program to be versioned
String versionComment comment for the current version
ContextInfo contextInfo ???
Return CoreProgramInfo the new versioned Core Program information
Errors 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 ???

Back to Operations

Method setCurrentCoreProgramVersion
Description 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 String coreProgramId Version Specific Id of the Core Program
Date currentVersionStart Date when this Core Program becomes current.
Must be in the future and be after the most current major's
start date.
ContextInfo contextInfo ???
Return StatusInfo status of the operation (success or failure)
Errors 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 ???

Back to Operations

Method updateCoreProgram
Description Updates a Core Program
Parameters String coreProgramId ???
String coreProgramTypeKey ???
CoreProgramInfo coreProgramInfo coreProgramInfo
ContextInfo contextInfo ???
Return CoreProgramInfo updated Core Program
Errors 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

Back to Operations

Method deleteCoreProgram
Description Deletes a Core Program
Parameters String coreProgramId identifier for coreProgramId.Maps to cluId
ContextInfo contextInfo ???
Return StatusInfo status of the operation (success or failure)
Errors DoesNotExistException Core Program does not exist
InvalidParameterException invalid coreProgramId
MissingParameterException invalid coreProgramId
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method getProgramRequirement
Description Retrieves a ProgramRequirement
Parameters String programRequirementId Unique Id of the ProgramRequirement. Maps to
cluId
ContextInfo contextInfo ???
Return ProgramRequirementInfo the Program Requirement
Errors DoesNotExistException Program Requirement does not exist
InvalidParameterException invalid Program Requirement
MissingParameterException missing Program Requirement
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method getProgramRequirementsByIds
Description Retrieves a list of ProgramRequirements by Ids
Parameters StringList programRequirementIds ???
ContextInfo contextInfo ???
Return ProgramRequirementInfoList ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException ???

Back to Operations

Method validateProgramRequirement
Description Validates a Program Requirement against its data dictionary
Parameters String validationType identifier of the extent of validation
ProgramRequirementInfo programRequirementInfo Program Requirement information to be
tested
ContextInfo contextInfo ???
Return ValidationResultInfoList results from performing the validation
Errors InvalidParameterException invalid validationTypeKey, cluInfo
MissingParameterException missing validationTypeKey, cluInfo
OperationFailedException unable to complete request

Back to Operations

Method createProgramRequirement
Description Creates a Program Requirement
Parameters String programRequirementTypeKey ???
ProgramRequirementInfo programRequirementInfo programRequirementInfo
ContextInfo contextInfo ???
Return ProgramRequirementInfo the created Program Requirement
Errors 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

Back to Operations

Method updateProgramRequirement
Description Updates a Program Requirement
Parameters String programRequirementId ???
String programRequirementTypeKey ???
ProgramRequirementInfo programRequirementInfo programRequirementInfo
ContextInfo contextInfo ???
Return ProgramRequirementInfo updated Program Requirement
Errors 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

Back to Operations

Method deleteProgramRequirement
Description Deletes a Program Requirement
Parameters String programRequirementId identifier for programRequirementId.Maps to
cluId
ContextInfo contextInfo ???
Return StatusInfo status of the operation (success or failure)
Errors DoesNotExistException Program Requirement does not exist
InvalidParameterException invalid programRequirementId
MissingParameterException invalid programRequirementId
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method setCurrentMajorDisciplineVersion
Description 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 String majorDisciplineId Version Specific Id of the Major Discipline
Date currentVersionStart Date when this Major becomes current. Must be
in the future and be after the most current major's start
date.
ContextInfo contextInfo ???
Return StatusInfo status of the operation (success or failure)
Errors 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 ???

Back to Operations

Method getMinorDiscipline
Description Retrieves a MinorDiscipline
Parameters String minorDisciplineId Unique Id of the MinorDiscipline. Maps to cluId
ContextInfo contextInfo ???
Return MinorDisciplineInfo the created MinorDiscipline
Errors DoesNotExistException MinorDiscipline does not exist
InvalidParameterException invalid MinorDiscipline
MissingParameterException missing MinorDiscipline
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method getMinorsByCredentialProgramType
Description Retrieves the list of Minor Discipline Program a given Credential Program
Type.
Parameters String programType Type of Credential Program
ContextInfo contextInfo ???
Return StringList List of Minor Disciplines for the given Credential Program Type
Errors DoesNotExistException program type not found
InvalidParameterException invalid program type
MissingParameterException program type is not specified
OperationFailedException unable to complete request

Back to Operations

Method validateMinorDiscipline
Description Validates a Minor discipline against its data dictionary
Parameters String validationType identifier of the extent of validation
MinorDisciplineInfo minorDisciplineInfo Minor discipline information to be tested
ContextInfo contextInfo ???
Return ValidationResultInfoList results from performing the validation
Errors InvalidParameterException invalid validationTypeKey, cluInfo
MissingParameterException missing validationTypeKey, cluInfo
OperationFailedException unable to complete request

Back to Operations

Method createMinorDiscipline
Description Creates a Minor Discipline Program
Parameters String minorDisciplineTypeKey ???
MinorDisciplineInfo minorDisciplineInfo minorDisciplineInfo
ContextInfo contextInfo ???
Return MinorDisciplineInfo the created Minor Discipline
Errors 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

Back to Operations

Method updateMinorDiscipline
Description Updates a Minor Discipline
Parameters String minorDisciplineId ???
String minorDisciplineTypeKey ???
MinorDisciplineInfo minorDisciplineInfo minorDisciplineInfo
ContextInfo contextInfo ???
Return MinorDisciplineInfo updated Minor Discipline
Errors 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

Back to Operations

Method deleteMinorDiscipline
Description Deletes a Minor Discipline
Parameters String minorDisciplineId identifier for minorDisciplineId.Maps to cluId
ContextInfo contextInfo ???
Return StatusInfo status of the operation (success or failure)
Errors DoesNotExistException Minor does not exist
InvalidParameterException invalid minorDisciplineId
MissingParameterException invalid minorDisciplineId
OperationFailedException unable to complete request
PermissionDeniedException authorization failure

Back to Operations

Method getVariationsByMajorDisciplineId
Description This method ...
============== Deprecated ===============
Parameters String majorDisciplineId ???
ContextInfo contextInfo ???
Return ProgramVariationInfoList ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???

Back to Operations