Changes since
the last release

com.ebay.soap.eBLBaseComponents
Class AbstractRequestType

java.lang.Object
  extended by com.ebay.soap.eBLBaseComponents.AbstractRequestType
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AddDisputeRequestType, AddDisputeResponseRequestType, AddFixedPriceItemRequestType, AddItemFromSellingManagerTemplateRequestType, AddItemRequestType, AddItemsRequestType, AddMemberMessageAAQToPartnerRequestType, AddMemberMessageRTQRequestType, AddMemberMessagesAAQToBidderRequestType, AddOrderRequestType, AddSecondChanceItemRequestType, AddSellingManagerInventoryFolderRequestType, AddSellingManagerProductRequestType, AddSellingManagerTemplateRequestType, AddToItemDescriptionRequestType, AddToWatchListRequestType, AddTransactionConfirmationItemRequestType, CompleteSaleRequestType, ConfirmIdentityRequestType, DeleteMyMessagesRequestType, DeleteSellingManagerInventoryFolderRequestType, DeleteSellingManagerItemAutomationRuleRequestType, DeleteSellingManagerProductRequestType, DeleteSellingManagerTemplateAutomationRuleRequestType, DeleteSellingManagerTemplateRequestType, DisableUnpaidItemAssistanceRequestType, EndFixedPriceItemRequestType, EndItemRequestType, EndItemsRequestType, ExtendSiteHostedPicturesRequestType, FetchTokenRequestType, GetAccountRequestType, GetAdFormatLeadsRequestType, GetAllBiddersRequestType, GetApiAccessRulesRequestType, GetAttributesCSRequestType, GetAttributesXSLRequestType, GetBestOffersRequestType, GetBidderListRequestType, GetCategoriesRequestType, GetCategory2CSRequestType, GetCategoryFeaturesRequestType, GetCategoryMappingsRequestType, GetCategorySpecificsRequestType, GetChallengeTokenRequestType, GetCharitiesRequestType, GetClientAlertsAuthTokenRequestType, GetContextualKeywordsRequestType, GetCrossPromotionsRequestType, GetDescriptionTemplatesRequestType, GetDisputeRequestType, GeteBayDetailsRequestType, GeteBayOfficialTimeRequestType, GetFeedbackRequestType, GetHighBiddersRequestType, GetItemRecommendationsRequestType, GetItemRequestType, GetItemsAwaitingFeedbackRequestType, GetItemShippingRequestType, GetItemTransactionsRequestType, GetMemberMessagesRequestType, GetMessagePreferencesRequestType, GetMyeBayBuyingRequestType, GetMyeBayRemindersRequestType, GetMyeBaySellingRequestType, GetMyMessagesRequestType, GetNotificationPreferencesRequestType, GetNotificationsUsageRequestType, GetOrdersRequestType, GetOrderTransactionsRequestType, GetPictureManagerDetailsRequestType, GetPictureManagerOptionsRequestType, GetProductFamilyMembersRequestType, GetProductFinderRequestType, GetProductFinderXSLRequestType, GetProductSearchPageRequestType, GetProductSearchResultsRequestType, GetProductSellingPagesRequestType, GetPromotionalSaleDetailsRequestType, GetPromotionRulesRequestType, GetSellerDashboardRequestType, GetSellerEventsRequestType, GetSellerListRequestType, GetSellerPaymentsRequestType, GetSellerTransactionsRequestType, GetSellingManagerAlertsRequestType, GetSellingManagerEmailLogRequestType, GetSellingManagerInventoryFolderRequestType, GetSellingManagerInventoryRequestType, GetSellingManagerItemAutomationRuleRequestType, GetSellingManagerSaleRecordRequestType, GetSellingManagerSoldListingsRequestType, GetSellingManagerTemplateAutomationRuleRequestType, GetSellingManagerTemplatesRequestType, GetSessionIDRequestType, GetShippingDiscountProfilesRequestType, GetStoreCategoryUpdateStatusRequestType, GetStoreCustomPageRequestType, GetStoreOptionsRequestType, GetStorePreferencesRequestType, GetStoreRequestType, GetSuggestedCategoriesRequestType, GetTaxTableRequestType, GetTokenStatusRequestType, GetUserContactDetailsRequestType, GetUserDisputesRequestType, GetUserPreferencesRequestType, GetUserRequestType, GetVeROReasonCodeDetailsRequestType, GetVeROReportStatusRequestType, GetWantItNowPostRequestType, GetWantItNowSearchResultsRequestType, IssueRefundRequestType, LeaveFeedbackRequestType, MoveSellingManagerInventoryFolderRequestType, PlaceOfferRequestType, RelistFixedPriceItemRequestType, RelistItemRequestType, RemoveFromWatchListRequestType, RespondToBestOfferRequestType, RespondToFeedbackRequestType, RespondToWantItNowPostRequestType, ReviseCheckoutStatusRequestType, ReviseFixedPriceItemRequestType, ReviseInventoryStatusRequestType, ReviseItemRequestType, ReviseMyMessagesFoldersRequestType, ReviseMyMessagesRequestType, ReviseSellingManagerInventoryFolderRequestType, ReviseSellingManagerProductRequestType, ReviseSellingManagerSaleRecordRequestType, ReviseSellingManagerTemplateRequestType, RevokeTokenRequestType, SaveItemToSellingManagerTemplateRequestType, SellerReverseDisputeRequestType, SendInvoiceRequestType, SetMessagePreferencesRequestType, SetNotificationPreferencesRequestType, SetPictureManagerDetailsRequestType, SetPromotionalSaleListingsRequestType, SetPromotionalSaleRequestType, SetSellingManagerFeedbackOptionsRequestType, SetSellingManagerItemAutomationRuleRequestType, SetSellingManagerTemplateAutomationRuleRequestType, SetShippingDiscountProfilesRequestType, SetStoreCategoriesRequestType, SetStoreCustomPageRequestType, SetStorePreferencesRequestType, SetStoreRequestType, SetTaxTableRequestType, SetUserNotesRequestType, SetUserPreferencesRequestType, UploadSiteHostedPicturesRequestType, ValidateChallengeInputRequestType, ValidateTestUserRegistrationRequestType, VerifyAddFixedPriceItemRequestType, VerifyAddItemRequestType, VerifyAddSecondChanceItemRequestType, VerifyRelistItemRequestType, 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

