ProposalLineItemServiceInterface (Ad Manager Axis classes 4.14.0 API)

All Superinterfaces:

Remote

All Known Implementing Classes:

ProposalLineItemServiceSoapBindingStub
```
public interface ProposalLineItemServiceInterface
extends Remote
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ProposalLineItem[]`	`createMakegoods(ProposalLineItemMakegoodInfo[] makegoodInfos)` Creates makegood proposal line items given the specifications provided.
`ProposalLineItem[]`	`createProposalLineItems(ProposalLineItem[] proposalLineItems)` Creates new `ProposalLineItem` objects.
`ProposalLineItemPage`	`getProposalLineItemsByStatement(Statement filterStatement)` Gets a `ProposalLineItemPage` of `ProposalLineItem` objects that satisfy the given `Statement.query`.
`UpdateResult`	`performProposalLineItemAction(ProposalLineItemAction proposalLineItemAction, Statement filterStatement)` Performs actions on `ProposalLineItem` objects that match the given `Statement.query`.
`ProposalLineItem[]`	`updateProposalLineItems(ProposalLineItem[] proposalLineItems)` Updates the specified `ProposalLineItem` objects.

Method Detail

createMakegoods

ProposalLineItem[] createMakegoods(ProposalLineItemMakegoodInfo[] makegoodInfos)
                            throws RemoteException,
                                   ApiException

Creates makegood proposal line items given the specifications provided.

Throws:: RemoteException; ApiException

createProposalLineItems

ProposalLineItem[] createProposalLineItems(ProposalLineItem[] proposalLineItems)
                                    throws RemoteException,
                                           ApiException

Creates new ProposalLineItem objects.

Parameters:: proposalLineItems - the proposal line items to create
Returns:: the created proposal line items with their IDs filled in
Throws:: RemoteException; ApiException

getProposalLineItemsByStatement

ProposalLineItemPage getProposalLineItemsByStatement(Statement filterStatement)
                                              throws RemoteException,
                                                     ApiException

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

PQL Property	Object Property
`id`	`ProposalLineItem.id`
`name`	`ProposalLineItem.name`
`proposalId`	`ProposalLineItem.proposalId`
`startDateTime`	`ProposalLineItem.startDateTime`
`endDateTime`	`ProposalLineItem.endDateTime`
`isArchived`	`ProposalLineItem.isArchived`
`lastModifiedDateTime`	`ProposalLineItem.lastModifiedDateTime`
`useThirdPartyAdServerFromProposal` Only applicable for non-programmatic proposal line items using sales management	`ProposalLineItem#useThirdPartyAdServerFromProposal`
`thirdPartyAdServerId` Only applicable for non-programmatic proposal line items using sales management	`ProposalLineItem#thirdPartyAdServerId`
`customThirdPartyAdServerName` Only applicable for non-programmatic proposal line items using sales management	`ProposalLineItem#customThirdPartyAdServerName`
`isProgrammatic`	`ProposalLineItem.isProgrammatic`

Parameters:: filterStatement - a Publisher Query Language statement used to filter a set of proposal line items
Returns:: the proposal line items that match the given filter
Throws:: RemoteException; ApiException

performProposalLineItemAction

UpdateResult performProposalLineItemAction(ProposalLineItemAction proposalLineItemAction,
                                           Statement filterStatement)
                                    throws RemoteException,
                                           ApiException

Performs actions on ProposalLineItem objects that match the given Statement.query.

Parameters:: proposalLineItemAction - the action to perform; filterStatement - a Publisher Query Language statement used to filter a set of proposal line items
Returns:: the result of the action performed
Throws:: RemoteException; ApiException

updateProposalLineItems

ProposalLineItem[] updateProposalLineItems(ProposalLineItem[] proposalLineItems)
                                    throws RemoteException,
                                           ApiException

Updates the specified ProposalLineItem objects.

Parameters:: proposalLineItems - the proposal line items to update
Returns:: the updated proposal line items
Throws:: RemoteException; ApiException

Interface ProposalLineItemServiceInterface