com.google.api.ads.dfp.axis.v201302

Class LabelServiceSoapBindingStub

java.lang.Object

org.apache.axis.client.Stub

com.google.api.ads.dfp.axis.v201302.LabelServiceSoapBindingStub

All Implemented Interfaces:

LabelServiceInterface, Remote, javax.xml.rpc.Stub

public class LabelServiceSoapBindingStub
extends org.apache.axis.client.Stub
implements LabelServiceInterface

Field Summary

Fields inherited from class org.apache.axis.client.Stub

_call, cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service

Fields inherited from interface javax.xml.rpc.Stub

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
LabelServiceSoapBindingStub()
LabelServiceSoapBindingStub(javax.xml.rpc.Service service)
LabelServiceSoapBindingStub(URL endpointURL, javax.xml.rpc.Service service)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.axis.client.Call	createCall()
Label	createLabel(Label label) Creates a new Label.
Label[]	createLabels(Label[] labels) Creates new Label objects.
Label	getLabel(Long labelId) Returns the Label uniquely identified by the given ID.
LabelPage	getLabelsByStatement(Statement filterStatement) Gets a LabelPage of Label objects that satisfy the given Statement.query.
UpdateResult	performLabelAction(LabelAction labelAction, Statement filterStatement) Performs actions on Label objects that match the given Statement.query.
Label	updateLabel(Label label) Updates the specified Label.
Label[]	updateLabels(Label[] labels) Updates the specified Label objects.

Methods inherited from class org.apache.axis.client.Stub

_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LabelServiceSoapBindingStub

public LabelServiceSoapBindingStub()
                            throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

LabelServiceSoapBindingStub

public LabelServiceSoapBindingStub(URL endpointURL,
                           javax.xml.rpc.Service service)
                            throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

LabelServiceSoapBindingStub

public LabelServiceSoapBindingStub(javax.xml.rpc.Service service)
                            throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

Method Detail

createCall

protected org.apache.axis.client.Call createCall()
                                          throws RemoteException

Throws:

RemoteException

createLabel

public Label createLabel(Label label)
                  throws RemoteException,
                         ApiException

Description copied from interface: LabelServiceInterface

Creates a new Label. The following fields are required:

• Label.name
• Label#type

Specified by:

createLabel in interface LabelServiceInterface

Parameters:

label - the label to create

Returns:

the label with its ID filled in

Throws:

RemoteException

ApiException

createLabels

public Label[] createLabels(Label[] labels)
                     throws RemoteException,
                            ApiException

Description copied from interface: LabelServiceInterface

Creates new Label objects.

Specified by:

createLabels in interface LabelServiceInterface

Parameters:

labels - the labels to create

Returns:

the created labels with their IDs filled in

Throws:

RemoteException

ApiException

getLabel

public Label getLabel(Long labelId)
               throws RemoteException,
                      ApiException

Description copied from interface: LabelServiceInterface

Returns the Label uniquely identified by the given ID.

Specified by:

getLabel in interface LabelServiceInterface

Parameters:

labelId - the ID of the label, which must already exist

Returns:

the Label uniquely identified by the given ID

Throws:

RemoteException

ApiException

getLabelsByStatement

public LabelPage getLabelsByStatement(Statement filterStatement)
                               throws RemoteException,
                                      ApiException

Description copied from interface: LabelServiceInterface

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

PQL Property	Object Property
id	Label.id
type	Label#type
name	Label.name
description	Label.description
isActive	Label.isActive

Specified by:

getLabelsByStatement in interface LabelServiceInterface

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of labels.

Returns:

the labels that match the given filter

Throws:

RemoteException

ApiException

performLabelAction

public UpdateResult performLabelAction(LabelAction labelAction,
                              Statement filterStatement)
                                throws RemoteException,
                                       ApiException

Description copied from interface: LabelServiceInterface

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

Specified by:

performLabelAction in interface LabelServiceInterface

Parameters:

labelAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of labels

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateLabel

public Label updateLabel(Label label)
                  throws RemoteException,
                         ApiException

Description copied from interface: LabelServiceInterface

Updates the specified Label.

Specified by:

updateLabel in interface LabelServiceInterface

Parameters:

label - the label to update

Returns:

the updated label

Throws:

RemoteException

ApiException

updateLabels

public Label[] updateLabels(Label[] labels)
                     throws RemoteException,
                            ApiException

Description copied from interface: LabelServiceInterface

Updates the specified Label objects.

Specified by:

updateLabels in interface LabelServiceInterface

Parameters:

labels - the labels to update

Returns:

the updated labels

Throws:

RemoteException

ApiException