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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kalturaClient 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

The newest version!

// ===================================================================================================
//                           _  __     _ _
//                          | |/ /__ _| | |_ _  _ _ _ __ _
//                          | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;

import com.kaltura.client.KalturaClient;
import com.kaltura.client.KalturaServiceBase;
import com.kaltura.client.types.*;
import org.w3c.dom.Element;
import com.kaltura.client.utils.ParseUtils;
import com.kaltura.client.KalturaParams;
import com.kaltura.client.KalturaApiException;

/**
 * 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    */
@SuppressWarnings("serial")
public class KalturaDropFolderService extends KalturaServiceBase {
    public KalturaDropFolderService(KalturaClient client) {
        this.kalturaClient = client;
    }

	/**  Allows you to add a new KalturaDropFolder object     */
    public KalturaDropFolder add(KalturaDropFolder dropFolder) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("dropFolder", dropFolder);
        this.kalturaClient.queueServiceCall("dropfolder_dropfolder", "add", kparams, KalturaDropFolder.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaDropFolder.class, resultXmlElement);
    }

	/**  Retrieve a KalturaDropFolder object by ID     */
    public KalturaDropFolder get(int dropFolderId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("dropFolderId", dropFolderId);
        this.kalturaClient.queueServiceCall("dropfolder_dropfolder", "get", kparams, KalturaDropFolder.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaDropFolder.class, resultXmlElement);
    }

	/**  Update an existing KalturaDropFolder object     */
    public KalturaDropFolder update(int dropFolderId, KalturaDropFolder dropFolder) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("dropFolderId", dropFolderId);
        kparams.add("dropFolder", dropFolder);
        this.kalturaClient.queueServiceCall("dropfolder_dropfolder", "update", kparams, KalturaDropFolder.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaDropFolder.class, resultXmlElement);
    }

	/**  Mark the KalturaDropFolder object as deleted     */
    public KalturaDropFolder delete(int dropFolderId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("dropFolderId", dropFolderId);
        this.kalturaClient.queueServiceCall("dropfolder_dropfolder", "delete", kparams, KalturaDropFolder.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaDropFolder.class, resultXmlElement);
    }

    public KalturaDropFolderListResponse list() throws KalturaApiException {
        return this.list(null);
    }

    public KalturaDropFolderListResponse list(KalturaDropFolderFilter filter) throws KalturaApiException {
        return this.list(filter, null);
    }

	/**  List KalturaDropFolder objects     */
    public KalturaDropFolderListResponse list(KalturaDropFolderFilter filter, KalturaFilterPager pager) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("filter", filter);
        kparams.add("pager", pager);
        this.kalturaClient.queueServiceCall("dropfolder_dropfolder", "list", kparams, KalturaDropFolderListResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaDropFolderListResponse.class, resultXmlElement);
    }
}