• Home
• com.mozu
• mozu-api-core
• 2.5.0-RC7
• source code
• ChannelGroupResource.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.mozu.api.resources.commerce.ChannelGroupResource Maven / Gradle / Ivy

/**
 *     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;

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;

/** 

 * Use the Channel Groups resource to manage groups of channels with common information.
 * 
 */
public class ChannelGroupResource {
	///
	/// 
	///
	private ApiContext _apiContext;


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

	
	/**
	 * 
	 * 

	 *	ChannelGroup channelgroup = new ChannelGroup();
	 *	ChannelGroupCollection channelGroupCollection = channelgroup.getChannelGroups();
	 * 

	 * @return com.mozu.api.contracts.commerceruntime.channels.ChannelGroupCollection
	 * @see com.mozu.api.contracts.commerceruntime.channels.ChannelGroupCollection
	 */
	public com.mozu.api.contracts.commerceruntime.channels.ChannelGroupCollection getChannelGroups() throws Exception
	{
		return getChannelGroups( null,  null,  null,  null,  null);
	}

	/**
	 * 
	 * 

	 *	ChannelGroup channelgroup = new ChannelGroup();
	 *	ChannelGroupCollection channelGroupCollection = channelgroup.getChannelGroups( startIndex,  pageSize,  sortBy,  filter,  responseFields);
	 * 

	 * @param filter A set of filter expressions representing the search parameters for a query. This parameter is optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for a list of supported filters.
	 * @param pageSize When creating paged results from a query, this value indicates the zero-based offset in the complete result set where the returned entities begin. For example, with this parameter set to 25, to get the 51st through the 75th items, set startIndex to 50.
	 * @param responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
	 * @param sortBy The element to sort the results by and the channel in which the results appear. Either ascending (a-z) or descending (z-a) channel. Optional. Refer to [Sorting and Filtering](../../../../Developer/api-guides/sorting-filtering.htm) for more information.
	 * @param startIndex When creating paged results from a query, this value indicates the zero-based offset in the complete result set where the returned entities begin. For example, with pageSize set to 25, to get the 51st through the 75th items, set this parameter to 50.
	 * @return com.mozu.api.contracts.commerceruntime.channels.ChannelGroupCollection
	 * @see com.mozu.api.contracts.commerceruntime.channels.ChannelGroupCollection
	 */
	public com.mozu.api.contracts.commerceruntime.channels.ChannelGroupCollection getChannelGroups(Integer startIndex, Integer pageSize, String sortBy, String filter, String responseFields) throws Exception
	{
		MozuClient client = com.mozu.api.clients.commerce.ChannelGroupClient.getChannelGroupsClient( startIndex,  pageSize,  sortBy,  filter,  responseFields);
		client.setContext(_apiContext);
		client.executeRequest();
		return client.getResult();

	}

	/**
	 * 
	 * 

	 *	ChannelGroup channelgroup = new ChannelGroup();
	 *	ChannelGroup channelGroup = channelgroup.getChannelGroup( code);
	 * 

	 * @param code User-defined code that uniqely identifies the channel group.
	 * @return com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 * @see com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 */
	public com.mozu.api.contracts.commerceruntime.channels.ChannelGroup getChannelGroup(String code) throws Exception
	{
		return getChannelGroup( code,  null);
	}

	/**
	 * 
	 * 

	 *	ChannelGroup channelgroup = new ChannelGroup();
	 *	ChannelGroup channelGroup = channelgroup.getChannelGroup( code,  responseFields);
	 * 

	 * @param code User-defined code that uniqely identifies the channel group.
	 * @param responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
	 * @return com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 * @see com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 */
	public com.mozu.api.contracts.commerceruntime.channels.ChannelGroup getChannelGroup(String code, String responseFields) throws Exception
	{
		MozuClient client = com.mozu.api.clients.commerce.ChannelGroupClient.getChannelGroupClient( code,  responseFields);
		client.setContext(_apiContext);
		client.executeRequest();
		return client.getResult();

	}

	/**
	 * 
	 * 

	 *	ChannelGroup channelgroup = new ChannelGroup();
	 *	ChannelGroup channelGroup = channelgroup.createChannelGroup( channelGroup);
	 * 

	 * @param channelGroup Properties of a group of channels that share common information.
	 * @return com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 * @see com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 * @see com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 */
	public com.mozu.api.contracts.commerceruntime.channels.ChannelGroup createChannelGroup(com.mozu.api.contracts.commerceruntime.channels.ChannelGroup channelGroup) throws Exception
	{
		return createChannelGroup( channelGroup,  null);
	}

	/**
	 * 
	 * 

	 *	ChannelGroup channelgroup = new ChannelGroup();
	 *	ChannelGroup channelGroup = channelgroup.createChannelGroup( channelGroup,  responseFields);
	 * 

	 * @param responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
	 * @param channelGroup Properties of a group of channels that share common information.
	 * @return com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 * @see com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 * @see com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 */
	public com.mozu.api.contracts.commerceruntime.channels.ChannelGroup createChannelGroup(com.mozu.api.contracts.commerceruntime.channels.ChannelGroup channelGroup, String responseFields) throws Exception
	{
		MozuClient client = com.mozu.api.clients.commerce.ChannelGroupClient.createChannelGroupClient( channelGroup,  responseFields);
		client.setContext(_apiContext);
		client.executeRequest();
		return client.getResult();

	}

	/**
	 * 
	 * 

	 *	ChannelGroup channelgroup = new ChannelGroup();
	 *	ChannelGroup channelGroup = channelgroup.updateChannelGroup( channelGroup,  code);
	 * 

	 * @param code User-defined code that uniqely identifies the channel group.
	 * @param channelGroup Properties of a group of channels that share common information.
	 * @return com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 * @see com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 * @see com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 */
	public com.mozu.api.contracts.commerceruntime.channels.ChannelGroup updateChannelGroup(com.mozu.api.contracts.commerceruntime.channels.ChannelGroup channelGroup, String code) throws Exception
	{
		return updateChannelGroup( channelGroup,  code,  null);
	}

	/**
	 * 
	 * 

	 *	ChannelGroup channelgroup = new ChannelGroup();
	 *	ChannelGroup channelGroup = channelgroup.updateChannelGroup( channelGroup,  code,  responseFields);
	 * 

	 * @param code User-defined code that uniqely identifies the channel group.
	 * @param responseFields Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.
	 * @param channelGroup Properties of a group of channels that share common information.
	 * @return com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 * @see com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 * @see com.mozu.api.contracts.commerceruntime.channels.ChannelGroup
	 */
	public com.mozu.api.contracts.commerceruntime.channels.ChannelGroup updateChannelGroup(com.mozu.api.contracts.commerceruntime.channels.ChannelGroup channelGroup, String code, String responseFields) throws Exception
	{
		MozuClient client = com.mozu.api.clients.commerce.ChannelGroupClient.updateChannelGroupClient( channelGroup,  code,  responseFields);
		client.setContext(_apiContext);
		client.executeRequest();
		return client.getResult();

	}

	/**
	 * 
	 * 

	 *	ChannelGroup channelgroup = new ChannelGroup();
	 *	Stream stream = channelgroup.deleteChannelGroup( code);
	 * 

	 * @param code User-defined code that uniqely identifies the channel group.
	 * @return Stream
	 * @see Stream
	 */
	public java.io.InputStream deleteChannelGroup(String code) throws Exception
	{
		MozuClient client = com.mozu.api.clients.commerce.ChannelGroupClient.deleteChannelGroupClient( code);
		client.setContext(_apiContext);
		client.executeRequest();
		return client.getResult();

	}

}