org.kuali.student.core.rate.service

Interface RateService

public interface RateService

This service supports the management of rates. The managed entities are:

CatalogRate

This is an "entry" in the rate catalog. The rate catalog represents a catalog of "canonical-like" rates. Approved catalog entries may be used to create a specific rate to an external object.

Rate

The actual rate associated with an external object. The Rate is constrained by its related entry in the rate catalog.

Version:

0.0.8

Author:

Kuali Student Services

Method Summary

Methods

Modifier and Type	Method and Description
StatusInfo	changeCatalogRateState(String catalogRateId, String stateKey, ContextInfo contextInfo) Changes the state of a CatalogRate.
StatusInfo	changeRateState(String rateId, String stateKey, ContextInfo contextInfo) Changes the state of a Rate.
CatalogRateInfo	createCatalogRate(String catalogRateTypeKey, CatalogRateInfo catalogRateInfo, ContextInfo contextInfo) Creates a new CatalogRate.
RateInfo	createRate(String catalogRateId, String rateTypeKey, RateInfo rateInfo, ContextInfo contextInfo) Creates a new Rate.
StatusInfo	deleteCatalogRate(String catalogRateId, ContextInfo contextInfo) Deletes an existing CatalogRate.
StatusInfo	deleteRate(String rateId, ContextInfo contextInfo) Deletes an existing Rate.
CatalogRateInfo	getCatalogRate(String catalogRateId, ContextInfo contextInfo) Retrieves a single CatalogRate by CatalogRate Id.
List<String>	getCatalogRateIdsByType(String catalogRateTypeKey, ContextInfo contextInfo) Retrieves a list of CatalogRate Ids by CatalogRate Type.
List<CatalogRateInfo>	getCatalogRatesByCode(String code, ContextInfo contextInfo) Retrieves a list of CatalogRates by code.
List<CatalogRateInfo>	getCatalogRatesByIds(List<String> catalogRateIds, ContextInfo contextInfo) Retrieves a list of CatalogRates from a list of CatalogRate Ids.
RateInfo	getRate(String rateId, ContextInfo contextInfo) Retrieves a single Rate by Rate Id.
List<String>	getRateIdsByType(String rateTypeKey, ContextInfo contextInfo) Retrieves a list of Rate Ids by Rate Type.
List<RateInfo>	getRatesByCatalogRate(String catalogRateId, ContextInfo contextInfo) Retrieves a list of Rates belonging to a CatalogRate.
List<RateInfo>	getRatesByIds(List<String> rateIds, ContextInfo contextInfo) Retrieves a list of Rates from a list of Rate Ids.
List<String>	searchForCatalogRateIds(QueryByCriteria criteria, ContextInfo contextInfo) Searches for CatalogRates based on the criteria and returns a list of CatalogRate identifiers which match the search criteria.
List<CatalogRateInfo>	searchForCatalogRates(QueryByCriteria criteria, ContextInfo contextInfo) Searches for CatalogRates based on the criteria and returns a list of CatalogRates which match the search criteria.
List<String>	searchForRateIds(QueryByCriteria criteria, ContextInfo contextInfo) Searches for Rates based on the criteria and returns a list of Rate identifiers which match the search criteria.
List<RateInfo>	searchForRates(QueryByCriteria criteria, ContextInfo contextInfo) Searches for Rates based on the criteria and returns a list of Rates which match the search criteria.
CatalogRateInfo	updateCatalogRate(String catalogRateId, CatalogRateInfo catalogRateInfo, ContextInfo contextInfo) Updates an existing CatalogRate.
RateInfo	updateRate(String rateId, RateInfo rateInfo, ContextInfo contextInfo) Updates an existing Rate.
List<ValidationResultInfo>	validateCatalogRate(String validationTypeKey, String catalogRateTypeKey, CatalogRateInfo catalogRateInfo, ContextInfo contextInfo) Validates a CatalogRate.
List<ValidationResultInfo>	validateRate(String validationTypeKey, String catalogRateId, String rateTypeKey, RateInfo rateInfo, ContextInfo contextInfo) Validates a Rate.

Method Detail

getCatalogRate

