com.ebay.soap.eBLBaseComponents
Class AbstractRequestType

java.lang.Object
  com.ebay.soap.eBLBaseComponents.AbstractRequestType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AddDisputeRequestType, AddDisputeResponseRequestType, AddItemRequestType, AddLiveAuctionItemRequestType, AddMemberMessageAAQToPartnerRequestType, AddMemberMessageRTQRequestType, AddMemberMessagesAAQToBidderRequestType, AddOrderRequestType, AddSecondChanceItemRequestType, AddToItemDescriptionRequestType, AddToWatchListRequestType, AddTransactionConfirmationItemRequestType, ApproveLiveAuctionBiddersRequestType, CompleteSaleRequestType, DeleteMyMessagesRequestType, EndItemRequestType, FetchTokenRequestType, GetAccountRequestType, GetAdFormatLeadsRequestType, GetAllBiddersRequestType, GetApiAccessRulesRequestType, GetAttributesCSRequestType, GetAttributesXSLRequestType, GetBestOffersRequestType, GetBidderListRequestType, GetCartRequestType, GetCategoriesRequestType, GetCategory2CSRequestType, GetCategoryFeaturesRequestType, GetCategoryListingsRequestType, GetCategoryMappingsRequestType, GetCategorySpecificsRequestType, GetChallengeTokenRequestType, GetCharitiesRequestType, GetClientAlertsAuthTokenRequestType, GetContextualKeywordsRequestType, GetCrossPromotionsRequestType, GetDescriptionTemplatesRequestType, GetDisputeRequestType, GeteBayDetailsRequestType, GeteBayOfficialTimeRequestType, GetExpressWishListRequestType, GetFeedbackRequestType, GetHighBiddersRequestType, GetItemRecommendationsRequestType, GetItemRequestType, GetItemsAwaitingFeedbackRequestType, GetItemShippingRequestType, GetItemTransactionsRequestType, GetLiveAuctionBiddersRequestType, GetLiveAuctionCatalogDetailsRequestType, GetMemberMessagesRequestType, GetMessagePreferencesRequestType, GetMyeBayBuyingRequestType, GetMyeBayRemindersRequestType, GetMyeBaySellingRequestType, GetMyMessagesRequestType, GetNotificationPreferencesRequestType, GetNotificationsUsageRequestType, GetOrdersRequestType, GetOrderTransactionsRequestType, GetPictureManagerDetailsRequestType, GetPictureManagerOptionsRequestType, GetPopularKeywordsRequestType, GetProductFamilyMembersRequestType, GetProductFinderRequestType, GetProductFinderXSLRequestType, GetProductSearchPageRequestType, GetProductSearchResultsRequestType, GetProductSellingPagesRequestType, GetProductsRequestType, GetPromotionalSaleDetailsRequestType, GetPromotionRulesRequestType, GetReturnURLRequestType, GetRuNameRequestType, GetSearchResultsExpressRequestType, GetSearchResultsRequestType, GetSellerDashboardRequestType, GetSellerEventsRequestType, GetSellerListRequestType, GetSellerPaymentsRequestType, GetSellerTransactionsRequestType, GetSessionIDRequestType, GetShippingDiscountProfilesRequestType, GetStoreCategoryUpdateStatusRequestType, GetStoreCustomPageRequestType, GetStoreOptionsRequestType, GetStorePreferencesRequestType, GetStoreRequestType, GetSuggestedCategoriesRequestType, GetTaxTableRequestType, GetTokenStatusRequestType, GetUserContactDetailsRequestType, GetUserDisputesRequestType, GetUserPreferencesRequestType, GetUserRequestType, GetVeROReasonCodeDetailsRequestType, GetVeROReportStatusRequestType, GetWantItNowPostRequestType, GetWantItNowSearchResultsRequestType, IssueRefundRequestType, LeaveFeedbackRequestType, PlaceOfferRequestType, RelistItemRequestType, RemoveFromWatchListRequestType, RespondToBestOfferRequestType, RespondToFeedbackRequestType, RespondToWantItNowPostRequestType, ReviseCheckoutStatusRequestType, ReviseItemRequestType, ReviseLiveAuctionItemRequestType, ReviseMyMessagesFoldersRequestType, ReviseMyMessagesRequestType, RevokeTokenRequestType, SellerReverseDisputeRequestType, SendInvoiceRequestType, SetCartRequestType, SetMessagePreferencesRequestType, SetNotificationPreferencesRequestType, SetPictureManagerDetailsRequestType, SetPromotionalSaleListingsRequestType, SetPromotionalSaleRequestType, SetReturnURLRequestType, SetShippingDiscountProfilesRequestType, SetStoreCategoriesRequestType, SetStoreCustomPageRequestType, SetStorePreferencesRequestType, SetStoreRequestType, SetTaxTableRequestType, SetUserNotesRequestType, SetUserPreferencesRequestType, UploadSiteHostedPicturesRequestType, ValidateChallengeInputRequestType, ValidateTestUserRegistrationRequestType, VerifyAddItemRequestType, VerifyAddSecondChanceItemRequestType, VeROReportItemsRequestType

