com.google.api.ads.adwords.axis.utility.extension.delegates

Class AbstractGetDelegate<T,S>

java.lang.Object

com.google.api.ads.adwords.axis.utility.extension.delegates.AbstractBaseDelegate<S>

com.google.api.ads.adwords.axis.utility.extension.delegates.AbstractGetDelegate<T,S>

Type Parameters:

T - type of object that the Service works with, for example Campaign, AdGroup, etc.

S - the service interface class. This is a class representing a SOAP service.

Implementation is not thread-safe, because AdWordsSession and Apache Axis service objects are not thread-safe.

Direct Known Subclasses:

AbstractGetMutateDelegate, DataAdGroupBidLandscapeDelegate, DataCriterionBidLandscapeDelegate, LocationCriterionDelegate, MediaDelegate

public abstract class AbstractGetDelegate<T,S>
extends AbstractBaseDelegate<S>

Abstract class that encapsulates gets, fields and selectors.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGetDelegate(AdWordsSession adWordsSession, Class<T> classT, Class<S> classS) Constructor without fields, used in services that do not support Generic Selectors.
protected	AbstractGetDelegate(AdWordsSession adWordsSession, Class<T> classT, Class<S> classS, List<? extends SelectorFields.FieldType<T>> selectorFields) Constructor with fields, used in services that support Generic Selectors.
protected	AbstractGetDelegate(AdWordsSession adWordsSession, Class<T> classT, S service) Constructor without fields, used in services that do not support Generic Selectors and with custom service.
protected	AbstractGetDelegate(AdWordsSession adWordsSession, Class<T> classT, S service, List<? extends SelectorFields.FieldType<T>> selectorFields) Constructor with fields, used in services that support Generic Selectors.

Method Summary

Modifier and Type	Method and Description
protected SelectorBuilder	createSelectorBuilder() Creates a Generic Selector Builder with all the fields declared in the subClass.
List<T>	get() Gets all <T> objects using a Generic Selector without predicates.
List<T>	get(int startIndex, int numberResults) Gets all <T> objects using a Generic Selector with Paging without predicates.
List<T>	get(com.google.api.ads.adwords.axis.v201506.cm.Selector selector) Calls the appropriate Get method declared by the ServiceInterface S.
protected List<T>	getByField(SelectorFields.FieldType<T> selectorField, List<Long> fieldValues) Gets all the <T> objects using a Generic Selector with a predicate for a list of values.
protected List<T>	getByField(SelectorFields.FieldType<T> selectorField, long fieldValue, int startIndex, int numberResults) Gets all the <T> objects using a Generic Selector with a single predicate for a list of values using pagination.
protected List<T>	getByField(SelectorFields.FieldType<T> selectorField, Object fieldValue) Gets all the <T> objects using a Generic Selector with a predicate for one field value.
protected List<T>	getByField(SelectorFields.FieldType<T> selectorField, String fieldValue, int startIndex, int numberResults) Gets all the <T> objects using a Generic Selector with a predicate for a list of values using pagination.
protected List<T>	getByFieldContainsAny(SelectorFields.FieldType<T> selectorField, List<Long> fieldValues) Gets all the <T> objects using a Generic Selector with a containsAny predicate for a list of values.
Class<T>	getClassT() Returns the classT type.
protected T	getOneByField(SelectorFields.FieldType<T> selectorField, Object fieldValue) Gets a single <T> object using a Generic Selector with a predicate for one field value, null if the object does not exist and an exception if there are more than one matches.
protected Object	getPage(com.google.api.ads.adwords.axis.v201506.cm.Selector selector) Calls the appropriate Get method declared by the ServiceInterface S.
protected void	setGetMethodName(String getMethodName) Returns the name of the "get" method defined in the AdWords Service.

Methods inherited from class com.google.api.ads.adwords.axis.utility.extension.delegates.AbstractBaseDelegate

getAdWordsSession, getService

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGetDelegate

protected AbstractGetDelegate(AdWordsSession adWordsSession,
                              Class<T> classT,
                              Class<S> classS)

Constructor without fields, used in services that do not support Generic Selectors.

Fields are not necessary for Services that do not use Generic Selectors.

Parameters:

adWordsSession - the adWordsSession to use with the service

classT - type of object that the Service works with, for example Campaign, AdGroup, etc.

classS - the service interface class for the SOAP service

AbstractGetDelegate

protected AbstractGetDelegate(AdWordsSession adWordsSession,
                              Class<T> classT,
                              S service)

Constructor without fields, used in services that do not support Generic Selectors and with custom service.

Fields are not necessary for Services that do not use Generic Selectors.

Parameters:

adWordsSession - the adWordsSession to use with the service

classT - type of object that the Service works with, for example Campaign, AdGroup, etc.

service - the custom service class for the SOAP service

AbstractGetDelegate

protected AbstractGetDelegate(AdWordsSession adWordsSession,
                              Class<T> classT,
                              Class<S> classS,
                              List<? extends SelectorFields.FieldType<T>> selectorFields)

Constructor with fields, used in services that support Generic Selectors.

Parameters:

adWordsSession - the adWordsSession to use with the service

classT - type of object that the Service works with, for example Campaign, AdGroup, etc.

classS - the service interface class for the SOAP service

selectorFields - for the Generic Selectors using the SelectorField class

AbstractGetDelegate

