com.ebay.sdk.call.ReviseMyMessagesCall Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore Show documentation
Repack of the eBay SDK version 939 for repository use
The newest version!
/*
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.Long;

import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
 * Wrapper class of the ReviseMyMessages 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: MessageIDs - Contains a list of up to 10 MessageID values.
 * 


 * MessageIDs must be included in
 * the request. Messages in the Sent box cannot be moved,
 * marked as Read, or Flagged.
 * 
 Input property: AlertIDs - This field will be deprecated in an upcoming release.
 * This field formerly contained a list of up to 10 AlertID values.
 * 


 * Alerts cannot be flagged. Alerts cannot be
 * moved into a new folder until they have been resolved.
 * 


 * Resolve alerts by marking Read (if no action is
 * required), or by using ActionURL (if action is
 * required).
 * 
 Input property: Read - Changes the read states of all
 * messages specified in a request.
 * At least one of the following
 * must be specified in the
 * request: Read, Flagged, or FolderID.
 * Messages in the Sent box cannot be moved,
 * marked as Read, or Flagged.
 * 


 * Note that messages retrieved
 * with the API are not automatically marked Read,
 * and must be marked Read with this call.
 * 
 Input property: Flagged - Changes the flagged states of all messages specified in
 * a request by their MessageID values. At least one of
 * Read, Flagged, or FolderID must be specified in the
 * request. Messages in the Sent box cannot be moved,
 * marked as Read, or Flagged.
 * 
 Input property: FolderID - An ID that uniquely identifies the My Messages folder to
 * move messages into. At least one of Read,
 * Flagged, or FolderID must be specified in the request.
 * 


 * Messages
 * in the Sent box cannot be moved, marked as Read, or
 * Flagged.
 * 
 * @author Ron Murphy
 * @version 1.0
 */

public class ReviseMyMessagesCall extends com.ebay.sdk.ApiCall
{
  
  private String[] messageIDs = null;
  private String[] alertIDs = null;
  private Boolean read = null;
  private Boolean flagged = null;
  private Long folderID = null;


  /**
   * Constructor.
   */
  public ReviseMyMessagesCall() {
  }

  /**
   * Constructor.
   * @param apiContext The ApiContext object to be used to make the call.
   */
  public ReviseMyMessagesCall(ApiContext apiContext) {
    super(apiContext);
    

  }

  /**
   * Sets the read state for messages, sets the flagged state of messages,
   * and moves messages into and out of folders.
   * 
   * 

   * @throws ApiException one or more errors reported by an API call.
   * @throws SdkException The super class of all SDK exception types.
   * @throws Exception
   * @return The void object.
   */
  public void reviseMyMessages()
      throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
  {
    ReviseMyMessagesRequestType req;
    req = new ReviseMyMessagesRequestType();
    if (this.messageIDs != null)
    {
      MyMessagesMessageIDArrayType ary = new MyMessagesMessageIDArrayType();
      ary.setMessageID(this.messageIDs);
      req.setMessageIDs(ary);
    }
    if (this.alertIDs != null)
    {
      MyMessagesAlertIDArrayType ary = new MyMessagesAlertIDArrayType();
      ary.setAlertID(this.alertIDs);
      req.setAlertIDs(ary);
    }
    if (this.read != null)
      req.setRead(this.read);
    if (this.flagged != null)
      req.setFlagged(this.flagged);
    if (this.folderID != null)
      req.setFolderID(this.folderID);

    ReviseMyMessagesResponseType resp = (ReviseMyMessagesResponseType) execute(req);


  }

  /**
   * Gets the ReviseMyMessagesRequestType.alertIDs.
   * @return String[]
   */
  public String[] getAlertIDs()
  {
    return this.alertIDs;
  }

  /**
   * Sets the ReviseMyMessagesRequestType.alertIDs.
   * @param alertIDs String[]
   */
  public void setAlertIDs(String[] alertIDs)
  {
    this.alertIDs = alertIDs;
  }

  /**
   * Gets the ReviseMyMessagesRequestType.flagged.
   * @return Boolean
   */
  public Boolean getFlagged()
  {
    return this.flagged;
  }

  /**
   * Sets the ReviseMyMessagesRequestType.flagged.
   * @param flagged Boolean
   */
  public void setFlagged(Boolean flagged)
  {
    this.flagged = flagged;
  }

  /**
   * Gets the ReviseMyMessagesRequestType.folderID.
   * @return Long
   */
  public Long getFolderID()
  {
    return this.folderID;
  }

  /**
   * Sets the ReviseMyMessagesRequestType.folderID.
   * @param folderID Long
   */
  public void setFolderID(Long folderID)
  {
    this.folderID = folderID;
  }

  /**
   * Gets the ReviseMyMessagesRequestType.messageIDs.
   * @return String[]
   */
  public String[] getMessageIDs()
  {
    return this.messageIDs;
  }

  /**
   * Sets the ReviseMyMessagesRequestType.messageIDs.
   * @param messageIDs String[]
   */
  public void setMessageIDs(String[] messageIDs)
  {
    this.messageIDs = messageIDs;
  }

  /**
   * Gets the ReviseMyMessagesRequestType.read.
   * @return Boolean
   */
  public Boolean getRead()
  {
    return this.read;
  }

  /**
   * Sets the ReviseMyMessagesRequestType.read.
   * @param read Boolean
   */
  public void setRead(Boolean read)
  {
    this.read = read;
  }

}