CatalogRateInfo getCatalogRate(String catalogRateId,
                             ContextInfo contextInfo)
                               throws DoesNotExistException,
                                      InvalidParameterException,
                                      MissingParameterException,
                                      OperationFailedException,
                                      PermissionDeniedException

Retrieves a single CatalogRate by CatalogRate Id.

Parameters:

catalogRateId - the identifier for the rate to be retrieved

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

Returns:

the CatalogRate requested

Throws:

DoesNotExistException - catalogRateId not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - catalogRateId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getCatalogRatesByIds

List<CatalogRateInfo> getCatalogRatesByIds(List<String> catalogRateIds,
                                         ContextInfo contextInfo)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Retrieves a list of CatalogRates from a list of CatalogRate Ids. The returned list may be in any order and if duplicates Ids are supplied, a unique set may or may not be returned.

Parameters:

catalogRateIds - a list of CatalogRate identifiers

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

Returns:

a list of CatalogRates

Throws:

DoesNotExistException - a catalogRateId in the list not found

InvalidParameterException - contextInfo is invalid

MissingParameterException - catalogRateIds, an Id in catalogRateIds, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getCatalogRateIdsByType

List<String> getCatalogRateIdsByType(String catalogRateTypeKey,
                                   ContextInfo contextInfo)
                                     throws InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Retrieves a list of CatalogRate Ids by CatalogRate Type.

Parameters:

catalogRateTypeKey - an identifier for a CatalogRate Type

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

Returns:

a list of CatalogRate identifiers matching catalogRateTypeKey or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - catalogRateTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getCatalogRatesByCode

List<CatalogRateInfo> getCatalogRatesByCode(String code,
                                          ContextInfo contextInfo)
                                            throws InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Retrieves a list of CatalogRates by code.

Parameters:

code - a CatalogRate code

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

Returns:

a list of CatalogRates

Throws:

InvalidParameterException - contextInfo is invalid

MissingParameterException - code or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForCatalogRateIds

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

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

Parameters:

criteria - the search criteria

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

Returns:

list of CatalogRate Ids matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForCatalogRates

List<CatalogRateInfo> searchForCatalogRates(QueryByCriteria criteria,
                                          ContextInfo contextInfo)
                                            throws InvalidParameterException,
                                                   MissingParameterException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

criteria - the search criteria

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

Returns:

list of CatalogRates matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

validateCatalogRate

List<ValidationResultInfo> validateCatalogRate(String validationTypeKey,
                                             String catalogRateTypeKey,
                                             CatalogRateInfo catalogRateInfo,
                                             ContextInfo contextInfo)
                                               throws DoesNotExistException,
                                                      InvalidParameterException,
                                                      MissingParameterException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

validationTypeKey - the identifier for the validation Type

catalogRateTypeKey - the identifier for the rate Type

catalogRateInfo - the CatalogRate information to be validated

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

Returns:

a list of validation results or an empty list if validation succeeded

Throws:

DoesNotExistException - validationTypeKey or catalogRateTypeKey is not found

InvalidParameterException - catalogRateInfo or contextInfo is not valid

MissingParameterException - validationTypeKey, catalogRateTypeKey, catalogRateInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

createCatalogRate

CatalogRateInfo createCatalogRate(String catalogRateTypeKey,
                                CatalogRateInfo catalogRateInfo,
                                ContextInfo contextInfo)
                                  throws DataValidationErrorException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         ReadOnlyException

Creates a new CatalogRate. The CatalogRate Id, Type, and Meta information may nogt be set in the supplied data.

Parameters:

catalogRateTypeKey - the identifier for the Type of the new CatalogRate

catalogRateInfo - the data with which to create the CatalogRate

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

Returns:

the new CatalogRate

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - catalogRateTypeKey does not exist is not supported

InvalidParameterException - catalogRateInfo or contextInfo is not valid

MissingParameterException - catalogRateTypeKey, catalogRateInfo or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

ReadOnlyException - an attempt at supplying information designated as read-only

updateCatalogRate

CatalogRateInfo updateCatalogRate(String catalogRateId,
                                CatalogRateInfo catalogRateInfo,
                                ContextInfo contextInfo)
                                  throws DataValidationErrorException,
                                         DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException,
                                         ReadOnlyException,
                                         VersionMismatchException

