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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ebaysdkcore939 Show documentation
Repack of the eBay SDK version 939 for repository use
There is a newer version: 939.0.0
/*
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.String;

import com.ebay.sdk.*;
import com.ebay.soap.eBLBaseComponents.*;
/**
 * Wrapper class of the GetNotificationPreferences 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: PreferenceLevel - Specifies the type of preferences to retrieve. For example, preferences can be associated with a user, with
 * an application, or with events.
 * 
 Output property: ReturnedApplicationDeliveryPreferences - Specifies application-based event preferences that have been enabled.
 * 
 Output property: ReturnedDeliveryURLName - Specifies application delivery URL Name associated with this user.
 * 
 Output property: ReturnedUserDeliveryPreferenceArray - Specifies user-based event preferences that have been enabled or disabled.
 * 
 Output property: UserData - Returns user data for notification settings, such as set mobile phone.
 * 
 Output property: EventProperty - Contains names and values assigned to a notification event.
 * Currently can only be set for wireless applications.
 * 
 * @author Ron Murphy
 * @version 1.0
 */

public class GetNotificationPreferencesCall extends com.ebay.sdk.ApiCall
{
  
  private NotificationRoleCodeType preferenceLevel = null;
  private ApplicationDeliveryPreferencesType returnedApplicationDeliveryPreferences=null;
  private String returnedDeliveryURLName=null;
  private NotificationEnableArrayType returnedUserDeliveryPreferenceArray=null;
  private NotificationUserDataType userData=null;
  private NotificationEventPropertyType[] eventProperty=null;


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

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

  }

  /**
   * Retrieves the requesting application's notification preferences. Details are only returned for events for which a
   * preference has been set. For example, if you enabled notification for the EndOfAuction event and later disabled it,
   * the GetNotificationPreferences response would cite the EndOfAuction event preference as Disabled. Otherwise, no
   * details would be returned regarding EndOfAuction.
   * 
   * 

   * @throws ApiException
   * @throws SdkException
   * @throws Exception
   * @return The GetNotificationPreferencesResponseType object.
   */
  public GetNotificationPreferencesResponseType getNotificationPreferences()
      throws com.ebay.sdk.ApiException, com.ebay.sdk.SdkException, java.lang.Exception
  {
    GetNotificationPreferencesRequestType req;
    req = new GetNotificationPreferencesRequestType();
    req.setDetailLevel(this.getDetailLevel());
    if (this.preferenceLevel != null)
      req.setPreferenceLevel(this.preferenceLevel);

    GetNotificationPreferencesResponseType resp = (GetNotificationPreferencesResponseType) execute(req);

    this.returnedApplicationDeliveryPreferences = resp.getApplicationDeliveryPreferences();
    this.returnedDeliveryURLName = resp.getDeliveryURLName();
    this.returnedUserDeliveryPreferenceArray = resp.getUserDeliveryPreferenceArray();
    this.userData = resp.getUserData();
    this.eventProperty = resp.getEventProperty();
    return resp;
  }

  /**
   * Gets the GetNotificationPreferencesRequestType.preferenceLevel.
   * @return NotificationRoleCodeType
   */
  public NotificationRoleCodeType getPreferenceLevel()
  {
    return this.preferenceLevel;
  }

  /**
   * Sets the GetNotificationPreferencesRequestType.preferenceLevel.
   * @param preferenceLevel NotificationRoleCodeType
   */
  public void setPreferenceLevel(NotificationRoleCodeType preferenceLevel)
  {
    this.preferenceLevel = preferenceLevel;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetNotificationPreferencesResponseType.eventProperty.
   * 
   * @return NotificationEventPropertyType[]
   */
  public NotificationEventPropertyType[] getEventProperty()
  {
    return this.eventProperty;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetNotificationPreferencesResponseType.returnedApplicationDeliveryPreferences.
   * 
   * @return ApplicationDeliveryPreferencesType
   */
  public ApplicationDeliveryPreferencesType getReturnedApplicationDeliveryPreferences()
  {
    return this.returnedApplicationDeliveryPreferences;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetNotificationPreferencesResponseType.returnedDeliveryURLName.
   * 
   * @return String
   */
  public String getReturnedDeliveryURLName()
  {
    return this.returnedDeliveryURLName;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetNotificationPreferencesResponseType.returnedUserDeliveryPreferenceArray.
   * 
   * @return NotificationEnableArrayType
   */
  public NotificationEnableArrayType getReturnedUserDeliveryPreferenceArray()
  {
    return this.returnedUserDeliveryPreferenceArray;
  }

  /**
   * Valid after executing the API.
   * Gets the returned GetNotificationPreferencesResponseType.userData.
   * 
   * @return NotificationUserDataType
   */
  public NotificationUserDataType getUserData()
  {
    return this.userData;
  }

}