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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kalturaApiClient Show documentation
KalturaClient is a library of Java classes that can be used to interact with the Kaltura REST API. More information about the REST API can be found at http://corp.kaltura.com/Products/Kaltura-API Many of the Java classes in this library are auto-generated from a schema that defines the objects that are used to interect with the API. The current schema can be found at http://www.kaltura.com/api_v3/api_schema.php
There is a newer version: 19.3.0
Show newest version
// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;

import com.kaltura.client.types.EntryVendorTask;
import com.kaltura.client.types.EntryVendorTaskFilter;
import com.kaltura.client.types.FilterPager;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;
import com.kaltura.client.utils.request.ServeRequestBuilder;

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

/**
 * Entry Vendor Task Service
 * 
 * @param id vendor task id
 * @param abortReason 
 * @param entryVendorTask 
 * @param id vendor task id to approve
 * @param filter A filter used to exclude specific tasks
 * @param id vendor task id
 * @param id 
 * @param filter 
 * @param pager 
 * @param filterType 
 * @param filterInput 
 * @param status 
 * @param dueDate 
 * @param filter 
 * @param pager 
 * @param id vendor task id to reject
 * @param rejectReason 
 * @param vendorPartnerId 
 * @param partnerId 
 * @param status 
 * @param dueDate 
 * @param id - the requested file id
 * @param id vendor task id to update
 * @param entryVendorTask evntry vendor task to update
 * @param id vendor task id to update
 * @param entryVendorTask evntry vendor task to update
 */
public class EntryVendorTaskService {
	
	public static class AbortEntryVendorTaskBuilder extends RequestBuilder {
		
		public AbortEntryVendorTaskBuilder(int id, String abortReason) {
			super(EntryVendorTask.class, "reach_entryvendortask", "abort");
			params.add("id", id);
			params.add("abortReason", abortReason);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
		
		public void abortReason(String multirequestToken) {
			params.add("abortReason", multirequestToken);
		}
	}

	public static AbortEntryVendorTaskBuilder abort(int id)  {
		return abort(id, null);
	}

	/**
	 * Cancel entry task. will only occur for task in PENDING or PENDING_MODERATION
	  status
	 * 
	 * @param id vendor task id
	 * @param abortReason 
	 */
    public static AbortEntryVendorTaskBuilder abort(int id, String abortReason)  {
		return new AbortEntryVendorTaskBuilder(id, abortReason);
	}
	
	public static class AddEntryVendorTaskBuilder extends RequestBuilder {
		
		public AddEntryVendorTaskBuilder(EntryVendorTask entryVendorTask) {
			super(EntryVendorTask.class, "reach_entryvendortask", "add");
			params.add("entryVendorTask", entryVendorTask);
		}
	}

	/**
	 * Allows you to add a entry vendor task
	 * 
	 * @param entryVendorTask 
	 */
    public static AddEntryVendorTaskBuilder add(EntryVendorTask entryVendorTask)  {
		return new AddEntryVendorTaskBuilder(entryVendorTask);
	}
	
	public static class ApproveEntryVendorTaskBuilder extends RequestBuilder {
		