Updates an existing CatalogRate. The CatalogRate Id, Type, and Meta information may not be changed.

Parameters:

catalogRateId - the identifier for the CatalogRate to be updated

catalogRateInfo - the new data for the CatalogRate

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

Returns:

the updated CatalogRate

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - catalogRateId not found

InvalidParameterException - catalogRateInfo or contextInfo is not valid

MissingParameterException - catalogRateId, catalogRateInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

ReadOnlyException - an attempt at changing information designated as read-only

VersionMismatchException - optimistic locking failure or the action was attempted on an out of date version

changeCatalogRateState

StatusInfo changeCatalogRateState(String catalogRateId,
                                String stateKey,
                                ContextInfo contextInfo)
                                  throws DoesNotExistException,
                                         InvalidParameterException,
                                         MissingParameterException,
                                         OperationFailedException,
                                         PermissionDeniedException

Changes the state of a CatalogRate.

Parameters:

catalogRateId - the Id of the CatalogRate

stateKey - the identifier for the new State

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

Returns:

the status of the operation. This must always be true.

Throws:

DoesNotExistException - catalogRateId not found or stateKey not found in CatalogRate Lifecycle

InvalidParameterException - contextInfo is not valid

MissingParameterException - catalogRateId, stateKey, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

deleteCatalogRate

StatusInfo deleteCatalogRate(String catalogRateId,
                           ContextInfo contextInfo)
                             throws DependentObjectsExistException,
                                    DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Deletes an existing CatalogRate.

Parameters:

catalogRateId - the identifier for the CatalogRate to be deleted

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

Returns:

the status of the delete operation. This must always be true.

Throws:

DependentObjectsExistException - Rates are attached to this RateCatalog

DoesNotExistException - catalogRateId not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - catalogRateId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getRate

RateInfo getRate(String rateId,
               ContextInfo contextInfo)
                 throws DoesNotExistException,
                        InvalidParameterException,
                        MissingParameterException,
                        OperationFailedException,
                        PermissionDeniedException

Retrieves a single Rate by Rate Id.

Parameters:

rateId - the identifier for the rate to be retrieved

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

Returns:

the Rate requested

Throws:

DoesNotExistException - rateId not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - rateId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getRatesByIds

List<RateInfo> getRatesByIds(List<String> rateIds,
                           ContextInfo contextInfo)
                             throws DoesNotExistException,
                                    InvalidParameterException,
                                    MissingParameterException,
                                    OperationFailedException,
                                    PermissionDeniedException

Retrieves a list of Rates from a list of Rate Ids. The returned list may be in any order and if duplicates Ids are supplied, a unique set may or may not be returned.

Parameters:

rateIds - a list of Rate identifiers

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

Returns:

a list of Rates

Throws:

DoesNotExistException - a rateId in the list not found

InvalidParameterException - contextInfo is invalid

MissingParameterException - rateIds, an Id in rateIds, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getRateIdsByType

List<String> getRateIdsByType(String rateTypeKey,
                            ContextInfo contextInfo)
                              throws InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

Retrieves a list of Rate Ids by Rate Type.

Parameters:

rateTypeKey - an identifier for a Rate Type

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

Returns:

a list of Rate identifiers matching rateTypeKey or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - rateTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getRatesByCatalogRate

List<RateInfo> getRatesByCatalogRate(String catalogRateId,
                                   ContextInfo contextInfo)
                                     throws InvalidParameterException,
                                            MissingParameterException,
                                            OperationFailedException,
                                            PermissionDeniedException

Retrieves a list of Rates belonging to a CatalogRate.

Parameters:

catalogRateId - the identifier for a rate catalog entry

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

Returns:

a list of Rates for the rate catalog entry or an empty list is none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - catalogRateId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForRateIds

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

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

Parameters:

criteria - the search criteria

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

Returns:

list of Rate Ids matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

searchForRates

List<RateInfo> searchForRates(QueryByCriteria criteria,
                            ContextInfo contextInfo)
                              throws InvalidParameterException,
                                     MissingParameterException,
                                     OperationFailedException,
                                     PermissionDeniedException

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

