com.kaltura.client.services.KalturaDropFolderFileService 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;
import com.kaltura.client.enums.*;

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

/**  DropFolderFile service lets you create and manage drop folder files    */
@SuppressWarnings("serial")
public class KalturaDropFolderFileService extends KalturaServiceBase {
    public KalturaDropFolderFileService(KalturaClient client) {
        this.kalturaClient = client;
    }

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

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

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

	/**  Update status of KalturaDropFolderFile     */
    public KalturaDropFolderFile updateStatus(int dropFolderFileId, KalturaDropFolderFileStatus status) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("dropFolderFileId", dropFolderFileId);
        kparams.add("status", status);
        this.kalturaClient.queueServiceCall("dropfolder_dropfolderfile", "updateStatus", kparams, KalturaDropFolderFile.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaDropFolderFile.class, resultXmlElement);
    }

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

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

    public KalturaDropFolderFileListResponse list(KalturaDropFolderFileFilter filter) throws KalturaApiException {
        return this.list(filter, null);
    }

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

	/**  Set the KalturaDropFolderFile status to ignore
	  (KalturaDropFolderFileStatus::IGNORE)     */
    public KalturaDropFolderFile ignore(int dropFolderFileId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("dropFolderFileId", dropFolderFileId);
        this.kalturaClient.queueServiceCall("dropfolder_dropfolderfile", "ignore", kparams, KalturaDropFolderFile.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaDropFolderFile.class, resultXmlElement);
    }
}