		public ApproveEntryVendorTaskBuilder(int id) {
			super(EntryVendorTask.class, "reach_entryvendortask", "approve");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Approve entry vendor task for execution.
	 * 
	 * @param id vendor task id to approve
	 */
    public static ApproveEntryVendorTaskBuilder approve(int id)  {
		return new ApproveEntryVendorTaskBuilder(id);
	}
	
	public static class ExportToCsvEntryVendorTaskBuilder extends RequestBuilder {
		
		public ExportToCsvEntryVendorTaskBuilder(EntryVendorTaskFilter filter) {
			super(String.class, "reach_entryvendortask", "exportToCsv");
			params.add("filter", filter);
		}
	}

	/**
	 * add batch job that sends an email with a link to download an updated CSV that
	  contains list of users
	 * 
	 * @param filter A filter used to exclude specific tasks
	 */
    public static ExportToCsvEntryVendorTaskBuilder exportToCsv(EntryVendorTaskFilter filter)  {
		return new ExportToCsvEntryVendorTaskBuilder(filter);
	}
	
	public static class ExtendAccessKeyEntryVendorTaskBuilder extends RequestBuilder {
		
		public ExtendAccessKeyEntryVendorTaskBuilder(int id) {
			super(EntryVendorTask.class, "reach_entryvendortask", "extendAccessKey");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Extend access key in case the existing one has expired.
	 * 
	 * @param id vendor task id
	 */
    public static ExtendAccessKeyEntryVendorTaskBuilder extendAccessKey(int id)  {
		return new ExtendAccessKeyEntryVendorTaskBuilder(id);
	}
	
	public static class GetEntryVendorTaskBuilder extends RequestBuilder {
		
		public GetEntryVendorTaskBuilder(int id) {
			super(EntryVendorTask.class, "reach_entryvendortask", "get");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Retrieve specific entry vendor task by id
	 * 
	 * @param id 
	 */
    public static GetEntryVendorTaskBuilder get(int id)  {
		return new GetEntryVendorTaskBuilder(id);
	}
	
	public static class GetJobsEntryVendorTaskBuilder extends ListResponseRequestBuilder {
		
		public GetJobsEntryVendorTaskBuilder(EntryVendorTaskFilter filter, FilterPager pager) {
			super(EntryVendorTask.class, "reach_entryvendortask", "getJobs");
			params.add("filter", filter);
			params.add("pager", pager);
		}
	}

	public static GetJobsEntryVendorTaskBuilder getJobs()  {
		return getJobs(null);
	}

	public static GetJobsEntryVendorTaskBuilder getJobs(EntryVendorTaskFilter filter)  {
		return getJobs(filter, null);
	}

	/**
	 * get KalturaEntryVendorTask objects for specific vendor partner
	 * 
	 * @param filter 
	 * @param pager 
	 */
    public static GetJobsEntryVendorTaskBuilder getJobs(EntryVendorTaskFilter filter, FilterPager pager)  {
		return new GetJobsEntryVendorTaskBuilder(filter, pager);
	}
	
	public static class GetServeUrlEntryVendorTaskBuilder extends RequestBuilder {
		
		public GetServeUrlEntryVendorTaskBuilder(String filterType, int filterInput, int status, String dueDate) {
			super(String.class, "reach_entryvendortask", "getServeUrl");
			params.add("filterType", filterType);
			params.add("filterInput", filterInput);
			params.add("status", status);
			params.add("dueDate", dueDate);
		}
		
		public void filterType(String multirequestToken) {
			params.add("filterType", multirequestToken);
		}
		
		public void filterInput(String multirequestToken) {
			params.add("filterInput", multirequestToken);
		}
		
		public void status(String multirequestToken) {
			params.add("status", multirequestToken);
		}
		
		public void dueDate(String multirequestToken) {
			params.add("dueDate", multirequestToken);
		}
	}

	public static GetServeUrlEntryVendorTaskBuilder getServeUrl()  {
		return getServeUrl(null);
	}

	public static GetServeUrlEntryVendorTaskBuilder getServeUrl(String filterType)  {
		return getServeUrl(filterType, Integer.MIN_VALUE);
	}

	public static GetServeUrlEntryVendorTaskBuilder getServeUrl(String filterType, int filterInput)  {
		return getServeUrl(filterType, filterInput, Integer.MIN_VALUE);
	}

	public static GetServeUrlEntryVendorTaskBuilder getServeUrl(String filterType, int filterInput, int status)  {
		return getServeUrl(filterType, filterInput, status, null);
	}

    public static GetServeUrlEntryVendorTaskBuilder getServeUrl(String filterType, int filterInput, int status, String dueDate)  {
		return new GetServeUrlEntryVendorTaskBuilder(filterType, filterInput, status, dueDate);
	}
	
	public static class ListEntryVendorTaskBuilder extends ListResponseRequestBuilder {
		
		public ListEntryVendorTaskBuilder(EntryVendorTaskFilter filter, FilterPager pager) {
			super(EntryVendorTask.class, "reach_entryvendortask", "list");
			params.add("filter", filter);
			params.add("pager", pager);
		}
	}

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

	public static ListEntryVendorTaskBuilder list(EntryVendorTaskFilter filter)  {
		return list(filter, null);
	}

	/**
	 * List KalturaEntryVendorTask objects
	 * 
	 * @param filter 
	 * @param pager 
	 */
    public static ListEntryVendorTaskBuilder list(EntryVendorTaskFilter filter, FilterPager pager)  {
		return new ListEntryVendorTaskBuilder(filter, pager);
	}
	
	public static class RejectEntryVendorTaskBuilder extends RequestBuilder {
		
		public RejectEntryVendorTaskBuilder(int id, String rejectReason) {
			super(EntryVendorTask.class, "reach_entryvendortask", "reject");
			params.add("id", id);
			params.add("rejectReason", rejectReason);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
		
		public void rejectReason(String multirequestToken) {
			params.add("rejectReason", multirequestToken);
		}
	}

	public static RejectEntryVendorTaskBuilder reject(int id)  {
		return reject(id, null);
	}

	/**
	 * Reject entry vendor task for execution.
	 * 
	 * @param id vendor task id to reject
	 * @param rejectReason 
	 */
    public static RejectEntryVendorTaskBuilder reject(int id, String rejectReason)  {
		return new RejectEntryVendorTaskBuilder(id, rejectReason);
	}
	
	public static class ServeEntryVendorTaskBuilder extends ServeRequestBuilder {
		
		public ServeEntryVendorTaskBuilder(int vendorPartnerId, int partnerId, int status, String dueDate) {
			super("reach_entryvendortask", "serve");
			params.add("vendorPartnerId", vendorPartnerId);
			params.add("partnerId", partnerId);
			params.add("status", status);
			params.add("dueDate", dueDate);
		}
		
		public void vendorPartnerId(String multirequestToken) {
			params.add("vendorPartnerId", multirequestToken);
		}
		
		public void partnerId(String multirequestToken) {
			params.add("partnerId", multirequestToken);
		}
		
		public void status(String multirequestToken) {
			params.add("status", multirequestToken);
		}
		
		public void dueDate(String multirequestToken) {
			params.add("dueDate", multirequestToken);
		}
	}

	public static ServeEntryVendorTaskBuilder serve()  {
		return serve(Integer.MIN_VALUE);
	}

	public static ServeEntryVendorTaskBuilder serve(int vendorPartnerId)  {
		return serve(vendorPartnerId, Integer.MIN_VALUE);
	}

	public static ServeEntryVendorTaskBuilder serve(int vendorPartnerId, int partnerId)  {
		return serve(vendorPartnerId, partnerId, Integer.MIN_VALUE);
	}

	public static ServeEntryVendorTaskBuilder serve(int vendorPartnerId, int partnerId, int status)  {
		return serve(vendorPartnerId, partnerId, status, null);
	}

    public static ServeEntryVendorTaskBuilder serve(int vendorPartnerId, int partnerId, int status, String dueDate)  {
		return new ServeEntryVendorTaskBuilder(vendorPartnerId, partnerId, status, dueDate);
	}
	
	public static class ServeCsvEntryVendorTaskBuilder extends RequestBuilder {
		
		public ServeCsvEntryVendorTaskBuilder(String id) {
			super(String.class, "reach_entryvendortask", "serveCsv");
			params.add("id", id);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Will serve a requested csv
	 * 
	 * @param id - the requested file id
	 */
    public static ServeCsvEntryVendorTaskBuilder serveCsv(String id)  {
		return new ServeCsvEntryVendorTaskBuilder(id);
	}
	
	public static class UpdateEntryVendorTaskBuilder extends RequestBuilder {
		
		public UpdateEntryVendorTaskBuilder(int id, EntryVendorTask entryVendorTask) {
			super(EntryVendorTask.class, "reach_entryvendortask", "update");
			params.add("id", id);
			params.add("entryVendorTask", entryVendorTask);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Update entry vendor task. Only the properties that were set will be updated.
	 * 
	 * @param id vendor task id to update
	 * @param entryVendorTask evntry vendor task to update
	 */
    public static UpdateEntryVendorTaskBuilder update(int id, EntryVendorTask entryVendorTask)  {
		return new UpdateEntryVendorTaskBuilder(id, entryVendorTask);
	}
	
	public static class UpdateJobEntryVendorTaskBuilder extends RequestBuilder {
		
		public UpdateJobEntryVendorTaskBuilder(int id, EntryVendorTask entryVendorTask) {
			super(EntryVendorTask.class, "reach_entryvendortask", "updateJob");
			params.add("id", id);
			params.add("entryVendorTask", entryVendorTask);
		}
		
		public void id(String multirequestToken) {
			params.add("id", multirequestToken);
		}
	}

	/**
	 * Update entry vendor task. Only the properties that were set will be updated.
	 * 
	 * @param id vendor task id to update
	 * @param entryVendorTask evntry vendor task to update
	 */
    public static UpdateJobEntryVendorTaskBuilder updateJob(int id, EntryVendorTask entryVendorTask)  {
		return new UpdateJobEntryVendorTaskBuilder(id, entryVendorTask);
	}
}