public interface ExamOfferingService
Modifier and Type | Method and Description |
---|---|
StatusInfo |
changeExamOfferingState(String examOfferingId,
String stateKey,
ContextInfo contextInfo)
Change the state of an exam offering.
|
ExamOfferingInfo |
createExamOffering(String termId,
String examId,
String examTypeKey,
ExamOfferingInfo examOfferingInfo,
ContextInfo contextInfo)
Creates a new Exam Offering.
|
ExamOfferingRelationInfo |
createExamOfferingRelation(String formatOfferingId,
String examOfferingId,
String examOfferingTypeKey,
ExamOfferingRelationInfo examOfferingRelationInfo,
ContextInfo contextInfo)
Creates a new ExamOfferingRelation.
|
StatusInfo |
deleteExamOffering(String examOfferingId,
ContextInfo contextInfo)
Deletes an existing exam offering.
|
StatusInfo |
deleteExamOfferingRelation(String examOfferingRelationId,
ContextInfo contextInfo)
Deletes an existing ExamOfferingRelation.
|
ExamOfferingInfo |
getExamOffering(String examOfferingId,
ContextInfo contextInfo)
Retrieves information about an exam offering.
|
List<String> |
getExamOfferingIdsByType(String examTypeKey,
ContextInfo contextInfo)
Retrieve a list of ExamOffering Ids by Exam Type.
|
ExamOfferingRelationInfo |
getExamOfferingRelation(String examOfferingRelationId,
ContextInfo contextInfo)
Retrieves information about a ExamOfferingRelation relationship object.
|
List<String> |
getExamOfferingRelationIdsByActivityOffering(String activityOfferingId,
ContextInfo contextInfo)
Retrieves a list of ExamOfferingRelations Ids that are associated with an ActivityOffering id.
|
List<String> |
getExamOfferingRelationIdsByType(String relationshipTypeKey,
ContextInfo contextInfo)
Retrieves a list of ExamOfferingRelation Ids by relation type.
|
List<ExamOfferingRelationInfo> |
getExamOfferingRelationsByExamOffering(String examOfferingId,
ContextInfo contextInfo)
Retrieves a list of ExamOfferingRelations to the given ExamOffering.
|
List<ExamOfferingRelationInfo> |
getExamOfferingRelationsByFormatOffering(String formatOfferingId,
ContextInfo contextInfo)
Retrieves a list of ExamOfferingRelations to the given FormatOffering.
|
List<ExamOfferingRelationInfo> |
getExamOfferingRelationsByIds(List<String> examOfferingRelationIds,
ContextInfo contextInfo)
Retrieves a list of ExamOfferingRelations from a list of ids.
|
List<ExamOfferingInfo> |
getExamOfferingsByExamPeriod(String examPeriodId,
ContextInfo contextInfo)
Retrieves a list of ExamOfferings that are associated with a specified ExamPeriod id.
|
List<ExamOfferingInfo> |
getExamOfferingsByIds(List<String> examOfferingIds,
ContextInfo contextInfo)
Retrieves the information for the specified list of ExamOfferings (that match the given Ids).
|
List<String> |
searchForExamOfferingIds(QueryByCriteria criteria,
ContextInfo contextInfo)
Searches for ExamOfferings that meet the given search criteria.
|
List<String> |
searchForExamOfferingRelationIds(QueryByCriteria criteria,
ContextInfo contextInfo)
Searches for ExamOfferingRelations that meet the given search criteria.
|
List<ExamOfferingRelationInfo> |
searchForExamOfferingRelations(QueryByCriteria criteria,
ContextInfo contextInfo)
Searches for ExamOfferingRelations that meet the given search criteria.
|
List<ExamOfferingInfo> |
searchForExamOfferings(QueryByCriteria criteria,
ContextInfo contextInfo)
Searches for ExamOfferings that meet the given search criteria.
|
ExamOfferingInfo |
updateExamOffering(String examOfferingId,
ExamOfferingInfo examOfferingInfo,
ContextInfo contextInfo)
Updates an existing exam offering.
|
ExamOfferingRelationInfo |
updateExamOfferingRelation(String examOfferingRelationId,
ExamOfferingRelationInfo examOfferingRelationInfo,
ContextInfo contextInfo)
Updates an existing ExamOfferingRelation.
|
List<ValidationResultInfo> |
validateExamOffering(String termId,
String examId,
String examTypeKey,
String validationTypeKey,
ExamOfferingInfo examOfferingInfo,
ContextInfo contextInfo)
Validates an ExamOffering.
|
List<ValidationResultInfo> |
validateExamOfferingRelation(String formatOfferingId,
String examOfferingId,
String examOfferingTypeKey,
String validationTypeKey,
ExamOfferingRelationInfo examOfferingRelationInfo,
ContextInfo contextInfo)
Validates an ExamOfferingRelation.
|
ExamOfferingInfo getExamOffering(String examOfferingId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
examOfferingId
- the id of the examcontextInfo
- Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException
- if the exam offering does not existInvalidParameterException
- contextInfo is invalidMissingParameterException
- examOfferingId or contextInfo are absent (missing or null)OperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occuredList<ExamOfferingInfo> getExamOfferingsByIds(List<String> examOfferingIds, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
examOfferingIds
- List of identifiers for exam offeringscontextInfo
- Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException
- One or more examOfferingIds not foundInvalidParameterException
- contextInfo is invalidMissingParameterException
- examOfferingIds or contextInfo are absent (missing or null)OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<String> getExamOfferingIdsByType(String examTypeKey, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, DoesNotExistException
examTypeKey
- the identifier for an exam TypecontextInfo
- information containing the principalId and
locale information about the caller of
service operationInvalidParameterException
- contextInfo is not validMissingParameterException
- examTypeKey or contextInfo is
missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredDoesNotExistException
List<String> searchForExamOfferingIds(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
criteria
- the search criteriacontextInfo
- information containing the principalId and locale
information about the caller of service operationInvalidParameterException
- criteria or contextInfo is not validMissingParameterException
- criteria or contextInfo is missing or
nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredList<ExamOfferingInfo> searchForExamOfferings(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
criteria
- the search criteriacontextInfo
- information containing the principalId and locale
information about the caller of service operationInvalidParameterException
- criteria or contextInfo is not validMissingParameterException
- criteria or contextInfo is missing or
nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredList<ValidationResultInfo> validateExamOffering(String termId, String examId, String examTypeKey, String validationTypeKey, ExamOfferingInfo examOfferingInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
termId
- Unique key of the term for which the exam offering is being
validatedexamId
- Unique key of the canonical exam for which the exam offering is being
validatedexamTypeKey
- the identifier for the exam type to be validatedvalidationTypeKey
- the identifier for the validation TypeexamOfferingInfo
- the exam offering to be validatedcontextInfo
- information containing the principalId and
locale information about the caller of
service operationDoesNotExistException
- validationTypeKey or examTypeKey is not foundInvalidParameterException
- examOfferingInfo or contextInfo is not validMissingParameterException
- validationTypeKey, examTypeKey, examOfferingInfo, or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureExamOfferingInfo createExamOffering(String termId, String examId, String examTypeKey, ExamOfferingInfo examOfferingInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
termId
- Unique key of the term for which the exam offering is being
createdexamId
- Unique key of the canonical exam for which the exam offering is being
createdexamTypeKey
- a unique identifier for the Type of the new examexamOfferingInfo
- the data with which to create the examcontextInfo
- information containing the principalId and locale
information about the caller of service operationDataValidationErrorException
- supplied data is invalidDoesNotExistException
- examTypeKey does not exist or is not supportedInvalidParameterException
- examOfferingInfo or contextInfo is not validMissingParameterException
- examTypeKey, examOfferingInfo, or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredReadOnlyException
- an attempt at supplying information designated as read onlyExamOfferingInfo updateExamOffering(String examOfferingId, ExamOfferingInfo examOfferingInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
examOfferingId
- the identifier for the exam offering to be updatedexamOfferingInfo
- the new data for the exam offeringcontextInfo
- information containing the principalId and locale
information about the caller of service operationDataValidationErrorException
- supplied data is invalid (xml)DoesNotExistException
- examOfferingId is not foundInvalidParameterException
- examOfferingInfo or contextInfo is not validMissingParameterException
- examOfferingId, examOfferingInfo or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredReadOnlyException
- an attempt was made to change information designated as read onlyVersionMismatchException
- an optimistic locking failure or the action was attempted on an out
of data versionStatusInfo deleteExamOffering(String examOfferingId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
examOfferingId
- the identifier for the exam offering to be deletedcontextInfo
- information containing the principalId and locale
information about the caller of service operationDoesNotExistException
- examOfferingId is not foundInvalidParameterException
- contextInfo is not validMissingParameterException
- examOfferingId, or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredStatusInfo changeExamOfferingState(String examOfferingId, String stateKey, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
examOfferingId
- the identifier for the exam offering whose state is to be changedstateKey
- the state to change tocontextInfo
- information containing the principalId and locale
information about the caller of service operationDoesNotExistException
- examOfferingId is not foundInvalidParameterException
- contextInfo is not validMissingParameterException
- examOfferingId, or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredList<ExamOfferingInfo> getExamOfferingsByExamPeriod(String examPeriodId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
examPeriodId
- The id of the ExamPeriod these ExamOfferings are associated withcontextInfo
- Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException
- One or more examOfferingIds not foundInvalidParameterException
- contextInfo is invalidMissingParameterException
- examPeriodId or contextInfo are absent (missing or null)OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureList<ValidationResultInfo> validateExamOfferingRelation(String formatOfferingId, String examOfferingId, String examOfferingTypeKey, String validationTypeKey, ExamOfferingRelationInfo examOfferingRelationInfo, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
formatOfferingId
- Unique key of the FormatOffering for which the relation is being validatedexamOfferingId
- Unique key of the ExamOffering for which the relation is being validatedexamOfferingTypeKey
- the identifier of the ExamOfferingRelation type to be validatedvalidationTypeKey
- the identifier for the validation TypeexamOfferingRelationInfo
- the ExamOfferingRelation record to be validatedcontextInfo
- information containing the principalId and
locale information about the caller of
service operationDoesNotExistException
- validationTypeKey or examOfferingTypeKey is not foundInvalidParameterException
- examOfferingRelationInfo or contextInfo is not validMissingParameterException
- validationTypeKey, examOfferingTypeKey, examOfferingRelationInfo, or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureExamOfferingRelationInfo createExamOfferingRelation(String formatOfferingId, String examOfferingId, String examOfferingTypeKey, ExamOfferingRelationInfo examOfferingRelationInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException
formatOfferingId
- Unique key of the FormatOffering for which the relation is being createdexamOfferingId
- Unique key of the ExamOffering for which the relation is being createdexamOfferingTypeKey
- a unique identifier for the Type of the new ExamOfferingRelationexamOfferingRelationInfo
- the data with which to create the ExamOfferingRelationcontextInfo
- information containing the principalId and locale
information about the caller of service operationDataValidationErrorException
- supplied data is invalidDoesNotExistException
- examOfferingTypeKey does not exist or is not supportedInvalidParameterException
- examOfferingRelationInfo or contextInfo is not validMissingParameterException
- examOfferingTypeKey, examOfferingRelationInfo, or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredReadOnlyException
- an attempt at supplying information designated as read onlyExamOfferingRelationInfo updateExamOfferingRelation(String examOfferingRelationId, ExamOfferingRelationInfo examOfferingRelationInfo, ContextInfo contextInfo) throws DataValidationErrorException, DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException, ReadOnlyException, VersionMismatchException
examOfferingRelationId
- the identifier for the ExamOfferingRelation to be updatedexamOfferingRelationInfo
- the new data for the ExamOfferingcontextInfo
- information containing the principalId and locale
information about the caller of service operationDataValidationErrorException
- supplied data is invalid (xml)DoesNotExistException
- examOfferingRelationId is not foundInvalidParameterException
- examOfferingRelationInfo or contextInfo is not validMissingParameterException
- examOfferingRelationId, examOfferingRelationInfo or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredReadOnlyException
- an attempt was made to change information designated as read onlyVersionMismatchException
- an optimistic locking failure or the action was attempted on an out
of data versionStatusInfo deleteExamOfferingRelation(String examOfferingRelationId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
examOfferingRelationId
- the identifier for the ExamOfferingRelation to be deletedcontextInfo
- information containing the principalId and locale
information about the caller of service operationDoesNotExistException
- examId is not foundInvalidParameterException
- contextInfo is not validMissingParameterException
- examOfferingRelationId, or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredExamOfferingRelationInfo getExamOfferingRelation(String examOfferingRelationId, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
examOfferingRelationId
- the id of the relationship.contextInfo
- Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException
- if the relationship does not existInvalidParameterException
- contextInfo is invalidMissingParameterException
- examOfferingRelationId or contextInfo are absent
(missing or null)OperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredList<ExamOfferingRelationInfo> getExamOfferingRelationsByIds(List<String> examOfferingRelationIds, ContextInfo contextInfo) throws DoesNotExistException, InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
examOfferingRelationIds
- the relationship ids.contextInfo
- Context information containing the principalId and locale
information about the caller of service operationDoesNotExistException
- a relationshipId in the list was not foundInvalidParameterException
- contextInfo is invalidMissingParameterException
- relationshipIds, a relationshipId in the relationshipIds, or
contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredList<String> getExamOfferingRelationIdsByType(String relationshipTypeKey, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
relationshipTypeKey
- an identifier for a ExamOfferingRelation TypecontextInfo
- Context information containing the principalId and locale
information about the caller of service operationInvalidParameterException
- contextInfo is invalidMissingParameterException
- relationshipTypeKey or contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredList<ExamOfferingRelationInfo> getExamOfferingRelationsByFormatOffering(String formatOfferingId, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
formatOfferingId
- the identifier for the FormatOfferingcontextInfo
- Context information containing the principalId and locale information about the caller of service operationInvalidParameterException
- contextInfo is invalidMissingParameterException
- formatOfferingId or contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredList<ExamOfferingRelationInfo> getExamOfferingRelationsByExamOffering(String examOfferingId, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
examOfferingId
- the identifier for the ExamOfferingcontextInfo
- Context information containing the principalId and locale information about the caller of service operationInvalidParameterException
- contextInfo is invalidMissingParameterException
- examOfferingId or contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredList<String> getExamOfferingRelationIdsByActivityOffering(String activityOfferingId, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
activityOfferingId
- the identifier for the ActivityOfferingcontextInfo
- Context information containing the principalId and locale information about the caller of service operationInvalidParameterException
- contextInfo is invalidMissingParameterException
- activityOfferingId or contextInfo is missing or nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredList<String> searchForExamOfferingRelationIds(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
criteria
- the search criteriacontextInfo
- information containing the principalId and locale
information about the caller of service operationInvalidParameterException
- criteria or contextInfo is not validMissingParameterException
- criteria or contextInfo is missing or
nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredList<ExamOfferingRelationInfo> searchForExamOfferingRelations(QueryByCriteria criteria, ContextInfo contextInfo) throws InvalidParameterException, MissingParameterException, OperationFailedException, PermissionDeniedException
criteria
- the search criteriacontextInfo
- information containing the principalId and locale
information about the caller of service operationInvalidParameterException
- criteria or contextInfo is not validMissingParameterException
- criteria or contextInfo is missing or
nullOperationFailedException
- unable to complete requestPermissionDeniedException
- an authorization failure occurredCopyright © 2004-2013 The Kuali Foundation. All Rights Reserved.