Java class for AbstractRequestType complex type.

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

 <complexType name="AbstractRequestType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="DetailLevel" type="{urn:ebay:apis:eBLBaseComponents}DetailLevelCodeType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="ErrorLanguage" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="MessageID" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Version" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="EndUserIP" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ErrorHandling" type="{urn:ebay:apis:eBLBaseComponents}ErrorHandlingCodeType" minOccurs="0"/>
         <element name="InvocationID" type="{urn:ebay:apis:eBLBaseComponents}UUIDType" minOccurs="0"/>
         <element name="OutputSelector" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="WarningLevel" type="{urn:ebay:apis:eBLBaseComponents}WarningLevelCodeType" minOccurs="0"/>
         <element name="BotBlock" type="{urn:ebay:apis:eBLBaseComponents}BotBlockRequestType" minOccurs="0"/>
         <any/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:
Serialized Form

Field Summary
protected  List<Object> any
           
protected  BotBlockRequestType botBlock
           
protected  List<DetailLevelCodeType> detailLevel
           
protected  String endUserIP
           
protected  ErrorHandlingCodeType errorHandling
           
protected  String errorLanguage
           
protected  String invocationID
           
protected  String messageID
           
protected  List<String> outputSelector
           
protected  String version
           
protected  WarningLevelCodeType warningLevel
           
 
Constructor Summary
AbstractRequestType()
           
 
Method Summary
protected  List<Object> _getAny()
           
protected  List<DetailLevelCodeType> _getDetailLevel()
           
protected  List<String> _getOutputSelector()
           
 Object[] getAny()
           
 Object getAny(int idx)
           
 int getAnyLength()
           
 BotBlockRequestType getBotBlock()
          Gets the value of the botBlock property.
 DetailLevelCodeType[] getDetailLevel()
           
 DetailLevelCodeType getDetailLevel(int idx)
           
 int getDetailLevelLength()
           
 String getEndUserIP()
          Gets the value of the endUserIP property.
 ErrorHandlingCodeType getErrorHandling()
          Gets the value of the errorHandling property.
 String getErrorLanguage()
          Gets the value of the errorLanguage property.
 String getInvocationID()
          Gets the value of the invocationID property.
 String getMessageID()
          Gets the value of the messageID property.
 String[] getOutputSelector()
           
 String getOutputSelector(int idx)
           
 int getOutputSelectorLength()
           
 String getVersion()
          Gets the value of the version property.
 WarningLevelCodeType getWarningLevel()
          Gets the value of the warningLevel property.
 Object setAny(int idx, Object value)
           
 void setAny(Object[] values)
           
 void setBotBlock(BotBlockRequestType value)
          Sets the value of the botBlock property.
 void setDetailLevel(DetailLevelCodeType[] values)
           
 DetailLevelCodeType setDetailLevel(int idx, DetailLevelCodeType value)
           
 void setEndUserIP(String value)
          Sets the value of the endUserIP property.
 void setErrorHandling(ErrorHandlingCodeType value)
          Sets the value of the errorHandling property.
 void setErrorLanguage(String value)
          Sets the value of the errorLanguage property.
 void setInvocationID(String value)
          Sets the value of the invocationID property.
 void setMessageID(String value)
          Sets the value of the messageID property.
 String setOutputSelector(int idx, String value)
           
 void setOutputSelector(String[] values)
           
 void setVersion(String value)
          Sets the value of the version property.
 void setWarningLevel(WarningLevelCodeType value)
          Sets the value of the warningLevel property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