Parameters:

criteria - the search criteria

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

Returns:

list of Rates matching the criteria

Throws:

InvalidParameterException - criteria or contextInfo is not valid

MissingParameterException - criteria or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

validateRate

List<ValidationResultInfo> validateRate(String validationTypeKey,
                                      String catalogRateId,
                                      String rateTypeKey,
                                      RateInfo rateInfo,
                                      ContextInfo contextInfo)
                                        throws DoesNotExistException,
                                               InvalidParameterException,
                                               MissingParameterException,
                                               OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

validationTypeKey - the identifier for the validation Type

catalogRateId - the identifier for the rate catalog entry

rateTypeKey - the identifier for the rate Type

rateInfo - the Rate information to be validated

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

Returns:

a list of validation results or an empty list if validation succeeded

Throws:

DoesNotExistException - validationTypeKey, catalogRateId, or rateTypeKey is not found

InvalidParameterException - rateInfo or contextInfo is not valid

MissingParameterException - validationTypeKey, catalogRateId, rateTypeKey, rateInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

createRate

RateInfo createRate(String catalogRateId,
                  String rateTypeKey,
                  RateInfo rateInfo,
                  ContextInfo contextInfo)
                    throws DataValidationErrorException,
                           InvalidParameterException,
                           MissingParameterException,
                           OperationFailedException,
                           PermissionDeniedException,
                           ReadOnlyException

Creates a new Rate. The Rate Id, Type, and Meta information may not be set in the supplied data.

Parameters:

catalogRateId - the identifier for the rate catalog entry

rateTypeKey - the identifier for the Type of the new Rate

rateInfo - the data with which to create the Rate

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

Returns:

the new Rate

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - catalogRateId or rateTypeKey does not exist or is not supported

InvalidParameterException - rateInfo or contextInfo is not valid

MissingParameterException - catalogRateId, rateTypeKey, rateInfo or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

ReadOnlyException - an attempt at supplying information designated as read-only

updateRate

RateInfo updateRate(String rateId,
                  RateInfo rateInfo,
                  ContextInfo contextInfo)
                    throws DataValidationErrorException,
                           DoesNotExistException,
                           InvalidParameterException,
                           MissingParameterException,
                           OperationFailedException,
                           PermissionDeniedException,
                           ReadOnlyException,
                           VersionMismatchException

Updates an existing Rate. The Rate Id, Type, and Meta information may not be changed.

Parameters:

rateId - the identifier for the Rate to be updated

rateInfo - the new data for the Rate

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

Returns:

the updated Rate

Throws:

DataValidationErrorException - supplied data is invalid

DoesNotExistException - rateId not found

InvalidParameterException - rateInfo or contextInfo is not valid

MissingParameterException - rateId, rateInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

ReadOnlyException - an attempt at changing information designated as read-only

VersionMismatchException - optimistic locking failure or the action was attempted on an out of date version

changeRateState

StatusInfo changeRateState(String rateId,
                         String stateKey,
                         ContextInfo contextInfo)
                           throws DoesNotExistException,
                                  InvalidParameterException,
                                  MissingParameterException,
                                  OperationFailedException,
                                  PermissionDeniedException

Changes the state of a Rate.

Parameters:

rateId - the Id of the Rate

stateKey - the identifier for the new State

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

Returns:

the status of the operation. This must always be true.

Throws:

DoesNotExistException - rateId not found or stateKey not found in Rate Lifecycle

InvalidParameterException - contextInfo is not valid

MissingParameterException - rateId, stateKey, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

deleteRate

StatusInfo deleteRate(String rateId,
                    ContextInfo contextInfo)
                      throws DoesNotExistException,
                             InvalidParameterException,
                             MissingParameterException,
                             OperationFailedException,
                             PermissionDeniedException

Deletes an existing Rate.

Parameters:

rateId - the identifier for the Rate to be deleted

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

Returns:

the status of the delete operation. This must always be true.

Throws:

DoesNotExistException - rateId not found

InvalidParameterException - contextInfo is not valid

MissingParameterException - rateId or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred