BaseRateServiceInterface (DFP Axis classes 1.24.0 API)

All Superinterfaces:

Remote

All Known Implementing Classes:

BaseRateServiceSoapBindingStub
```
public interface BaseRateServiceInterface
extends Remote
```

Method Summary

Methods
Modifier and Type	Method and Description
`BaseRate`	`createBaseRate(BaseRate baseRate)` Creates a new `BaseRate` object.
`BaseRate[]`	`createBaseRates(BaseRate[] baseRates)` Creates a list of new `BaseRate` objects.
`BaseRate`	`getBaseRate(Long baseRateId)` Returns the `BaseRate` object uniquely identified by the given ID.
`BaseRatePage`	`getBaseRatesByStatement(Statement filterStatement)` Gets a `BaseRatePage` of `BaseRate` objects that satisfy the given `Statement.query`.
`UpdateResult`	`performBaseRateAction(BaseRateAction baseRateAction, Statement filterStatement)` Performs actions on `BaseRate` objects that satisfy the given `Statement.query`.
`BaseRate`	`updateBaseRate(BaseRate baseRate)` Updates the specified `BaseRate` object.
`BaseRate[]`	`updateBaseRates(BaseRate[] baseRates)` Updates the specified `BaseRate` objects.

Method Detail

createBaseRate

BaseRate createBaseRate(BaseRate baseRate)
                        throws RemoteException,
                               ApiException

Creates a new BaseRate object.

Parameters:: baseRate - the base rate to be created
Returns:: the base rate with its ID filled in
Throws:: RemoteException; ApiException

createBaseRates

BaseRate[] createBaseRates(BaseRate[] baseRates)
                           throws RemoteException,
                                  ApiException

Creates a list of new BaseRate objects.

Parameters:: baseRates - the base rates to be created
Returns:: the base rates with their IDs filled in
Throws:: RemoteException; ApiException

getBaseRate
```
BaseRate getBaseRate(Long baseRateId)
                     throws RemoteException,
                            ApiException
```
Returns the BaseRate object uniquely identified by the given ID.

Parameters:
baseRateId - the ID of the base rate, which must already exist

Throws:

RemoteException

ApiException

getBaseRatesByStatement

BaseRatePage getBaseRatesByStatement(Statement filterStatement)
                                     throws RemoteException,
                                            ApiException

Gets a BaseRatePage of BaseRate objects that satisfy the given Statement.query. The following fields are supported for filtering:

Parameters:: filterStatement - a Publisher Query Language statement used to filter a set of base rates.
Returns:: the page of base rates that match the given filter
Throws:: RemoteException; ApiException

performBaseRateAction

UpdateResult performBaseRateAction(BaseRateAction baseRateAction,
                                 Statement filterStatement)
                                   throws RemoteException,
                                          ApiException

Performs actions on BaseRate objects that satisfy the given Statement.query.

Parameters:: baseRateAction - the action to perform; filterStatement - a Publisher Query Language statement used to filter a set of base rates.
Returns:: the result of the action performed
Throws:: RemoteException; ApiException

updateBaseRate

BaseRate updateBaseRate(BaseRate baseRate)
                        throws RemoteException,
                               ApiException

Updates the specified BaseRate object.

Parameters:: baseRate - the base rate to be updated
Returns:: the updated base rate
Throws:: RemoteException; ApiException

updateBaseRates

BaseRate[] updateBaseRates(BaseRate[] baseRates)
                           throws RemoteException,
                                  ApiException

Updates the specified BaseRate objects.

Parameters:: baseRates - the base rates to be updated
Returns:: the updated base rates
Throws:: RemoteException; ApiException

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

PQL Property	Object Property
`rateCardId`	`BaseRate.rateCardId`
`id`	`BaseRate.id`
`status`	`BaseRate.status`
`productTemplateId`	`BaseRate.id` Note: Cannot be combined with `productId`.
`productId`	`BaseRate.id` Note: Cannot be combined with `productTemplateId`.

Interface BaseRateServiceInterface