com.ebay.sdk.call.GetMemberMessagesCall Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore939 Show documentation
Show all versions of ebaysdkcore939 Show documentation
Repack of the eBay SDK version 939 for repository use
/*
Copyright (c) 2013 eBay, Inc.
This program is licensed under the terms of the eBay Common Development and
Distribution License (CDDL) Version 1.0 (the "License") and any subsequent version
thereof released by eBay. The then-current version of the License can be found
at http://www.opensource.org/licenses/cddl1.php and in the eBaySDKLicense file that
is under the eBay SDK ../docs directory.
*/
package com.ebay.sdk.call;
import java.lang.Boolean;
import java.lang.String;
import java.util.Calendar;
import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
* Wrapper class of the GetMemberMessages 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: ItemID - The ID of the item the message is about.
*
* For ASQ messages, either the ItemID, or a date range
* (specified with StartCreationTime and EndCreationTime),
* or both must be included. ItemID is otherwise ignored.
*
Input property: MailMessageType - The type of message. Note that GetMemberMessages does not return
* messages when this field is set to AskSellerQuestion.
*
Input property: MessageStatus - The status of the message.
*
Input property: DisplayToPublic - If included in the request and set to True, only public messages (viewable
* in the Item listing) are returned. If omitted or set to False in the
* request, all messages (that match other filters in the request) are returned
* in the response.
*
Input property: StartCreationTime - Used as beginning of date range filter. If specified,
* filters the returned messages to only those with a
* creation date greater than or equal to the specified
* date and time.
*
* For CEM messages, StartCreationTime and EndCreationTime
* must be provided.
*
* For ASQ messages, either the ItemID, or a date range
* (specified with StartCreationTime and EndCreationTime),
* or both must be included.
*
Input property: EndCreationTime - Used as end of date range filter. If specified, filters
* the returned messages to only those with a creation date
* less than or equal to the specified date and time.
*
* For CEM messages, StartCreationTime and EndCreationTime
* must be provided.
*
* For ASQ messages, either the ItemID, or a date range
* (specified with StartCreationTime and EndCreationTime),
* or both must be included.
*
Input property: Pagination - Standard pagination argument used to reduce response.
*
Input property: MemberMessageID - An ID that uniquely identifies the message for a given user to be retrieved.
* Used for the AskSellerQuestion notification only.
*
Input property: SenderID - An eBay ID that uniquely identifies a user. For
* GetMemberMessages, this is the sender of the message. If
* included in the request, returns only messages from the
* specified sender.
*
Output property: ReturnedMemberMessages - The returned member messages. Returned if messages that meet the request criteria exist.
* Note that GetMemberMessages does not return
* messages when, in the request, the MailMessageType is AskSellerQuestion.
*
Output property: PaginationResult - Shows the pagination of data returned by requests.
*
Output property: HasMoreItems - Specifies whether the response has more items.
*
* @author Ron Murphy
* @version 1.0
*/
public class GetMemberMessagesCall extends com.ebay.sdk.ApiCall
{
private String itemID = null;
private MessageTypeCodeType mailMessageType = null;
private MessageStatusTypeCodeType messageStatus = null;
private Boolean displayToPublic = null;
private Calendar startCreationTime = null;
private Calendar endCreationTime = null;
private PaginationType pagination = null;
private String memberMessageID = null;
private String senderID = null;
private MemberMessageExchangeType[] returnedMemberMessages=null;
private PaginationResultType paginationResult=null;
private Boolean hasMoreItems=null;
/**
* Constructor.
*/
public GetMemberMessagesCall() {
}
/**
* Constructor.
* @param apiContext The ApiContext object to be used to make the call.
*/
public GetMemberMessagesCall(ApiContext apiContext) {
super(apiContext);
}
/**
* Retrieves a list of the messages buyers have posted about your
* active item listings.
*
*
* @throws ApiException
* @throws SdkException
* @throws Exception
* @return The MemberMessageExchangeType[] object.
*/
public MemberMessageExchangeType[] getMemberMessages()
throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
{
GetMemberMessagesRequestType req;
req = new GetMemberMessagesRequestType();
if (this.itemID != null)
req.setItemID(this.itemID);
if (this.mailMessageType != null)
req.setMailMessageType(this.mailMessageType);
if (this.messageStatus != null)
req.setMessageStatus(this.messageStatus);
if (this.displayToPublic != null)
req.setDisplayToPublic(this.displayToPublic);
if (this.startCreationTime != null)
req.setStartCreationTime(this.startCreationTime);
if (this.endCreationTime != null)
req.setEndCreationTime(this.endCreationTime);
if (this.pagination != null)
req.setPagination(this.pagination);
if (this.memberMessageID != null)
req.setMemberMessageID(this.memberMessageID);
if (this.senderID != null)
req.setSenderID(this.senderID);
GetMemberMessagesResponseType resp = (GetMemberMessagesResponseType) execute(req);
this.returnedMemberMessages = (resp.getMemberMessage() == null? null: resp.getMemberMessage().getMemberMessageExchange());
this.paginationResult = resp.getPaginationResult();
this.hasMoreItems = resp.isHasMoreItems();
return this.getReturnedMemberMessages();
}
/**
* Gets the GetMemberMessagesRequestType.displayToPublic.
* @return Boolean
*/
public Boolean getDisplayToPublic()
{
return this.displayToPublic;
}
/**
* Sets the GetMemberMessagesRequestType.displayToPublic.
* @param displayToPublic Boolean
*/
public void setDisplayToPublic(Boolean displayToPublic)
{
this.displayToPublic = displayToPublic;
}
/**
* Gets the GetMemberMessagesRequestType.endCreationTime.
* @return Calendar
*/
public Calendar getEndCreationTime()
{
return this.endCreationTime;
}
/**
* Sets the GetMemberMessagesRequestType.endCreationTime.
* @param endCreationTime Calendar
*/
public void setEndCreationTime(Calendar endCreationTime)
{
this.endCreationTime = endCreationTime;
}
/**
* Gets the GetMemberMessagesRequestType.itemID.
* @return String
*/
public String getItemID()
{
return this.itemID;
}
/**
* Sets the GetMemberMessagesRequestType.itemID.
* @param itemID String
*/
public void setItemID(String itemID)
{
this.itemID = itemID;
}
/**
* Gets the GetMemberMessagesRequestType.mailMessageType.
* @return MessageTypeCodeType
*/
public MessageTypeCodeType getMailMessageType()
{
return this.mailMessageType;
}
/**
* Sets the GetMemberMessagesRequestType.mailMessageType.
* @param mailMessageType MessageTypeCodeType
*/
public void setMailMessageType(MessageTypeCodeType mailMessageType)
{
this.mailMessageType = mailMessageType;
}
/**
* Gets the GetMemberMessagesRequestType.memberMessageID.
* @return String
*/
public String getMemberMessageID()
{
return this.memberMessageID;
}
/**
* Sets the GetMemberMessagesRequestType.memberMessageID.
* @param memberMessageID String
*/
public void setMemberMessageID(String memberMessageID)
{
this.memberMessageID = memberMessageID;
}
/**
* Gets the GetMemberMessagesRequestType.messageStatus.
* @return MessageStatusTypeCodeType
*/
public MessageStatusTypeCodeType getMessageStatus()
{
return this.messageStatus;
}
/**
* Sets the GetMemberMessagesRequestType.messageStatus.
* @param messageStatus MessageStatusTypeCodeType
*/
public void setMessageStatus(MessageStatusTypeCodeType messageStatus)
{
this.messageStatus = messageStatus;
}
/**
* Gets the GetMemberMessagesRequestType.pagination.
* @return PaginationType
*/
public PaginationType getPagination()
{
return this.pagination;
}
/**
* Sets the GetMemberMessagesRequestType.pagination.
* @param pagination PaginationType
*/
public void setPagination(PaginationType pagination)
{
this.pagination = pagination;
}
/**
* Gets the GetMemberMessagesRequestType.senderID.
* @return String
*/
public String getSenderID()
{
return this.senderID;
}
/**
* Sets the GetMemberMessagesRequestType.senderID.
* @param senderID String
*/
public void setSenderID(String senderID)
{
this.senderID = senderID;
}
/**
* Gets the GetMemberMessagesRequestType.startCreationTime.
* @return Calendar
*/
public Calendar getStartCreationTime()
{
return this.startCreationTime;
}
/**
* Sets the GetMemberMessagesRequestType.startCreationTime.
* @param startCreationTime Calendar
*/
public void setStartCreationTime(Calendar startCreationTime)
{
this.startCreationTime = startCreationTime;
}
/**
* Valid after executing the API.
* Gets the returned GetMemberMessagesResponseType.hasMoreItems.
*
* @return Boolean
*/
public Boolean getHasMoreItems()
{
return this.hasMoreItems;
}
/**
* Valid after executing the API.
* Gets the returned GetMemberMessagesResponseType.paginationResult.
*
* @return PaginationResultType
*/
public PaginationResultType getPaginationResult()
{
return this.paginationResult;
}
/**
* Valid after executing the API.
* Gets the returned GetMemberMessagesResponseType.returnedMemberMessages.
*
* @return MemberMessageExchangeType[]
*/
public MemberMessageExchangeType[] getReturnedMemberMessages()
{
return this.returnedMemberMessages;
}
}