com.mozu.api.resources.content.PublishSetSummaryResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mozu-api-core Show documentation
Mozu Java is a SDK that enables you to create robust Java applications that integrate with the Mozu platform
There is a newer version: 2.6.1-RC1
/**
 *     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.content;

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 Content Publish Set resource to manage content publish sets and the pending content drafts.You can use content publish sets to group pending content changes together and publish them all at the same time.
 * 
 */
public class PublishSetSummaryResource {
	///
	/// 
	///
	private ApiContext _apiContext;


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

	
	/**
	 * 
	 * 

	 *	PublishSetSummary publishsetsummary = new PublishSetSummary();
	 *	PublishSetSummaryPagedCollection publishSetSummaryPagedCollection = publishsetsummary.getPublishSets();
	 * 

	 * @return com.mozu.api.contracts.content.PublishSetSummaryPagedCollection
	 * @see com.mozu.api.contracts.content.PublishSetSummaryPagedCollection
	 */
	public com.mozu.api.contracts.content.PublishSetSummaryPagedCollection getPublishSets() throws Exception
	{
		return getPublishSets( null,  null,  null);
	}

	/**
	 * 
	 * 

	 *	PublishSetSummary publishsetsummary = new PublishSetSummary();
	 *	PublishSetSummaryPagedCollection publishSetSummaryPagedCollection = publishsetsummary.getPublishSets( pageSize,  startIndex,  responseFields);
	 * 

	 * @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 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.content.PublishSetSummaryPagedCollection
	 * @see com.mozu.api.contracts.content.PublishSetSummaryPagedCollection
	 */
	public com.mozu.api.contracts.content.PublishSetSummaryPagedCollection getPublishSets(Integer pageSize, Integer startIndex, String responseFields) throws Exception
	{
		MozuClient client = com.mozu.api.clients.content.PublishSetSummaryClient.getPublishSetsClient( pageSize,  startIndex,  responseFields);
		client.setContext(_apiContext);
		client.executeRequest();
		return client.getResult();

	}

	/**
	 * 
	 * 

	 *	PublishSetSummary publishsetsummary = new PublishSetSummary();
	 *	DocumentDraftSummaryPagedCollection documentDraftSummaryPagedCollection = publishsetsummary.getPublishSetItems( code);
	 * 

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

	/**
	 * 
	 * 

	 *	PublishSetSummary publishsetsummary = new PublishSetSummary();
	 *	DocumentDraftSummaryPagedCollection documentDraftSummaryPagedCollection = publishsetsummary.getPublishSetItems( code,  pageSize,  startIndex,  sortBy,  filter,  responseFields);
	 * 

	 * @param code User-defined code that uniqely identifies the channel group.
	 * @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.content.DocumentDraftSummaryPagedCollection
	 * @see com.mozu.api.contracts.content.DocumentDraftSummaryPagedCollection
	 */
	public com.mozu.api.contracts.content.DocumentDraftSummaryPagedCollection getPublishSetItems(String code, Integer pageSize, Integer startIndex, String sortBy, String filter, String responseFields) throws Exception
	{
		MozuClient client = com.mozu.api.clients.content.PublishSetSummaryClient.getPublishSetItemsClient( code,  pageSize,  startIndex,  sortBy,  filter,  responseFields);
		client.setContext(_apiContext);
		client.executeRequest();
		return client.getResult();

	}

	/**
	 * 
	 * 

	 *	PublishSetSummary publishsetsummary = new PublishSetSummary();
	 *	object object = publishsetsummary.deletePublishSet( code);
	 * 

	 * @param code User-defined code that uniqely identifies the channel group.
	 * @return object
	 * @see object
	 */
	public Object deletePublishSet(String code) throws Exception
	{
		return deletePublishSet( code,  null,  null);
	}

	/**
	 * 
	 * 

	 *	PublishSetSummary publishsetsummary = new PublishSetSummary();
	 *	object object = publishsetsummary.deletePublishSet( code,  shouldDiscard,  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 shouldDiscard Specifies whether to discard the pending content changes assigned to the content publish set when the publish set is deleted.
	 * @return object
	 * @see object
	 */
	public Object deletePublishSet(String code, Boolean shouldDiscard, String responseFields) throws Exception
	{
		MozuClient