Changes since
the last release

com.ebay.sdk.call
Class GetCharitiesCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.GetCharitiesCall

public class GetCharitiesCall
extends ApiCall

Wrapper class of the GetCharities call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.


Input property: CharityID - A unique identification number assigned to a nonprofit organization when that organization registers with the PayPal Giving Fund. If a CharityID value is used in the request, all other search filters set in the call request will be ignored, as the call will only search for the specified nonprofit organization.
Input property: CharityName - This field will accept the full or partial name of a registered nonprofit organization. For example, if you pass in a value of heart, all registered nonprofit organizations with "heart" in their name may be returned in the response. If the MatchType field is used and set to StartsWith (default value), or is not used at all, the phrase "heart" must come at the beginning of the nonprofit organization's name to be returned. However, if the MatchType field is used and set to Contains, all registered nonprofit organizations with "heart" in their name should be returned in the response. The string passed in this field is not case-sensitive.


Input property: Query - This field accept any string up to 350 characters in length. The functionality of this field is similar to the CharityName field, except that the call will also search for the supplied query string within the charity's mission statement (which is returned under the Charity.Mission field in the response). If you pass in a value of heart, all registered nonprofit organizations with "heart" in their name or in their mission statement may be returned in the response.

The string passed in this field is not case-sensitive. The MatchType field will have no effect if the Query field is used, as the MatchType field will only have an effect if a CharityName string field is included.


Input property: CharityRegion - This field can be used to search for registered nonprofit organizations within a specified geographical region. Each geographical region will have an integer value associated with it. This integer value is what is passed in to this field.
Input property: CharityDomain - This field can be used to search for registered nonprofit organizations within a specified charitable domain. Each charitable domain will have an integer value associated with it. This integer value is what is passed in to this field. Nonprofit organizations can be associated with multiple charitable domains.
Input property: IncludeDescription - This field should be included and set to true if a user wants the charity's description to appear in the response. Note that not all charitable organizations will have defined descriptions.
Input property: MatchType - This filter is used if the user wants to specify where to look for the string specified in the CharityName field. The enumeration value input into this field controls the type of string matching to use when a value is submitted in the CharityName field. If this field is omitted, and a CharityName string is used, this parameter value defaults to StartsWith.

This field is not applicable when a Query value is used.

Input property: Featured - This boolean field is used and set to true if the user wants to search for nonprofit organizations currently featured on the eBay for Charity site.
Input property: CampaignID - Reserved for future use.
Output property: ReturnedCharities - Each Charity container consists of information about a specific nonprofit organization. Each nonprofit organization is identified by the id attribute of the container. If no nonprofit organization are found that match the input criteria, no Charity containers are returned.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetCharitiesCall()
          Constructor.
GetCharitiesCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.Long getCampaignID()
          Gets the GetCharitiesRequestType.campaignID.
 void getCharities()
          The GetCharities call is used to search for nonprofit organizations that are registered with the eBay for Charity program.
 java.lang.Integer getCharityDomain()
          Gets the GetCharitiesRequestType.charityDomain.
 java.lang.String getCharityID()
          Gets the GetCharitiesRequestType.charityID.
 java.lang.String getCharityName()
          Gets the GetCharitiesRequestType.charityName.
 java.lang.Integer getCharityRegion()
          Gets the GetCharitiesRequestType.charityRegion.
 java.lang.Boolean getFeatured()
          Gets the GetCharitiesRequestType.featured.
 java.lang.Boolean getIncludeDescription()
          Gets the GetCharitiesRequestType.includeDescription.
 StringMatchCodeType getMatchType()
          Gets the GetCharitiesRequestType.matchType.
 GetCharitiesRequestType getOverrideRequest()
          Gets the GetCharitiesRequestType.overrideRequest.
 java.lang.String getQuery()
          Gets the GetCharitiesRequestType.query.
 CharityInfoType[] getReturnedCharities()
          Valid after executing the API.
 void setCampaignID(java.lang.Long campaignID)
          Sets the GetCharitiesRequestType.campaignID.
 void setCharityDomain(java.lang.Integer charityDomain)
          Sets the GetCharitiesRequestType.charityDomain.
 void setCharityID(java.lang.String charityID)
          Sets the GetCharitiesRequestType.charityID.
 void setCharityName(java.lang.String charityName)
          Sets the GetCharitiesRequestType.charityName.
 void setCharityRegion(java.lang.Integer charityRegion)
          Sets the GetCharitiesRequestType.charityRegion.
 void setFeatured(java.lang.Boolean featured)
          Sets the GetCharitiesRequestType.featured.
 void setIncludeDescription(java.lang.Boolean includeDescription)
          Sets the GetCharitiesRequestType.includeDescription.
 void setMatchType(StringMatchCodeType matchType)
          Sets the GetCharitiesRequestType.matchType.
 void setOverrideRequest(GetCharitiesRequestType overrideRequest)
          Sets the GetCharitiesRequestType.overrideRequest.
 void setQuery(java.lang.String query)
          Sets the GetCharitiesRequestType.query.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GetCharitiesCall