public abstract class AbstractRequestType
extends Object
implements Serializable

Base type definition of the request payload, which can carry any type of payload content plus optional versioning information and detail level requirements. All concrete request types (e.g., AddItemRequestType) are derived from the abstract request type. The naming convention we use for the concrete type names is the name of the service (the verb or call name) followed by "RequestType": VerbNameRequestType

See Also:

Serialized Form

Constructor Summary

AbstractRequestType()

Method Summary

boolean	equals(Object obj)
MessageElement[]	get_any() Gets the _any value for this AbstractRequestType.
BotBlockRequestType	getBotBlock() Gets the botBlock value for this AbstractRequestType.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
DetailLevelCodeType[]	getDetailLevel() Gets the detailLevel value for this AbstractRequestType.
DetailLevelCodeType	getDetailLevel(int i)
String	getEndUserIP() Gets the endUserIP value for this AbstractRequestType.
ErrorHandlingCodeType	getErrorHandling() Gets the errorHandling value for this AbstractRequestType.
String	getErrorLanguage() Gets the errorLanguage value for this AbstractRequestType.
UUIDType	getInvocationID() Gets the invocationID value for this AbstractRequestType.
String	getMessageID() Gets the messageID value for this AbstractRequestType.
String[]	getOutputSelector() Gets the outputSelector value for this AbstractRequestType.
String	getOutputSelector(int i)
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	getVersion() Gets the version value for this AbstractRequestType.
WarningLevelCodeType	getWarningLevel() Gets the warningLevel value for this AbstractRequestType.
int	hashCode()
void	set_any(MessageElement[] _any) Sets the _any value for this AbstractRequestType.
void	setBotBlock(BotBlockRequestType botBlock) Sets the botBlock value for this AbstractRequestType.
void	setDetailLevel(DetailLevelCodeType[] detailLevel) Sets the detailLevel value for this AbstractRequestType.
void	setDetailLevel(int i, DetailLevelCodeType value)
void	setEndUserIP(String endUserIP) Sets the endUserIP value for this AbstractRequestType.
void	setErrorHandling(ErrorHandlingCodeType errorHandling) Sets the errorHandling value for this AbstractRequestType.
void	setErrorLanguage(String errorLanguage) Sets the errorLanguage value for this AbstractRequestType.
void	setInvocationID(UUIDType invocationID) Sets the invocationID value for this AbstractRequestType.
void	setMessageID(String messageID) Sets the messageID value for this AbstractRequestType.
void	setOutputSelector(int i, String value)
void	setOutputSelector(String[] outputSelector) Sets the outputSelector value for this AbstractRequestType.
void	setVersion(String version) Sets the version value for this AbstractRequestType.
void	setWarningLevel(WarningLevelCodeType warningLevel) Sets the warningLevel value for this AbstractRequestType.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRequestType

public AbstractRequestType()

Method Detail

getDetailLevel

public DetailLevelCodeType[] getDetailLevel()

Gets the detailLevel value for this AbstractRequestType.

Returns:

detailLevel Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request.

The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.)

Note that DetailLevel is required input for GetMyMessages.

With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance.

setDetailLevel

public void setDetailLevel(DetailLevelCodeType[] detailLevel)

Sets the detailLevel value for this AbstractRequestType.

Parameters:

detailLevel - Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request.

The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.)

Note that DetailLevel is required input for GetMyMessages.

With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance.

getDetailLevel

public DetailLevelCodeType getDetailLevel(int i)

setDetailLevel

public void setDetailLevel(int i,
                           DetailLevelCodeType value)

getErrorLanguage

public String getErrorLanguage()

Gets the errorLanguage value for this AbstractRequestType.

Returns:

errorLanguage

setErrorLanguage

public void setErrorLanguage(String errorLanguage)

Sets the errorLanguage value for this AbstractRequestType.

Parameters:

errorLanguage -

getMessageID