detailLevel

protected List<DetailLevelCodeType> detailLevel

errorLanguage

protected String errorLanguage

messageID

protected String messageID

version

protected String version

endUserIP

protected String endUserIP

errorHandling

protected ErrorHandlingCodeType errorHandling

invocationID

protected String invocationID

outputSelector

protected List<String> outputSelector

warningLevel

protected WarningLevelCodeType warningLevel

botBlock

protected BotBlockRequestType botBlock

any

protected List<Object> any
Constructor Detail

AbstractRequestType

public AbstractRequestType()
Method Detail

getDetailLevel

public DetailLevelCodeType[] getDetailLevel()
Returns:
array of DetailLevelCodeType

getDetailLevel

public DetailLevelCodeType getDetailLevel(int idx)
Returns:
one of DetailLevelCodeType

getDetailLevelLength

public int getDetailLevelLength()

setDetailLevel

public void setDetailLevel(DetailLevelCodeType[] values)
Parameters:
values - allowed objects are DetailLevelCodeType

_getDetailLevel

protected List<DetailLevelCodeType> _getDetailLevel()

setDetailLevel

public DetailLevelCodeType setDetailLevel(int idx,
                                          DetailLevelCodeType value)
Parameters:
value - allowed object is DetailLevelCodeType

getErrorLanguage

public String getErrorLanguage()
Gets the value of the errorLanguage property.

Returns:
possible object is String

setErrorLanguage

public void setErrorLanguage(String value)
Sets the value of the errorLanguage property.

Parameters:
value - allowed object is String

getMessageID

public String getMessageID()
Gets the value of the messageID property.

Returns:
possible object is String

setMessageID

public void setMessageID(String value)
Sets the value of the messageID property.

Parameters:
value - allowed object is String

getVersion

public String getVersion()
Gets the value of the version property.

Returns:
possible object is String

setVersion

public void setVersion(String value)
Sets the value of the version property.

Parameters:
value - allowed object is String

getEndUserIP

public String getEndUserIP()
Gets the value of the endUserIP property.

Returns:
possible object is String

setEndUserIP

public void setEndUserIP(String value)
Sets the value of the endUserIP property.

Parameters:
value - allowed object is String

getErrorHandling

public ErrorHandlingCodeType getErrorHandling()
Gets the value of the errorHandling property.

Returns:
possible object is ErrorHandlingCodeType

setErrorHandling

public void setErrorHandling(ErrorHandlingCodeType value)
Sets the value of the errorHandling property.

Parameters:
value - allowed object is ErrorHandlingCodeType

getInvocationID

public String getInvocationID()
Gets the value of the invocationID property.

Returns:
possible object is String

setInvocationID

public void setInvocationID(String value)
Sets the value of the invocationID property.

Parameters:
value - allowed object is String

getOutputSelector

public String[] getOutputSelector()
Returns:
array of String

getOutputSelector

public String getOutputSelector(int idx)
Returns:
one of String

getOutputSelectorLength

public int getOutputSelectorLength()

setOutputSelector

public void setOutputSelector(String[] values)
Parameters:
values - allowed objects are String

_getOutputSelector

protected List<String> _getOutputSelector()

setOutputSelector

public String setOutputSelector(int idx,
                                String value)
Parameters:
value - allowed object is String

getWarningLevel

public WarningLevelCodeType getWarningLevel()
Gets the value of the warningLevel property.

Returns:
possible object is WarningLevelCodeType

setWarningLevel

public void setWarningLevel(WarningLevelCodeType value)
Sets the value of the warningLevel property.

Parameters:
value - allowed object is WarningLevelCodeType

getBotBlock

public BotBlockRequestType getBotBlock()
Gets the value of the botBlock property.

Returns:
possible object is BotBlockRequestType

setBotBlock

public void setBotBlock(BotBlockRequestType value)
Sets the value of the botBlock property.

Parameters:
value - allowed object is BotBlockRequestType

getAny

public Object[] getAny()
Returns:
array of Object Element

getAny

public Object getAny(int idx)
Returns:
one of Object Element

getAnyLength

public int getAnyLength()

setAny

public void setAny(Object[] values)
Parameters:
values - allowed objects are Object Element

_getAny

protected List<Object> _getAny()

setAny

public Object setAny(int idx,
                     Object value)
Parameters:
value - allowed object is Object Element

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.