com.google.api.ads.adwords.v201109.cm
Class ReportDefinitionField

java.lang.Object
  com.google.api.ads.adwords.v201109.cm.ReportDefinitionField

All Implemented Interfaces:

Serializable

public class ReportDefinitionField
extends Object
implements Serializable

Represents the fields that can be used to create a ReportDefinition. This class allows the user to query the list of fields applicable to a given report type. Consumers of reports will be able use the retrieved fields through the ReportDefinitionService#getReportFields api and run the corresponding reports.

See Also:

Serialized Form

Constructor Summary

ReportDefinitionField()

ReportDefinitionField(String fieldName, String displayFieldName, String xmlAttributeName, String fieldType, String[] enumValues, Boolean canSelect, Boolean canFilter, Boolean isEnumType, EnumValuePair[] enumValuePairs)

Method Summary

boolean	equals(Object obj)
Boolean	getCanFilter() Gets the canFilter value for this ReportDefinitionField.
Boolean	getCanSelect() Gets the canSelect value for this ReportDefinitionField.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
String	getDisplayFieldName() Gets the displayFieldName value for this ReportDefinitionField.
EnumValuePair[]	getEnumValuePairs() Gets the enumValuePairs value for this ReportDefinitionField.
EnumValuePair	getEnumValuePairs(int i)
String[]	getEnumValues() Gets the enumValues value for this ReportDefinitionField.
String	getEnumValues(int i)
String	getFieldName() Gets the fieldName value for this ReportDefinitionField.
String	getFieldType() Gets the fieldType value for this ReportDefinitionField.
Boolean	getIsEnumType() Gets the isEnumType value for this ReportDefinitionField.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
String	getXmlAttributeName() Gets the xmlAttributeName value for this ReportDefinitionField.
int	hashCode()
void	setCanFilter(Boolean canFilter) Sets the canFilter value for this ReportDefinitionField.
void	setCanSelect(Boolean canSelect) Sets the canSelect value for this ReportDefinitionField.
void	setDisplayFieldName(String displayFieldName) Sets the displayFieldName value for this ReportDefinitionField.
void	setEnumValuePairs(EnumValuePair[] enumValuePairs) Sets the enumValuePairs value for this ReportDefinitionField.
void	setEnumValuePairs(int i, EnumValuePair _value)
void	setEnumValues(int i, String _value)
void	setEnumValues(String[] enumValues) Sets the enumValues value for this ReportDefinitionField.
void	setFieldName(String fieldName) Sets the fieldName value for this ReportDefinitionField.
void	setFieldType(String fieldType) Sets the fieldType value for this ReportDefinitionField.
void	setIsEnumType(Boolean isEnumType) Sets the isEnumType value for this ReportDefinitionField.
void	setXmlAttributeName(String xmlAttributeName) Sets the xmlAttributeName value for this ReportDefinitionField.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportDefinitionField

public ReportDefinitionField()

ReportDefinitionField

public ReportDefinitionField(String fieldName,
                             String displayFieldName,
                             String xmlAttributeName,
                             String fieldType,
                             String[] enumValues,
                             Boolean canSelect,
                             Boolean canFilter,
                             Boolean isEnumType,
                             EnumValuePair[] enumValuePairs)

Method Detail

getFieldName

public String getFieldName()

Gets the fieldName value for this ReportDefinitionField.

Returns:

fieldName * The field name. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setFieldName

public void setFieldName(String fieldName)

Sets the fieldName value for this ReportDefinitionField.

Parameters:

fieldName - * The field name. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getDisplayFieldName

public String getDisplayFieldName()

Gets the displayFieldName value for this ReportDefinitionField.

Returns:

displayFieldName * The name that is displayed in the downloaded report. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setDisplayFieldName

public void setDisplayFieldName(String displayFieldName)

Sets the displayFieldName value for this ReportDefinitionField.

Parameters:

displayFieldName - * The name that is displayed in the downloaded report. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getXmlAttributeName

public String getXmlAttributeName()

Gets the xmlAttributeName value for this ReportDefinitionField.

Returns:

xmlAttributeName * The XML attribute in the downloaded report. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setXmlAttributeName

public void setXmlAttributeName(String xmlAttributeName)

Sets the xmlAttributeName value for this ReportDefinitionField.

Parameters:

xmlAttributeName - * The XML attribute in the downloaded report. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getFieldType

public String getFieldType()

Gets the fieldType value for this ReportDefinitionField.

Returns:

fieldType * The type of field. Useful for knowing what operation type to pass in for a given field in a predicate. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setFieldType

public void setFieldType(String fieldType)

Sets the fieldType value for this ReportDefinitionField.

Parameters:

fieldType - * The type of field. Useful for knowing what operation type to pass in for a given field in a predicate. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getEnumValues

public String[] getEnumValues()

Gets the enumValues value for this ReportDefinitionField.

Returns:

enumValues * List of enum values for the corresponing field iff the field is an enum type. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setEnumValues

public void setEnumValues(String[] enumValues)

Sets the enumValues value for this ReportDefinitionField.

Parameters:

enumValues - * List of enum values for the corresponing field iff the field is an enum type. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getEnumValues

public String getEnumValues(int i)

setEnumValues

public void setEnumValues(int i,
                          String _value)

getCanSelect

public Boolean getCanSelect()

Gets the canSelect value for this ReportDefinitionField.

Returns:

canSelect * Indicates if the user can select this field. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setCanSelect

public void setCanSelect(Boolean canSelect)

Sets the canSelect value for this ReportDefinitionField.

Parameters:

canSelect - * Indicates if the user can select this field. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getCanFilter

public Boolean getCanFilter()

Gets the canFilter value for this ReportDefinitionField.

Returns:

canFilter * Indicates if the user can filter on this field. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setCanFilter

public void setCanFilter(Boolean canFilter)

Sets the canFilter value for this ReportDefinitionField.

Parameters:

canFilter - * Indicates if the user can filter on this field. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getIsEnumType

public Boolean getIsEnumType()

Gets the isEnumType value for this ReportDefinitionField.

Returns:

isEnumType * Indicates that the field is an enum type. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setIsEnumType

public void setIsEnumType(Boolean isEnumType)

Sets the isEnumType value for this ReportDefinitionField.

Parameters:

isEnumType - * Indicates that the field is an enum type. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getEnumValuePairs

public EnumValuePair[] getEnumValuePairs()

Gets the enumValuePairs value for this ReportDefinitionField.

Returns:

enumValuePairs * List of enum values in api to their corresponding display values in the downloaded reports. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setEnumValuePairs

public void setEnumValuePairs(EnumValuePair[] enumValuePairs)

Sets the enumValuePairs value for this ReportDefinitionField.

Parameters:

enumValuePairs - * List of enum values in api to their corresponding display values in the downloaded reports. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getEnumValuePairs

public EnumValuePair getEnumValuePairs(int i)

setEnumValuePairs

public void setEnumValuePairs(int i,
                              EnumValuePair _value)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)

Get Custom Deserializer