AppliedRateService (Kuali Student 2.0.0-services-SNAPSHOT API)

```
public interface AppliedRateService
```
This service applies rates to courses and offerings. This service is a little odd in that it is separated from the basic Rate Service and refers directly to canonicals and offerings. We should revisit the packaging issues of these mega service packages.

Version:

0.0.8

Author:

Kuali Student Services

Method Summary

Methods
Modifier and Type	Method and Description
`StatusInfo`	`changeCatalogRateCanonicalRelationState(String catalogRateCanonicalRelationId, String stateKey, ContextInfo contextInfo)` Changes the state of a CatalogRateCanonicalRelation.
`StatusInfo`	`changeRateOfferingRelationState(String rateOfferingRelationId, String stateKey, ContextInfo contextInfo)` Changes the state of a RateOfferingRelation.
`CatalogRateCanonicalRelationInfo`	`createCatalogRateCanonicalRelation(String catalogRateId, String courseId, String catalogRateCanonicalRelationTypeKey, CatalogRateCanonicalRelationInfo catalogRateCanonicalRelationInfo, ContextInfo contextInfo)` Creates a new CatalogRateCanonicalRelation.
`RateOfferingRelationInfo`	`createRateOfferingRelation(String rateId, String formatOfferingId, String rateOfferingRelationTypeKey, RateOfferingRelationInfo rateOfferingRelationInfo, ContextInfo contextInfo)` Creates a new RateOfferingRelation.
`StatusInfo`	`deleteCatalogRateCanonicalRelation(String catalogRateCanonicalRelationId, ContextInfo contextInfo)` Deletes an existing CatalogRateCanonicalRelation.
`StatusInfo`	`deleteRateOfferingRelation(String rateOfferingRelationId, ContextInfo contextInfo)` Deletes an existing RateOfferingRelation.
`CatalogRateCanonicalRelationInfo`	`getCatalogRateCanonicalRelation(String catalogRateCanonicalRelationId, ContextInfo contextInfo)` Retrieves a single CatalogRateCanonicalRelation by CatalogRateCanonicalRelation Id.
`List<String>`	`getCatalogRateCanonicalRelationIdsByType(String catalogRateCanonicalRelationTypeKey, ContextInfo contextInfo)` Retrieves a list of CatalogRateCanonicalRelation Ids by CatalogRateCanonicalRelation Type.
`List<CatalogRateCanonicalRelationInfo>`	`getCatalogRateCanonicalRelationsByCatalogRate(String catalogRateId, ContextInfo contextInfo)` Retrieves a list of CatalogRateCanonicalRelations for a CatalogRate.
`List<CatalogRateCanonicalRelationInfo>`	`getCatalogRateCanonicalRelationsByCatalogRateAndCourse(String catalogRateId, String courseId, ContextInfo contextInfo)` Retrieves a list of CatalogRateCanonicalRelations for a CatalogRate and Course.
`List<CatalogRateCanonicalRelationInfo>`	`getCatalogRateCanonicalRelationsByCourse(String courseId, ContextInfo contextInfo)` Retrieves a list of CatalogRateCanonicalRelations for a Course.
`List<CatalogRateCanonicalRelationInfo>`	`getCatalogRateCanonicalRelationsByIds(List<String> catalogRateCanonicalRelationIds, ContextInfo contextInfo)` Retrieves a list of CatalogRateCanonicalRelations from a list of CatalogRateCanonicalRelation Ids.
`RateOfferingRelationInfo`	`getRateOfferingRelation(String rateOfferingRelationId, ContextInfo contextInfo)` Retrieves a single RateOfferingRelation by RateOfferingRelation Id.
`List<String>`	`getRateOfferingRelationIdsByType(String rateOfferingRelationTypeKey, ContextInfo contextInfo)` Retrieves a list of RateOfferingRelation Ids by RateOfferingRelation Type.
`List<RateOfferingRelationInfo>`	`getRateOfferingRelationsByFormatOffering(String formatOfferingId, ContextInfo contextInfo)` Retrieves a list of RateOfferingRelations for a FormatOffering.
`List<RateOfferingRelationInfo>`	`getRateOfferingRelationsByIds(List<String> rateOfferingRelationIds, ContextInfo contextInfo)` Retrieves a list of RateOfferingRelations from a list of RateOfferingRelation Ids.
`List<RateOfferingRelationInfo>`	`getRateOfferingRelationsByRate(String rateId, ContextInfo contextInfo)` Retrieves a list of RateOfferingRelations for a Rate.
`List<RateOfferingRelationInfo>`	`getRateOfferingRelationsByRateAndFormatOffering(String rateId, String formatOfferingId, ContextInfo contextInfo)` Retrieves a list of RateOfferingRelations for a Rate and FormatOffering.
`List<String>`	`searchForCatalogRateCanonicalRelationIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for CatalogRateCanonicalRelations based on the criteria and returns a list of CatalogRateCanonicalRelation identifiers which match the search criteria.
`List<CatalogRateCanonicalRelationInfo>`	`searchForCatalogRateCanonicalRelations(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for CatalogRateCanonicalRelations based on the criteria and returns a list of CatalogRateCanonicalRelations which match the search criteria.
`List<String>`	`searchForRateOfferingRelationIds(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for RateOfferingRelations based on the criteria and returns a list of RateOfferingRelation identifiers which match the search criteria.
`List<RateOfferingRelationInfo>`	`searchForRateOfferingRelations(QueryByCriteria criteria, ContextInfo contextInfo)` Searches for RateOfferingRelations based on the criteria and returns a list of RateOfferingRelations which match the search criteria.
`CatalogRateCanonicalRelationInfo`	`updateCatalogRateCanonicalRelation(String catalogRateCanonicalRelationId, CatalogRateCanonicalRelationInfo catalogRateCanonicalRelationInfo, ContextInfo contextInfo)` Updates an existing CatalogRateCanonicalRelation.
`RateOfferingRelationInfo`	`updateRateOfferingRelation(String rateOfferingRelationId, RateOfferingRelationInfo rateOfferingRelationInfo, ContextInfo contextInfo)` Updates an existing RateOfferingRelation.
`List<ValidationResultInfo>`	`validateCatalogRateCanonicalRelation(String validationTypeKey, String catalogRateId, String courseId, String catalogRateCanonicalRelationTypeKey, CatalogRateCanonicalRelationInfo catalogRateCanonicalRelationInfo, ContextInfo contextInfo)` Validates a CatalogRateCanonicalRelation.
`List<ValidationResultInfo>`	`validateRateOfferingRelation(String validationTypeKey, String rateId, String formatOfferingId, String rateOfferingRelationTypeKey, RateOfferingRelationInfo rateOfferingRelationInfo, ContextInfo contextInfo)` Validates a RateOfferingRelation.

Method Detail

getCatalogRateCanonicalRelation

CatalogRateCanonicalRelationInfo getCatalogRateCanonicalRelation(String catalogRateCanonicalRelationId,
                                                               ContextInfo contextInfo)
                                                                 throws DoesNotExistException,
                                                                        InvalidParameterException,
                                                                        MissingParameterException,
                                                                        OperationFailedException,
                                                                        PermissionDeniedException

Retrieves a single CatalogRateCanonicalRelation by CatalogRateCanonicalRelation Id.

Parameters:: catalogRateCanonicalRelationId - the identifier for the rate to be retrieved; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the CatalogRateCanonicalRelation requested
Throws:: DoesNotExistException - catalogRateCanonicalRelationId not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - catalogRateCanonicalRelationId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCatalogRateCanonicalRelationsByIds

List<CatalogRateCanonicalRelationInfo> getCatalogRateCanonicalRelationsByIds(List<String> catalogRateCanonicalRelationIds,
                                                                           ContextInfo contextInfo)
                                                                             throws DoesNotExistException,
                                                                                    InvalidParameterException,
                                                                                    MissingParameterException,
                                                                                    OperationFailedException,
                                                                                    PermissionDeniedException

Retrieves a list of CatalogRateCanonicalRelations from a list of CatalogRateCanonicalRelation 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:: catalogRateCanonicalRelationIds - a list of CatalogRateCanonicalRelation identifiers; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CatalogRateCanonicalRelations
Throws:: DoesNotExistException - a catalogRateCanonicalRelationId in the list not found; InvalidParameterException - contextInfo is invalid; MissingParameterException - catalogRateCanonicalRelationIds, an Id in catalogRateCanonicalRelationIds, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCatalogRateCanonicalRelationIdsByType
```
List<String> getCatalogRateCanonicalRelationIdsByType(String catalogRateCanonicalRelationTypeKey,
                                                    ContextInfo contextInfo)
                                                      throws InvalidParameterException,
                                                             MissingParameterException,
                                                             OperationFailedException,
                                                             PermissionDeniedException
```
Retrieves a list of CatalogRateCanonicalRelation Ids by CatalogRateCanonicalRelation Type.

Parameters:
catalogRateCanonicalRelationTypeKey - an identifier for a CatalogRateCanonicalRelation Type
contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:
a list of CatalogRateCanonicalRelation identifiers matching catalogRateCanonicalRelationTypeKey or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - catalogRateCanonicalRelationTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getCatalogRateCanonicalRelationsByCatalogRate

List<CatalogRateCanonicalRelationInfo> getCatalogRateCanonicalRelationsByCatalogRate(String catalogRateId,
                                                                                   ContextInfo contextInfo)
                                                                                     throws InvalidParameterException,
                                                                                            MissingParameterException,
                                                                                            OperationFailedException,
                                                                                            PermissionDeniedException

Retrieves a list of CatalogRateCanonicalRelations for a CatalogRate.

Parameters:: catalogRateId - the Id of the CatalogRate; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CatalogRateCanonicalRelations
Throws:: InvalidParameterException - contextInfo is invalid; MissingParameterException - catalogRateId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCatalogRateCanonicalRelationsByCourse

List<CatalogRateCanonicalRelationInfo> getCatalogRateCanonicalRelationsByCourse(String courseId,
                                                                              ContextInfo contextInfo)
                                                                                throws InvalidParameterException,
                                                                                       MissingParameterException,
                                                                                       OperationFailedException,
                                                                                       PermissionDeniedException

Retrieves a list of CatalogRateCanonicalRelations for a Course.

Parameters:: courseId - the Id of the Course; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CatalogRateCanonicalRelations
Throws:: InvalidParameterException - contextInfo is invalid; MissingParameterException - courseId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getCatalogRateCanonicalRelationsByCatalogRateAndCourse

List<CatalogRateCanonicalRelationInfo> getCatalogRateCanonicalRelationsByCatalogRateAndCourse(String catalogRateId,
                                                                                            String courseId,
                                                                                            ContextInfo contextInfo)
                                                                                              throws InvalidParameterException,
                                                                                                     MissingParameterException,
                                                                                                     OperationFailedException,
                                                                                                     PermissionDeniedException

Retrieves a list of CatalogRateCanonicalRelations for a CatalogRate and Course.

Parameters:: catalogRateId - the Id of the CatalogRate; courseId - the Id of the Course; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of CatalogRateCanonicalRelations
Throws:: InvalidParameterException - contextInfo is invalid; MissingParameterException - catalogRateId, courseId, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForCatalogRateCanonicalRelationIds

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

Searches for CatalogRateCanonicalRelations based on the criteria and returns a list of CatalogRateCanonicalRelation 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 CatalogRateCanonicalRelation 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

searchForCatalogRateCanonicalRelations

List<CatalogRateCanonicalRelationInfo> searchForCatalogRateCanonicalRelations(QueryByCriteria criteria,
                                                                            ContextInfo contextInfo)
                                                                              throws InvalidParameterException,
                                                                                     MissingParameterException,
                                                                                     OperationFailedException,
                                                                                     PermissionDeniedException

Searches for CatalogRateCanonicalRelations based on the criteria and returns a list of CatalogRateCanonicalRelations 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 CatalogRateCanonicalRelations 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

validateCatalogRateCanonicalRelation
```
List<ValidationResultInfo> validateCatalogRateCanonicalRelation(String validationTypeKey,
                                                              String catalogRateId,
                                                              String courseId,
                                                              String catalogRateCanonicalRelationTypeKey,
                                                              CatalogRateCanonicalRelationInfo catalogRateCanonicalRelationInfo,
                                                              ContextInfo contextInfo)
                                                                throws DoesNotExistException,
                                                                       InvalidParameterException,
                                                                       MissingParameterException,
                                                                       OperationFailedException,
                                                                       PermissionDeniedException
```
Validates a CatalogRateCanonicalRelation. Depending on the value of validationType, this validation could be limited to tests on just the current CatalogRateCanonicalRelation and its directly contained sub-objects or expanded to perform all tests related to this CatalogRateCanonicalRelation. If an identifier is present for the CatalogRateCanonicalRelation (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the CatalogRateCanonicalRelation 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 Id of the CatalogRate
courseId - the Id of the Course
catalogRateCanonicalRelationTypeKey - the identifier for the rate Type
catalogRateCanonicalRelationInfo - the CatalogRateCanonicalRelation 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, courseId, or catalogRateCanonicalRelationTypeKey is not found

InvalidParameterException - catalogRateCanonicalRelationInfo or contextInfo is not valid

MissingParameterException - validationTypeKey, catalogRateId, courseId, catalogRateCanonicalRelationTypeKey, catalogRateCanonicalRelationInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

createCatalogRateCanonicalRelation

CatalogRateCanonicalRelationInfo createCatalogRateCanonicalRelation(String catalogRateId,
                                                                  String courseId,
                                                                  String catalogRateCanonicalRelationTypeKey,
                                                                  CatalogRateCanonicalRelationInfo catalogRateCanonicalRelationInfo,
                                                                  ContextInfo contextInfo)
                                                                    throws DataValidationErrorException,
                                                                           InvalidParameterException,
                                                                           MissingParameterException,
                                                                           OperationFailedException,
                                                                           PermissionDeniedException,
                                                                           ReadOnlyException

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

Parameters:: catalogRateId - the Id of the CatalogRate; courseId - the Id of the Course; catalogRateCanonicalRelationTypeKey - the identifier for the Type of the new CatalogRateCanonicalRelation; catalogRateCanonicalRelationInfo - the data with which to create the CatalogRateCanonicalRelation; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the new CatalogRateCanonicalRelation
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - catalogRateId, courseId, catalogRateCanonicalRelationTypeKey does not exist is not supported; InvalidParameterException - catalogRateCanonicalRelationInfo or contextInfo is not valid; MissingParameterException - catalogRateId, courseId, catalogRateCanonicalRelationTypeKey, catalogRateCanonicalRelationInfo 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

updateCatalogRateCanonicalRelation

CatalogRateCanonicalRelationInfo updateCatalogRateCanonicalRelation(String catalogRateCanonicalRelationId,
                                                                  CatalogRateCanonicalRelationInfo catalogRateCanonicalRelationInfo,
                                                                  ContextInfo contextInfo)
                                                                    throws DataValidationErrorException,
                                                                           DoesNotExistException,
                                                                           InvalidParameterException,
                                                                           MissingParameterException,
                                                                           OperationFailedException,
                                                                           PermissionDeniedException,
                                                                           ReadOnlyException,
                                                                           VersionMismatchException

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

Parameters:: catalogRateCanonicalRelationId - the identifier for the CatalogRateCanonicalRelation to be updated; catalogRateCanonicalRelationInfo - the new data for the CatalogRateCanonicalRelation; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the updated CatalogRateCanonicalRelation
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - catalogRateCanonicalRelationId not found; InvalidParameterException - catalogRateCanonicalRelationInfo or contextInfo is not valid; MissingParameterException - catalogRateCanonicalRelationId, catalogRateCanonicalRelationInfo, 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

changeCatalogRateCanonicalRelationState

StatusInfo changeCatalogRateCanonicalRelationState(String catalogRateCanonicalRelationId,
                                                 String stateKey,
                                                 ContextInfo contextInfo)
                                                   throws DoesNotExistException,
                                                          InvalidParameterException,
                                                          MissingParameterException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Changes the state of a CatalogRateCanonicalRelation.

Parameters:: catalogRateCanonicalRelationId - the Id of the CatalogRateCanonicalRelation; 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 - catalogRateCanonicalRelationId not found or stateKey not found in CatalogRateCanonicalRelation Lifecycle; InvalidParameterException - contextInfo is not valid; MissingParameterException - catalogRateCanonicalRelationId, stateKey, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

deleteCatalogRateCanonicalRelation

StatusInfo deleteCatalogRateCanonicalRelation(String catalogRateCanonicalRelationId,
                                            ContextInfo contextInfo)
                                              throws DependentObjectsExistException,
                                                     DoesNotExistException,
                                                     InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Deletes an existing CatalogRateCanonicalRelation.

Parameters:: catalogRateCanonicalRelationId - the identifier for the CatalogRateCanonicalRelation 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 - catalogRateCanonicalRelationId not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - catalogRateCanonicalRelationId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getRateOfferingRelation

RateOfferingRelationInfo getRateOfferingRelation(String rateOfferingRelationId,
                                               ContextInfo contextInfo)
                                                 throws DoesNotExistException,
                                                        InvalidParameterException,
                                                        MissingParameterException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Retrieves a single RateOfferingRelation by RateOfferingRelation Id.

Parameters:: rateOfferingRelationId - the identifier for the rate to be retrieved; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the RateOfferingRelation requested
Throws:: DoesNotExistException - rateOfferingRelationId not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - rateOfferingRelationId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getRateOfferingRelationsByIds

List<RateOfferingRelationInfo> getRateOfferingRelationsByIds(List<String> rateOfferingRelationIds,
                                                           ContextInfo contextInfo)
                                                             throws DoesNotExistException,
                                                                    InvalidParameterException,
                                                                    MissingParameterException,
                                                                    OperationFailedException,
                                                                    PermissionDeniedException

Retrieves a list of RateOfferingRelations from a list of RateOfferingRelation 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:: rateOfferingRelationIds - a list of RateOfferingRelation identifiers; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of RateOfferingRelations
Throws:: DoesNotExistException - a rateOfferingRelationId in the list not found; InvalidParameterException - contextInfo is invalid; MissingParameterException - rateOfferingRelationIds, an Id in rateOfferingRelationIds, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getRateOfferingRelationIdsByType
```
List<String> getRateOfferingRelationIdsByType(String rateOfferingRelationTypeKey,
                                            ContextInfo contextInfo)
                                              throws InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException
```
Retrieves a list of RateOfferingRelation Ids by RateOfferingRelation Type.

Parameters:
rateOfferingRelationTypeKey - an identifier for a RateOfferingRelation Type
contextInfo - information containing the principalId and locale information about the caller of service operation

Returns:
a list of RateOfferingRelation identifiers matching rateOfferingRelationTypeKey or an empty list if none found

Throws:

InvalidParameterException - contextInfo is not valid

MissingParameterException - rateOfferingRelationTypeKey or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

getRateOfferingRelationsByRate

List<RateOfferingRelationInfo> getRateOfferingRelationsByRate(String rateId,
                                                            ContextInfo contextInfo)
                                                              throws InvalidParameterException,
                                                                     MissingParameterException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

Retrieves a list of RateOfferingRelations for a Rate.

Parameters:: rateId - the Id of the Rate; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of RateOfferingRelations
Throws:: InvalidParameterException - contextInfo is invalid; MissingParameterException - rateId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getRateOfferingRelationsByFormatOffering

List<RateOfferingRelationInfo> getRateOfferingRelationsByFormatOffering(String formatOfferingId,
                                                                      ContextInfo contextInfo)
                                                                        throws InvalidParameterException,
                                                                               MissingParameterException,
                                                                               OperationFailedException,
                                                                               PermissionDeniedException

Retrieves a list of RateOfferingRelations for a FormatOffering.

Parameters:: formatOfferingId - the Id of the FormatOffering; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of RateOfferingRelations
Throws:: InvalidParameterException - contextInfo is invalid; MissingParameterException - formatOfferingId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

getRateOfferingRelationsByRateAndFormatOffering

List<RateOfferingRelationInfo> getRateOfferingRelationsByRateAndFormatOffering(String rateId,
                                                                             String formatOfferingId,
                                                                             ContextInfo contextInfo)
                                                                               throws InvalidParameterException,
                                                                                      MissingParameterException,
                                                                                      OperationFailedException,
                                                                                      PermissionDeniedException

Retrieves a list of RateOfferingRelations for a Rate and FormatOffering.

Parameters:: rateId - the Id of the Rate; formatOfferingId - the Id of the FormatOffering; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: a list of RateOfferingRelations
Throws:: InvalidParameterException - contextInfo is invalid; MissingParameterException - rateId, formatOfferingId, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

searchForRateOfferingRelationIds
```
List<String> searchForRateOfferingRelationIds(QueryByCriteria criteria,
                                            ContextInfo contextInfo)
                                              throws InvalidParameterException,
                                                     MissingParameterException,
                                                     OperationFailedException,
                                                     PermissionDeniedException
```
Searches for RateOfferingRelations based on the criteria and returns a list of RateOfferingRelation 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 RateOfferingRelation 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

searchForRateOfferingRelations

List<RateOfferingRelationInfo> searchForRateOfferingRelations(QueryByCriteria criteria,
                                                            ContextInfo contextInfo)
                                                              throws InvalidParameterException,
                                                                     MissingParameterException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

Searches for RateOfferingRelations based on the criteria and returns a list of RateOfferingRelations 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 RateOfferingRelations 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

validateRateOfferingRelation
```
List<ValidationResultInfo> validateRateOfferingRelation(String validationTypeKey,
                                                      String rateId,
                                                      String formatOfferingId,
                                                      String rateOfferingRelationTypeKey,
                                                      RateOfferingRelationInfo rateOfferingRelationInfo,
                                                      ContextInfo contextInfo)
                                                        throws DoesNotExistException,
                                                               InvalidParameterException,
                                                               MissingParameterException,
                                                               OperationFailedException,
                                                               PermissionDeniedException
```
Validates a RateOfferingRelation. Depending on the value of validationType, this validation could be limited to tests on just the current RateOfferingRelation and its directly contained sub-objects or expanded to perform all tests related to this RateOfferingRelation. If an identifier is present for the RateOfferingRelation (and/or one of its contained sub-objects) and a record is found for that identifier, the validation checks if the RateOfferingRelation 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
rateId - the Id of the Rate
formatOfferingId - the Id of the FormatOffering
rateOfferingRelationTypeKey - the identifier for the rate Type
rateOfferingRelationInfo - the RateOfferingRelation 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, rateId, formatOfferingId, or rateOfferingRelationTypeKey is not found

InvalidParameterException - rateOfferingRelationInfo or contextInfo is not valid

MissingParameterException - validationTypeKey, rateId, formatOfferingId, rateOfferingRelationTypeKey, RateOfferingRelationInfo, or contextInfo is missing or null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

createRateOfferingRelation

RateOfferingRelationInfo createRateOfferingRelation(String rateId,
                                                  String formatOfferingId,
                                                  String rateOfferingRelationTypeKey,
                                                  RateOfferingRelationInfo rateOfferingRelationInfo,
                                                  ContextInfo contextInfo)
                                                    throws DataValidationErrorException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException,
                                                           ReadOnlyException

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

Parameters:: rateId - the Id of the Rate; formatOfferingId - the Id of the FormatOffering; rateOfferingRelationTypeKey - the identifier for the Type of the new RateOfferingRelation; rateOfferingRelationInfo - the data with which to create the RateOfferingRelation; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the new RateOfferingRelation
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - rateId, formatOfferingId, or rateOfferingRelationTypeKey does not exist is not supported; InvalidParameterException - rateOfferingRelationInfo or contextInfo is not valid; MissingParameterException - rateId, formatOfferingId, rateOfferingRelationTypeKey, rateOfferingRelationInfo 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

updateRateOfferingRelation

RateOfferingRelationInfo updateRateOfferingRelation(String rateOfferingRelationId,
                                                  RateOfferingRelationInfo rateOfferingRelationInfo,
                                                  ContextInfo contextInfo)
                                                    throws DataValidationErrorException,
                                                           DoesNotExistException,
                                                           InvalidParameterException,
                                                           MissingParameterException,
                                                           OperationFailedException,
                                                           PermissionDeniedException,
                                                           ReadOnlyException,
                                                           VersionMismatchException

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

Parameters:: rateOfferingRelationId - the identifier for the RateOfferingRelation to be updated; rateOfferingRelationInfo - the new data for the RateOfferingRelation; contextInfo - information containing the principalId and locale information about the caller of service operation
Returns:: the updated RateOfferingRelation
Throws:: DataValidationErrorException - supplied data is invalid; DoesNotExistException - rateOfferingRelationId not found; InvalidParameterException - rateOfferingRelationInfo or contextInfo is not valid; MissingParameterException - rateOfferingRelationId, rateOfferingRelationInfo, 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

changeRateOfferingRelationState

StatusInfo changeRateOfferingRelationState(String rateOfferingRelationId,
                                         String stateKey,
                                         ContextInfo contextInfo)
                                           throws DoesNotExistException,
                                                  InvalidParameterException,
                                                  MissingParameterException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Changes the state of a RateOfferingRelation.

Parameters:: rateOfferingRelationId - the Id of the RateOfferingRelation; 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 - rateOfferingRelationId not found or stateKey not found in RateOfferingRelation Lifecycle; InvalidParameterException - contextInfo is not valid; MissingParameterException - rateOfferingRelationId, stateKey, or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

deleteRateOfferingRelation

StatusInfo deleteRateOfferingRelation(String rateOfferingRelationId,
                                    ContextInfo contextInfo)
                                      throws DependentObjectsExistException,
                                             DoesNotExistException,
                                             InvalidParameterException,
                                             MissingParameterException,
                                             OperationFailedException,
                                             PermissionDeniedException

Deletes an existing RateOfferingRelation.

Parameters:: rateOfferingRelationId - the identifier for the RateOfferingRelation 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 - rateOfferingRelationId not found; InvalidParameterException - contextInfo is not valid; MissingParameterException - rateOfferingRelationId or contextInfo is missing or null; OperationFailedException - unable to complete request; PermissionDeniedException - an authorization failure occurred

Interface AppliedRateService