protected AbstractGetDelegate(AdWordsSession adWordsSession,
                              Class<T> classT,
                              S service,
                              List<? extends SelectorFields.FieldType<T>> selectorFields)

Constructor with fields, used in services that support Generic Selectors.

Parameters:

adWordsSession - the adWordsSession to use with the service

classT - type of object that the Service works with, for example Campaign, AdGroup, etc.

service - the custom service class for the SOAP service

selectorFields - for the Generic Selectors using the SelectorField class

Method Detail

getClassT

public Class<T> getClassT()

Returns the classT type.

Returns:

classT type of object that the Service works with, for example Campaign, AdGroup, etc.

setGetMethodName

protected void setGetMethodName(String getMethodName)

Returns the name of the "get" method defined in the AdWords Service.

Parameters:

getMethodName - the name of the "get" method defined in the AdWords Service

get

public List<T> get(com.google.api.ads.adwords.axis.v201506.cm.Selector selector)
            throws RemoteException

Calls the appropriate Get method declared by the ServiceInterface S.

This method should be overridden by delegates for Services that do not support Generic Selectors.

Parameters:

selector - should be a Generic Selector (com.google.api.adwords.v201506.cm.Selector) or a specific Selector appropriate to the ServiceInterface used that does not support Generic Selectors

Returns:

a list of <T>

Throws:

RemoteException - for communication-related exceptions

getPage

protected Object getPage(com.google.api.ads.adwords.axis.v201506.cm.Selector selector)
                  throws RemoteException

Calls the appropriate Get method declared by the ServiceInterface S. Gets the full page of elements without calling getEntries.

Parameters:

selector - should be a Generic Selector (com.google.api.adwords.v201506.cm.Selector) or a specific Selector appropriate to the ServiceInterface used that does not support Generic Selectors

Returns:

Object, because AdParamPage does not extend Page

Throws:

RemoteException - for communication-related exceptions

createSelectorBuilder

protected SelectorBuilder createSelectorBuilder()

Creates a Generic Selector Builder with all the fields declared in the subClass.

get

public List<T> get()
            throws RemoteException

Gets all <T> objects using a Generic Selector without predicates.

Returns:

all the <T> objects for the ManagedCustomer

Throws:

RemoteException - for communication-related exceptions

get

public List<T> get(int startIndex,
                   int numberResults)
            throws RemoteException

Gets all <T> objects using a Generic Selector with Paging without predicates.

Parameters:

startIndex - index of the first result to retrieve

numberResults - total number of result to retrieve

Returns:

all the <T> objects for the ManagedCustomer

Throws:

RemoteException - for communication-related exceptions

getOneByField

protected T getOneByField(SelectorFields.FieldType<T> selectorField,
                          Object fieldValue)
                   throws RemoteException

Gets a single <T> object using a Generic Selector with a predicate for one field value, null if the object does not exist and an exception if there are more than one matches.

Parameters:

selectorField - name of the field

fieldValue - value for the field in the predicate

Returns:

the first <T> object matching the fieldValue

Throws:

RemoteException - for communication-related exceptions

getByField

protected List<T> getByField(SelectorFields.FieldType<T> selectorField,
                             Object fieldValue)
                      throws RemoteException

Gets all the <T> objects using a Generic Selector with a predicate for one field value.

Parameters:

selectorField - name of the field

fieldValue - value for the field in the predicate

Returns:

all the <T> objects matching the fieldValue

Throws:

RemoteException - for communication-related exceptions

getByField

protected List<T> getByField(SelectorFields.FieldType<T> selectorField,
                             List<Long> fieldValues)
                      throws RemoteException

Gets all the <T> objects using a Generic Selector with a predicate for a list of values.

Parameters:

selectorField - name of the field

fieldValues - list of values for the field in the predicate

Returns:

all the <T> objects matching the fieldValues

Throws:

RemoteException - for communication-related exceptions

getByField

protected List<T> getByField(SelectorFields.FieldType<T> selectorField,
                             long fieldValue,
                             int startIndex,
                             int numberResults)
                      throws RemoteException

Gets all the <T> objects using a Generic Selector with a single predicate for a list of values using pagination.

Parameters:

selectorField - name of the field

fieldValue - list of values for the field in the predicate

startIndex - index of the first result

numberResults - number of results

Returns:

all the <T> objects matching the fieldValues in the range (startIndex, numberResults)

Throws:

RemoteException - for communication-related exceptions

getByField

protected List<T> getByField(SelectorFields.FieldType<T> selectorField,
                             String fieldValue,
                             int startIndex,
                             int numberResults)
                      throws RemoteException

Gets all the <T> objects using a Generic Selector with a predicate for a list of values using pagination.

Parameters:

selectorField - name of the field

fieldValue - list of values for the field in the predicate

startIndex - index of the first result

numberResults - number of results

Returns:

all the <T> objects matching the fieldValues in the range (startIndex, numberResults)

Throws:

RemoteException - for communication-related exceptions

getByFieldContainsAny

protected List<T> getByFieldContainsAny(SelectorFields.FieldType<T> selectorField,
                                        List<Long> fieldValues)
                                 throws RemoteException

Gets all the <T> objects using a Generic Selector with a containsAny predicate for a list of values.

Parameters:

selectorField - name of the field

fieldValues - list of values for the field in the predicate

Returns:

all the <T> objects matching the fieldValues

Throws:

RemoteException - for communication-related exceptions