ChangeMessageResource.java

/**
 *     This code was auto-generated by a Codezu.     
 *
 *     Changes to this file may cause incorrect behavior and will be lost if
 *     the code is regenerated.
 */
package com.mozu.api.resources.commerce.carts;

import com.mozu.api.ApiContext;
import java.util.List;
import java.util.ArrayList;
import com.mozu.api.MozuClient;
import com.mozu.api.MozuClientFactory;
import com.mozu.api.MozuUrl;
import com.mozu.api.Headers;
import org.joda.time.DateTime;
import com.mozu.api.security.AuthTicket;
import org.apache.commons.lang.StringUtils;

/** <summary>
 * Use the Cart Messages resource to retrieve messages for live carts that the system logs when a product's price or inventory level changes.
 * </summary>
 */
public class ChangeMessageResource {
	///
	/// <see cref="Mozu.Api.ApiContext"/>
	///
	private ApiContext _apiContext;


	public ChangeMessageResource(ApiContext apiContext) 
	{
		_apiContext = apiContext;
	}

	
	/**
	 * Retrieves the messages associated with the current shopper's cart.
	 * <p><pre><code>
	 *	ChangeMessage changemessage = new ChangeMessage();
	 *	CartChangeMessageCollection cartChangeMessageCollection = changemessage.getMessages();
	 * </code></pre></p>
	 * @return com.mozu.api.contracts.commerceruntime.carts.CartChangeMessageCollection
	 * @see com.mozu.api.contracts.commerceruntime.carts.CartChangeMessageCollection
	 */
	public com.mozu.api.contracts.commerceruntime.carts.CartChangeMessageCollection getMessages() throws Exception
	{
		return getMessages( null);
	}

	/**
	 * Retrieves the messages associated with the current shopper's cart.
	 * <p><pre><code>
	 *	ChangeMessage changemessage = new ChangeMessage();
	 *	CartChangeMessageCollection cartChangeMessageCollection = changemessage.getMessages( responseFields);
	 * </code></pre></p>
	 * @param responseFields Use this field to include those fields which are not included by default.
	 * @return com.mozu.api.contracts.commerceruntime.carts.CartChangeMessageCollection
	 * @see com.mozu.api.contracts.commerceruntime.carts.CartChangeMessageCollection
	 */
	public com.mozu.api.contracts.commerceruntime.carts.CartChangeMessageCollection getMessages(String responseFields) throws Exception
	{
		MozuClient<com.mozu.api.contracts.commerceruntime.carts.CartChangeMessageCollection> client = com.mozu.api.clients.commerce.carts.ChangeMessageClient.getMessagesClient( responseFields);
		client.setContext(_apiContext);
		client.executeRequest();
		return client.getResult();

	}

	/**
	 * Deletes all messages associated with the cart of the current shopper.
	 * <p><pre><code>
	 *	ChangeMessage changemessage = new ChangeMessage();
	 *	changemessage.removeAllMessages();
	 * </code></pre></p>
	 * @return 
	 */
	public void removeAllMessages() throws Exception
	{
		MozuClient client = com.mozu.api.clients.commerce.carts.ChangeMessageClient.removeAllMessagesClient();
		client.setContext(_apiContext);
		client.executeRequest();
		client.cleanupHttpConnection();

	}

	/**
	 * Removes a single message associated with the cart of the current shopper.
	 * <p><pre><code>
	 *	ChangeMessage changemessage = new ChangeMessage();
	 *	changemessage.removeMessage( messageId);
	 * </code></pre></p>
	 * @param messageId Identifier of the message to remove from the cart.
	 * @return 
	 */
	public void removeMessage(String messageId) throws Exception
	{
		MozuClient client = com.mozu.api.clients.commerce.carts.ChangeMessageClient.removeMessageClient( messageId);
		client.setContext(_apiContext);
		client.executeRequest();
		client.cleanupHttpConnection();

	}

}