|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.GetCharitiesCall
public class GetCharitiesCall
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.
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.
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
, the phrase "heart" must come at the beginning of the nonprofit organization's name. However, if the MatchType field is used and set to Contains
, or is not used at all, 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.
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) as long as the IncludeDescription field is included in the call request and set to true
. 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.
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.
CharityDomain
- This field can be used to search for registered nonprofit organizations within a specified charity domain or category. Each charity 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 charity domains.
IncludeDescription
- This field should be included and set to true
if the Query field is used, and the user wishes to search the charity's name and its mission statement. If this field is omitted or included and set to false
, the call will only search charity names for the specified string in the Query field.
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
.
Featured
- This boolean field is used and set to true
if the user wants to search for nonprofit organizations currently featured on the eBay site.
CampaignID
- Reserved for future use.
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.
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetCharitiesCall()
Constructor. |
|
GetCharitiesCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
Long |
getCampaignID()
Gets the GetCharitiesRequestType.campaignID. |
void |
getCharities()
This is the base request type for the GetCharities call. |
Integer |
getCharityDomain()
Gets the GetCharitiesRequestType.charityDomain. |
String |
getCharityID()
Gets the GetCharitiesRequestType.charityID. |
String |
getCharityName()
Gets the GetCharitiesRequestType.charityName. |
Integer |
getCharityRegion()
Gets the GetCharitiesRequestType.charityRegion. |
Boolean |
getFeatured()
Gets the GetCharitiesRequestType.featured. |
Boolean |
getIncludeDescription()
Gets the GetCharitiesRequestType.includeDescription. |
StringMatchCodeType |
getMatchType()
Gets the GetCharitiesRequestType.matchType. |
GetCharitiesRequestType |
getOverrideRequest()
Gets the GetCharitiesRequestType.overrideRequest. |
String |
getQuery()
Gets the GetCharitiesRequestType.query. |
CharityInfoType[] |
getReturnedCharities()
Valid after executing the API. |
void |
setCampaignID(Long campaignID)
Sets the GetCharitiesRequestType.campaignID. |
void |
setCharityDomain(Integer charityDomain)
Sets the GetCharitiesRequestType.charityDomain. |
void |
setCharityID(String charityID)
Sets the GetCharitiesRequestType.charityID. |
void |
setCharityName(String charityName)
Sets the GetCharitiesRequestType.charityName. |
void |
setCharityRegion(Integer charityRegion)
Sets the GetCharitiesRequestType.charityRegion. |
void |
setFeatured(Boolean featured)
Sets the GetCharitiesRequestType.featured. |
void |
setIncludeDescription(Boolean includeDescription)
Sets the GetCharitiesRequestType.includeDescription. |
void |
setMatchType(StringMatchCodeType matchType)
Sets the GetCharitiesRequestType.matchType. |
void |
setOverrideRequest(GetCharitiesRequestType overrideRequest)
Sets the GetCharitiesRequestType.overrideRequest. |
void |
setQuery(String query)
Sets the GetCharitiesRequestType.query. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetCharitiesCall()
public GetCharitiesCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public void getCharities() throws ApiException, SdkException, Exception
ApiException
SdkException
Exception
public GetCharitiesRequestType getOverrideRequest()
public void setOverrideRequest(GetCharitiesRequestType overrideRequest)
overrideRequest
- GetCharitiesRequestTypepublic Long getCampaignID()
public void setCampaignID(Long campaignID)
campaignID
- Longpublic Integer getCharityDomain()
public void setCharityDomain(Integer charityDomain)
charityDomain
- Integerpublic String getCharityID()
public void setCharityID(String charityID)
charityID
- Stringpublic String getCharityName()
public void setCharityName(String charityName)
charityName
- Stringpublic Integer getCharityRegion()
public void setCharityRegion(Integer charityRegion)
charityRegion
- Integerpublic Boolean getFeatured()
public void setFeatured(Boolean featured)
featured
- Booleanpublic Boolean getIncludeDescription()
public void setIncludeDescription(Boolean includeDescription)
includeDescription
- Booleanpublic StringMatchCodeType getMatchType()
public void setMatchType(StringMatchCodeType matchType)
matchType
- StringMatchCodeTypepublic String getQuery()
public void setQuery(String query)
query
- Stringpublic CharityInfoType[] getReturnedCharities()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.