public String getMessageID()

Gets the messageID value for this AbstractRequestType.

Returns:

messageID

setMessageID

public void setMessageID(String messageID)

Sets the messageID value for this AbstractRequestType.

Parameters:

messageID -

getVersion

public String getVersion()

Gets the version value for this AbstractRequestType.

Returns:

version

setVersion

public void setVersion(String version)

Sets the version value for this AbstractRequestType.

Parameters:

version -

getEndUserIP

public String getEndUserIP()

Gets the endUserIP value for this AbstractRequestType.

Returns:

endUserIP

setEndUserIP

public void setEndUserIP(String endUserIP)

Sets the endUserIP value for this AbstractRequestType.

Parameters:

endUserIP -

getErrorHandling

public ErrorHandlingCodeType getErrorHandling()

Gets the errorHandling value for this AbstractRequestType.

Returns:

errorHandling Preferences that specify how eBay should handle certain requests that contain invalid data or that could partially fail. These preferences give you some control over whether eBay returns warnings or errors in response to invalid data and how eBay handles listing requests when such data is passed in. For example, these preferences are applicable to AddItem and related calls when Item Specifics are specified, and to CompleteSale. See the eBay Web Services Guide for details about these preferences and their effects.

setErrorHandling

public void setErrorHandling(ErrorHandlingCodeType errorHandling)

Sets the errorHandling value for this AbstractRequestType.

Parameters:

errorHandling - Preferences that specify how eBay should handle certain requests that contain invalid data or that could partially fail. These preferences give you some control over whether eBay returns warnings or errors in response to invalid data and how eBay handles listing requests when such data is passed in. For example, these preferences are applicable to AddItem and related calls when Item Specifics are specified, and to CompleteSale. See the eBay Web Services Guide for details about these preferences and their effects.

getInvocationID

public UUIDType getInvocationID()

Gets the invocationID value for this AbstractRequestType.

Returns:

invocationID Specifies a universally unique identifier. The identifier can only contain digits from 0-9 and letters from A-F. The identifier must be 32 characters long. For example, 9CEBD9A6825644EC8D06C436D6CF494B.

setInvocationID

public void setInvocationID(UUIDType invocationID)

Sets the invocationID value for this AbstractRequestType.

Parameters:

invocationID - Specifies a universally unique identifier. The identifier can only contain digits from 0-9 and letters from A-F. The identifier must be 32 characters long. For example, 9CEBD9A6825644EC8D06C436D6CF494B.

getOutputSelector

public String[] getOutputSelector()

Gets the outputSelector value for this AbstractRequestType.

Returns:

outputSelector Specifies the ID of the highest-level category to return, along with its subcategories. If no parent category is specified, all categories are returned for the specified site. (Please do not pass a value of 0; zero (0) is an invalid value for CategoryParent.) To determine available category IDs, call GetCategories with no filters and use a DetailLevel value of ReturnAll. If you specify multiple parent categories, the hierarchy for each one is returned.

setOutputSelector

public void setOutputSelector(String[] outputSelector)

Sets the outputSelector value for this AbstractRequestType.

Parameters:

outputSelector - Specifies the ID of the highest-level category to return, along with its subcategories. If no parent category is specified, all categories are returned for the specified site. (Please do not pass a value of 0; zero (0) is an invalid value for CategoryParent.) To determine available category IDs, call GetCategories with no filters and use a DetailLevel value of ReturnAll. If you specify multiple parent categories, the hierarchy for each one is returned.

getOutputSelector

public String getOutputSelector(int i)

setOutputSelector

public void setOutputSelector(int i,
                              String value)

getWarningLevel

public WarningLevelCodeType getWarningLevel()

Gets the warningLevel value for this AbstractRequestType.

Returns:

warningLevel

setWarningLevel

public void setWarningLevel(WarningLevelCodeType warningLevel)

Sets the warningLevel value for this AbstractRequestType.

Parameters:

warningLevel -

getBotBlock

public BotBlockRequestType getBotBlock()

Gets the botBlock value for this AbstractRequestType.

Returns:

botBlock Container of token and user reply.

setBotBlock

public void setBotBlock(BotBlockRequestType botBlock)

Sets the botBlock value for this AbstractRequestType.

Parameters:

botBlock - Container of token and user reply.

get_any

public MessageElement[] get_any()

Gets the _any value for this AbstractRequestType.

Returns:

_any

set_any

public void set_any(MessageElement[] _any)

Sets the _any value for this AbstractRequestType.

Parameters:

_any -

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