public GetCharitiesCall()
Constructor.


GetCharitiesCall

public GetCharitiesCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

getCharities

public void getCharities()
                  throws ApiException,
                         SdkException,
                         java.lang.Exception
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 charitable domain, and/or geographical region, or by using a search string.

Throws:
ApiException
SdkException
java.lang.Exception

getOverrideRequest

public GetCharitiesRequestType getOverrideRequest()
Gets the GetCharitiesRequestType.overrideRequest.

Returns:
GetCharitiesRequestType

setOverrideRequest

public void setOverrideRequest(GetCharitiesRequestType overrideRequest)
Sets the GetCharitiesRequestType.overrideRequest.

Parameters:
overrideRequest - GetCharitiesRequestType

getCampaignID

public java.lang.Long getCampaignID()
Gets the GetCharitiesRequestType.campaignID.

Returns:
Long

setCampaignID

public void setCampaignID(java.lang.Long campaignID)
Sets the GetCharitiesRequestType.campaignID.

Parameters:
campaignID - Long

getCharityDomain

public java.lang.Integer getCharityDomain()
Gets the GetCharitiesRequestType.charityDomain.

Returns:
Integer

setCharityDomain

public void setCharityDomain(java.lang.Integer charityDomain)
Sets the GetCharitiesRequestType.charityDomain.

Parameters:
charityDomain - Integer

getCharityID

public java.lang.String getCharityID()
Gets the GetCharitiesRequestType.charityID.

Returns:
String

setCharityID

public void setCharityID(java.lang.String charityID)
Sets the GetCharitiesRequestType.charityID.

Parameters:
charityID - String

getCharityName

public java.lang.String getCharityName()
Gets the GetCharitiesRequestType.charityName.

Returns:
String

setCharityName

public void setCharityName(java.lang.String charityName)
Sets the GetCharitiesRequestType.charityName.

Parameters:
charityName - String

getCharityRegion

public java.lang.Integer getCharityRegion()
Gets the GetCharitiesRequestType.charityRegion.

Returns:
Integer

setCharityRegion

public void setCharityRegion(java.lang.Integer charityRegion)
Sets the GetCharitiesRequestType.charityRegion.

Parameters:
charityRegion - Integer

getFeatured

public java.lang.Boolean getFeatured()
Gets the GetCharitiesRequestType.featured.

Returns:
Boolean

setFeatured

public void setFeatured(java.lang.Boolean featured)
Sets the GetCharitiesRequestType.featured.

Parameters:
featured - Boolean

getIncludeDescription

public java.lang.Boolean getIncludeDescription()
Gets the GetCharitiesRequestType.includeDescription.

Returns:
Boolean

setIncludeDescription

public void setIncludeDescription(java.lang.Boolean includeDescription)
Sets the GetCharitiesRequestType.includeDescription.

Parameters:
includeDescription - Boolean

getMatchType

public StringMatchCodeType getMatchType()
Gets the GetCharitiesRequestType.matchType.

Returns:
StringMatchCodeType

setMatchType

public void setMatchType(StringMatchCodeType matchType)
Sets the GetCharitiesRequestType.matchType.

Parameters:
matchType - StringMatchCodeType

getQuery

public java.lang.String getQuery()
Gets the GetCharitiesRequestType.query.

Returns:
String

setQuery

public void setQuery(java.lang.String query)
Sets the GetCharitiesRequestType.query.

Parameters:
query - String

getReturnedCharities

public CharityInfoType[] getReturnedCharities()
Valid after executing the API. Gets the returned GetCharitiesResponseType.returnedCharities.

Returns:
CharityInfoType[]

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.