Changes since
the last release

com.ebay.soap.eBLBaseComponents
Class GetCharitiesRequestType

java.lang.Object
  extended by com.ebay.soap.eBLBaseComponents.AbstractRequestType
      extended by com.ebay.soap.eBLBaseComponents.GetCharitiesRequestType
All Implemented Interfaces:
java.io.Serializable

public class GetCharitiesRequestType
extends AbstractRequestType
implements java.io.Serializable

The GetCharities call is used to search for nonprofit organizations that are registered with the eBay for Charity program. This call allows users to search for a specific nonprofit organization, or to search for multiple nonprofit organizations from a particular category, and/or geographical region, or by using a search string.

Java class for GetCharitiesRequestType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="GetCharitiesRequestType">
   <complexContent>
     <extension base="{urn:ebay:apis:eBLBaseComponents}AbstractRequestType">
       <sequence>
         <element name="CharityID" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CharityName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Query" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="CharityRegion" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="CharityDomain" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="IncludeDescription" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="MatchType" type="{urn:ebay:apis:eBLBaseComponents}StringMatchCodeType" minOccurs="0"/>
         <element name="Featured" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="CampaignID" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

See Also:
Serialized Form

Field Summary
protected  java.lang.Long campaignID
           
protected  java.lang.Integer charityDomain
           
protected  java.lang.String charityID
           
protected  java.lang.String charityName
           
protected  java.lang.Integer charityRegion
           
protected  java.lang.Boolean featured
           
protected  java.lang.Boolean includeDescription
           
protected  StringMatchCodeType matchType
           
protected  java.lang.String query
           
 
Fields inherited from class com.ebay.soap.eBLBaseComponents.AbstractRequestType
any, botBlock, detailLevel, endUserIP, errorHandling, errorLanguage, invocationID, messageID, outputSelector, version, warningLevel
 
Constructor Summary
GetCharitiesRequestType()
           
 
Method Summary
 java.lang.Long getCampaignID()
          Gets the value of the campaignID property.
 java.lang.Integer getCharityDomain()
          Gets the value of the charityDomain property.
 java.lang.String getCharityID()
          Gets the value of the charityID property.
 java.lang.String getCharityName()
          Gets the value of the charityName property.
 java.lang.Integer getCharityRegion()
          Gets the value of the charityRegion property.
 StringMatchCodeType getMatchType()
          Gets the value of the matchType property.
 java.lang.String getQuery()
          Gets the value of the query property.
 java.lang.Boolean isFeatured()
          Gets the value of the featured property.
 java.lang.Boolean isIncludeDescription()
          Gets the value of the includeDescription property.
 void setCampaignID(java.lang.Long value)
          Sets the value of the campaignID property.
 void setCharityDomain(java.lang.Integer value)
          Sets the value of the charityDomain property.
 void setCharityID(java.lang.String value)
          Sets the value of the charityID property.
 void setCharityName(java.lang.String value)
          Sets the value of the charityName property.
 void setCharityRegion(java.lang.Integer value)
          Sets the value of the charityRegion property.
 void setFeatured(java.lang.Boolean value)
          Sets the value of the featured property.
 void setIncludeDescription(java.lang.Boolean value)
          Sets the value of the includeDescription property.
 void setMatchType(StringMatchCodeType value)
          Sets the value of the matchType property.
 void setQuery(java.lang.String value)
          Sets the value of the query property.
 
Methods inherited from class com.ebay.soap.eBLBaseComponents.AbstractRequestType
_getAny, _getDetailLevel, _getOutputSelector, getAny, getAny, getAnyLength, getBotBlock, getDetailLevel, getDetailLevel, getDetailLevelLength, getEndUserIP, getErrorHandling, getErrorLanguage, getInvocationID, getMessageID, getOutputSelector, getOutputSelector, getOutputSelectorLength, getVersion, getWarningLevel, setAny, setAny, setBotBlock, setDetailLevel, setDetailLevel, setEndUserIP, setErrorHandling, setErrorLanguage, setInvocationID, setMessageID, setOutputSelector, setOutputSelector, setVersion, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

charityID

protected java.lang.String charityID

charityName

protected java.lang.String charityName

query

protected java.lang.String query

charityRegion

protected java.lang.Integer charityRegion

charityDomain

protected java.lang.Integer charityDomain

includeDescription

protected java.lang.Boolean includeDescription

matchType

protected StringMatchCodeType matchType

featured

protected java.lang.Boolean featured

campaignID

protected java.lang.Long campaignID
Constructor Detail

GetCharitiesRequestType

public GetCharitiesRequestType()
Method Detail

getCharityID

public java.lang.String getCharityID()
Gets the value of the charityID property.

Returns:
possible object is String

setCharityID

public void setCharityID(java.lang.String value)
Sets the value of the charityID property.

Parameters:
value - allowed object is String

getCharityName

public java.lang.String getCharityName()
Gets the value of the charityName property.

Returns:
possible object is String

setCharityName

public void setCharityName(java.lang.String value)
Sets the value of the charityName property.

Parameters:
value - allowed object is String

getQuery

public java.lang.String getQuery()
Gets the value of the query property.

Returns:
possible object is String

setQuery

public void setQuery(java.lang.String value)
Sets the value of the query property.

Parameters:
value - allowed object is String

getCharityRegion

public java.lang.Integer getCharityRegion()
Gets the value of the charityRegion property.

Returns:
possible object is Integer

setCharityRegion

public void setCharityRegion(java.lang.Integer value)
Sets the value of the charityRegion property.

Parameters:
value - allowed object is Integer

getCharityDomain

public java.lang.Integer getCharityDomain()
Gets the value of the charityDomain property.

Returns:
possible object is Integer

setCharityDomain

public void setCharityDomain(java.lang.Integer value)
Sets the value of the charityDomain property.

Parameters:
value - allowed object is Integer

isIncludeDescription

public java.lang.Boolean isIncludeDescription()
Gets the value of the includeDescription property.

Returns:
possible object is Boolean

setIncludeDescription

public void setIncludeDescription(java.lang.Boolean value)
Sets the value of the includeDescription property.

Parameters:
value - allowed object is Boolean

getMatchType

public StringMatchCodeType getMatchType()
Gets the value of the matchType property.

Returns:
possible object is StringMatchCodeType

setMatchType

public void setMatchType(StringMatchCodeType value)
Sets the value of the matchType property.

Parameters:
value - allowed object is StringMatchCodeType

isFeatured

public java.lang.Boolean isFeatured()
Gets the value of the featured property.

Returns:
possible object is Boolean

setFeatured

public void setFeatured(java.lang.Boolean value)
Sets the value of the featured property.

Parameters:
value - allowed object is Boolean

getCampaignID

public java.lang.Long getCampaignID()
Gets the value of the campaignID property.

Returns:
possible object is Long

setCampaignID

public void setCampaignID(java.lang.Long value)
Sets the value of the campaignID property.

Parameters:
value - allowed object is Long

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.