com.kaltura.client.services.SeriesRecordingService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of KalturaOttApiClient Show documentation
KalturaOttApiClient is a library of Java classes that can be used to interact with the Kaltura OTT REST API. More information about the REST API can be found at https://ott.developer.kaltura.com/ Many of the Java classes in this library are auto-generated from a schema that defines the objects that are used to interact with the API.
There is a newer version: 5.1.2.17630
Show newest version
// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;

import com.kaltura.client.types.SeriesRecording;
import com.kaltura.client.types.SeriesRecordingFilter;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;

/**
 * This class was generated using clients-generator\exec.php
 * against an XML schema provided by Kaltura.
 * 
 * MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
 */

public class SeriesRecordingService {
	
	public static class AddSeriesRecordingBuilder extends RequestBuilder {
		
		public AddSeriesRecordingBuilder(SeriesRecording recording) {
			super(SeriesRecording.class, "seriesrecording", "add");
			params.add("recording", recording);
		}
	}

	/**
	 * Issue a record request for a complete season or series
	 * 
	 * @param recording SeriesRecording Object
	 */
    public static AddSeriesRecordingBuilder add(SeriesRecording recording)  {
		return new AddSeriesRecordingBuilder(recording);
	}
	
	public static class CancelSeriesRecordingBuilder extends RequestBuilder {
		
		public CancelSeriesRecordingBuilder(long id) {
			super(SeriesRecording.class, "seriesrecording", "cancel");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Cancel a previously requested series recording. Cancel series recording can be
	  called for recording in status Scheduled or Recording Only
	 * 
	 * @param id Series Recording identifier
	 */
    public static CancelSeriesRecordingBuilder cancel(long id)  {
		return new CancelSeriesRecordingBuilder(id);
	}
	
	public static class CancelByEpgIdSeriesRecordingBuilder extends RequestBuilder {
		
		public CancelByEpgIdSeriesRecordingBuilder(long id, long epgId) {
			super(SeriesRecording.class, "seriesrecording", "cancelByEpgId");
			params.add("id", id);
			params.add("epgId", epgId);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
		
		public void epgId(String multirequestToken) {
			params.add("epgId", multirequestToken);
		}
	}

	/**
	 * Cancel EPG recording that was recorded as part of series
	 * 
	 * @param id Series Recording identifier
	 * @param epgId epg program identifier
	 */
    public static CancelByEpgIdSeriesRecordingBuilder cancelByEpgId(long id, long epgId)  {
		return new CancelByEpgIdSeriesRecordingBuilder(id, epgId);
	}
	
	public static class CancelBySeasonNumberSeriesRecordingBuilder extends RequestBuilder {
		
		public CancelBySeasonNumberSeriesRecordingBuilder(long id, long seasonNumber) {
			super(SeriesRecording.class, "seriesrecording", "cancelBySeasonNumber");
			params.add("id", id);
			params.add("seasonNumber", seasonNumber);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
		
		public void seasonNumber(String multirequestToken) {
			params.add("seasonNumber", multirequestToken);
		}
	}

	/**
	 * Cancel Season recording epgs that was recorded as part of series
	 * 
	 * @param id Series Recording identifier
	 * @param seasonNumber Season Number
	 */
    public static CancelBySeasonNumberSeriesRecordingBuilder cancelBySeasonNumber(long id, long seasonNumber)  {
		return new CancelBySeasonNumberSeriesRecordingBuilder(id, seasonNumber);
	}
	
	public static class DeleteSeriesRecordingBuilder extends RequestBuilder {
		
		public DeleteSeriesRecordingBuilder(long id) {
			super(SeriesRecording.class, "seriesrecording", "delete");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Delete series recording(s). Delete series recording can be called recordings in
	  any status
	 * 
	 * @param id Series Recording identifier
	 */
    public static DeleteSeriesRecordingBuilder delete(long id)  {
		return new DeleteSeriesRecordingBuilder(id);
	}
	
	public static class DeleteBySeasonNumberSeriesRecordingBuilder extends RequestBuilder {
		
		public DeleteBySeasonNumberSeriesRecordingBuilder(long id, int seasonNumber) {
			super(SeriesRecording.class, "seriesrecording", "deleteBySeasonNumber");
			params.add("id", id);
			params.add("seasonNumber", seasonNumber);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
		
		public void seasonNumber(String multirequestToken) {
			params.add("seasonNumber", multirequestToken);
		}
	}

	/**
	 * Delete Season recording epgs that was recorded as part of series
	 * 
	 * @param id Series Recording identifier
	 * @param seasonNumber Season Number
	 */
    public static DeleteBySeasonNumberSeriesRecordingBuilder deleteBySeasonNumber(long id, int seasonNumber)  {
		return new DeleteBySeasonNumberSeriesRecordingBuilder(id, seasonNumber);
	}
	
	public static class ListSeriesRecordingBuilder extends ListResponseRequestBuilder {
		
		public ListSeriesRecordingBuilder(SeriesRecordingFilter filter) {
			super(SeriesRecording.class, "seriesrecording", "list");
			params.add("filter", filter);
		}
	}

	public static ListSeriesRecordingBuilder list()  {
		return list(null);
	}

	/**
	 * Return a list of series recordings for the household with optional filter by
	  status and KSQL.
	 * 
	 * @param filter Filter parameters for filtering out the result - support order by only -
	 * START_DATE_ASC, START_DATE_DESC, ID_ASC,ID_DESC,SERIES_ID_ASC, SERIES_ID_DESC
	 */
    public static ListSeriesRecordingBuilder list(SeriesRecordingFilter filter)  {
		return new ListSeriesRecordingBuilder(filter);
	}
}