com.kaltura.client.services.DropFolderService 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.DropFolder;
import com.kaltura.client.types.DropFolderFilter;
import com.kaltura.client.types.FilterPager;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;

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

/**
 * DropFolder service lets you create and manage drop folders
 * 
 * @param dropFolder 
 * @param dropFolderId 
 * @param dropFolderId 
 * @param errorCode 
 * @param errorDescription 
 * @param dropFolderId 
 * @param tag 
 * @param maxTime 
 * @param filter 
 * @param pager 
 * @param dropFolderId 
 * @param dropFolder Id
 */
public class DropFolderService {
	
	public static class AddDropFolderBuilder extends RequestBuilder {
		
		public AddDropFolderBuilder(DropFolder dropFolder) {
			super(DropFolder.class, "dropfolder_dropfolder", "add");
			params.add("dropFolder", dropFolder);
		}
	}

	/**
	 * Allows you to add a new KalturaDropFolder object
	 * 
	 * @param dropFolder 
	 */
    public static AddDropFolderBuilder add(DropFolder dropFolder)  {
		return new AddDropFolderBuilder(dropFolder);
	}
	
	public static class DeleteDropFolderBuilder extends RequestBuilder {
		
		public DeleteDropFolderBuilder(int dropFolderId) {
			super(DropFolder.class, "dropfolder_dropfolder", "delete");
			params.add("dropFolderId", dropFolderId);
		}
		
		public void dropFolderId(String multirequestToken) {
			params.add("dropFolderId", multirequestToken);
		}
	}

	/**
	 * Mark the KalturaDropFolder object as deleted
	 * 
	 * @param dropFolderId 
	 */
    public static DeleteDropFolderBuilder delete(int dropFolderId)  {
		return new DeleteDropFolderBuilder(dropFolderId);
	}
	
	public static class FreeExclusiveDropFolderDropFolderBuilder extends RequestBuilder {
		
		public FreeExclusiveDropFolderDropFolderBuilder(int dropFolderId, String errorCode, String errorDescription) {
			super(DropFolder.class, "dropfolder_dropfolder", "freeExclusiveDropFolder");
			params.add("dropFolderId", dropFolderId);
			params.add("errorCode", errorCode);
			params.add("errorDescription", errorDescription);
		}
		
		public void dropFolderId(String multirequestToken) {
			params.add("dropFolderId", multirequestToken);
		}
		
		public void errorCode(String multirequestToken) {
			params.add("errorCode", multirequestToken);
		}
		
		public void errorDescription(String multirequestToken) {
			params.add("errorDescription", multirequestToken);
		}
	}

	public static FreeExclusiveDropFolderDropFolderBuilder freeExclusiveDropFolder(int dropFolderId)  {
		return freeExclusiveDropFolder(dropFolderId, null);
	}

	public static FreeExclusiveDropFolderDropFolderBuilder freeExclusiveDropFolder(int dropFolderId, String errorCode)  {
		return freeExclusiveDropFolder(dropFolderId, errorCode, null);
	}

	/**
	 * freeExclusive KalturaDropFolder object
	 * 
	 * @param dropFolderId 
	 * @param errorCode 
	 * @param errorDescription 
	 */
    public static FreeExclusiveDropFolderDropFolderBuilder freeExclusiveDropFolder(int dropFolderId, String errorCode, String errorDescription)  {
		return new FreeExclusiveDropFolderDropFolderBuilder(dropFolderId, errorCode, errorDescription);
	}
	
	public static class GetDropFolderBuilder extends RequestBuilder {
		
		public GetDropFolderBuilder(int dropFolderId) {
			super(DropFolder.class, "dropfolder_dropfolder", "get");
			params.add("dropFolderId", dropFolderId);
		}
		
		public void dropFolderId(String multirequestToken) {
			params.add("dropFolderId", multirequestToken);
		}
	}

	/**
	 * Retrieve a KalturaDropFolder object by ID
	 * 
	 * @param dropFolderId 
	 */
    public static GetDropFolderBuilder get(int dropFolderId)  {
		return new GetDropFolderBuilder(dropFolderId);
	}
	
	public static class GetExclusiveDropFolderDropFolderBuilder extends RequestBuilder {
		
		public GetExclusiveDropFolderDropFolderBuilder(String tag, int maxTime) {
			super(DropFolder.class, "dropfolder_dropfolder", "getExclusiveDropFolder");
			params.add("tag", tag);
			params.add("maxTime", maxTime);
		}
		
		public void tag(String multirequestToken) {
			params.add("tag", multirequestToken);
		}
		
		public void maxTime(String multirequestToken) {
			params.add("maxTime", multirequestToken);
		}
	}

	/**
	 * getExclusive KalturaDropFolder object
	 * 
	 * @param tag 
	 * @param maxTime 
	 */
    public static GetExclusiveDropFolderDropFolderBuilder getExclusiveDropFolder(String tag, int maxTime)  {
		return new GetExclusiveDropFolderDropFolderBuilder(tag, maxTime);
	}
	
	public static class ListDropFolderBuilder extends ListResponseRequestBuilder {
		
		public ListDropFolderBuilder(DropFolderFilter filter, FilterPager pager) {
			super(DropFolder.class, "dropfolder_dropfolder", "list");
			params.add("filter", filter);
			params.add("pager", pager);
		}
	}

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

	public static ListDropFolderBuilder list(DropFolderFilter filter)  {
		return list(filter, null);
	}

	/**
	 * List KalturaDropFolder objects
	 * 
	 * @param filter 
	 * @param pager 
	 */
    public static ListDropFolderBuilder list(DropFolderFilter filter, FilterPager pager)  {
		return new ListDropFolderBuilder(filter, pager);
	}
	
	public static class UpdateDropFolderBuilder extends RequestBuilder {
		
		public UpdateDropFolderBuilder(int dropFolderId, DropFolder dropFolder) {
			super(DropFolder.class, "dropfolder_dropfolder", "update");
			params.add("dropFolderId", dropFolderId);
			params.add("dropFolder", dropFolder);
		}
		
		public void dropFolderId(String multirequestToken) {
			params.add("dropFolderId", multirequestToken);
		}
	}

	/**
	 * Update an existing KalturaDropFolder object
	 * 
	 * @param dropFolderId 
	 * @param dropFolder Id
	 */
    public static UpdateDropFolderBuilder update(int dropFolderId, DropFolder dropFolder)  {
		return new UpdateDropFolderBuilder(dropFolderId, dropFolder);
	}
}