com.evernote.edam.notestore
Class AdParameters

java.lang.Object
  extended by com.evernote.edam.notestore.AdParameters
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class AdParameters
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Parameters that will be given by a client to the service when it requests a set of advertisements to display. If any of these values are omitted, the service will use default values.

clientLanguage
The ISO 639-1 language code for the primary language for the client. If omitted, English will be assumed ('en').
impressions
A list of the impression counts and total display time for the ads that were displayed in the last day.
supportHtml
If true, the client requesting the ads supports ads specified via general HTML (with rich media, Javascript, etc.).
clientProperties
If provided, this may contain a set of key/value pairs that identify the characteristics of a particular client that may be used to help determine appropriate ads for that client. These tuples may be used either to reduce or increase the likelihood that each ad will be returned.

See Also:
Serialized Form

Nested Class Summary
static class AdParameters._Fields
          The set of fields this struct contains, along with convenience methods for finding and manipulating them.
 
Field Summary
static java.util.Map<AdParameters._Fields,FieldMetaData> metaDataMap
           
 
Constructor Summary
AdParameters()
           
AdParameters(AdParameters other)
          Performs a deep copy on other.
 
Method Summary
 void addToImpressions(AdImpressions elem)
           
 void clear()
           
 int compareTo(AdParameters other)
           
 AdParameters deepCopy()
           
 boolean equals(AdParameters that)
           
 boolean equals(java.lang.Object that)
           
 AdParameters._Fields fieldForId(int fieldId)
           
 java.lang.String getClientLanguage()
           
 java.util.Map<java.lang.String,java.lang.String> getClientProperties()
           
 int getClientPropertiesSize()
           
 java.lang.Object getFieldValue(AdParameters._Fields field)
           
 java.util.List<AdImpressions> getImpressions()
           
 java.util.Iterator<AdImpressions> getImpressionsIterator()
           
 int getImpressionsSize()
           
 int hashCode()
           
 boolean isSet(AdParameters._Fields field)
          Returns true if field corresponding to fieldID is set (has been asigned a value) and false otherwise
 boolean isSetClientLanguage()
          Returns true if field clientLanguage is set (has been asigned a value) and false otherwise
 boolean isSetClientProperties()
          Returns true if field clientProperties is set (has been asigned a value) and false otherwise
 boolean isSetImpressions()
          Returns true if field impressions is set (has been asigned a value) and false otherwise
 boolean isSetSupportHtml()
          Returns true if field supportHtml is set (has been asigned a value) and false otherwise
 boolean isSupportHtml()
           
 void putToClientProperties(java.lang.String key, java.lang.String val)
           
 void read(TProtocol iprot)
           
 void setClientLanguage(java.lang.String clientLanguage)
           
 void setClientLanguageIsSet(boolean value)
           
 void setClientProperties(java.util.Map<java.lang.String,java.lang.String> clientProperties)
           
 void setClientPropertiesIsSet(boolean value)
           
 void setFieldValue(AdParameters._Fields field, java.lang.Object value)
           
 void setImpressions(java.util.List<AdImpressions> impressions)
           
 void setImpressionsIsSet(boolean value)
           
 void setSupportHtml(boolean supportHtml)
           
 void setSupportHtmlIsSet(boolean value)
           
 java.lang.String toString()
           
 void unsetClientLanguage()
           
 void unsetClientProperties()
           
 void unsetImpressions()
           
 void unsetSupportHtml()
           
 void validate()
           
 void write(TProtocol oprot)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

metaDataMap

public static final java.util.Map<AdParameters._Fields,FieldMetaData> metaDataMap
Constructor Detail

AdParameters

public AdParameters()

AdParameters

public AdParameters(AdParameters other)
Performs a deep copy on other.

Method Detail

deepCopy

public AdParameters deepCopy()

clear

public void clear()

getClientLanguage

public java.lang.String getClientLanguage()

setClientLanguage

public void setClientLanguage(java.lang.String clientLanguage)

unsetClientLanguage

public void unsetClientLanguage()

isSetClientLanguage

public boolean isSetClientLanguage()
Returns true if field clientLanguage is set (has been asigned a value) and false otherwise


setClientLanguageIsSet

public void setClientLanguageIsSet(boolean value)

getImpressionsSize

public int getImpressionsSize()

getImpressionsIterator

public java.util.Iterator<AdImpressions> getImpressionsIterator()

addToImpressions

public void addToImpressions(AdImpressions elem)

getImpressions

public java.util.List<AdImpressions> getImpressions()

setImpressions

public void setImpressions(java.util.List<AdImpressions> impressions)

unsetImpressions

public void unsetImpressions()

isSetImpressions

public boolean isSetImpressions()
Returns true if field impressions is set (has been asigned a value) and false otherwise


setImpressionsIsSet

public void setImpressionsIsSet(boolean value)

isSupportHtml

public boolean isSupportHtml()

setSupportHtml

public void setSupportHtml(boolean supportHtml)

unsetSupportHtml

public void unsetSupportHtml()

isSetSupportHtml

public boolean isSetSupportHtml()
Returns true if field supportHtml is set (has been asigned a value) and false otherwise


setSupportHtmlIsSet

public void setSupportHtmlIsSet(boolean value)

getClientPropertiesSize

public int getClientPropertiesSize()

putToClientProperties

public void putToClientProperties(java.lang.String key,
                                  java.lang.String val)

getClientProperties

public java.util.Map<java.lang.String,java.lang.String> getClientProperties()

setClientProperties

public void setClientProperties(java.util.Map<java.lang.String,java.lang.String> clientProperties)

unsetClientProperties

public void unsetClientProperties()

isSetClientProperties

public boolean isSetClientProperties()
Returns true if field clientProperties is set (has been asigned a value) and false otherwise


setClientPropertiesIsSet

public void setClientPropertiesIsSet(boolean value)

setFieldValue

public void setFieldValue(AdParameters._Fields field,
                          java.lang.Object value)

getFieldValue

public java.lang.Object getFieldValue(AdParameters._Fields field)

isSet

public boolean isSet(AdParameters._Fields field)
Returns true if field corresponding to fieldID is set (has been asigned a value) and false otherwise


equals

public boolean equals(java.lang.Object that)
Overrides:
equals in class java.lang.Object

equals

public boolean equals(AdParameters that)

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

compareTo

public int compareTo(AdParameters other)

fieldForId

public AdParameters._Fields fieldForId(int fieldId)

read

public void read(TProtocol iprot)
          throws TException
Throws:
TException

write

public void write(TProtocol oprot)
           throws TException
Throws:
TException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

validate

public void validate()
              throws TException
Throws:
TException