com.kaltura.client.services.KalturaDataService 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.
 */

/**  Data service lets you manage data content (textual content)    */
@SuppressWarnings("serial")
public class KalturaDataService extends KalturaServiceBase {
    public KalturaDataService(KalturaClient client) {
        this.kalturaClient = client;
    }

	/**  Adds a new data entry     */
    public KalturaDataEntry add(KalturaDataEntry dataEntry) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("dataEntry", dataEntry);
        this.kalturaClient.queueServiceCall("data", "add", kparams, KalturaDataEntry.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaDataEntry.class, resultXmlElement);
    }

    public KalturaDataEntry get(String entryId) throws KalturaApiException {
        return this.get(entryId, -1);
    }

	/**  Get data entry by ID.     */
    public KalturaDataEntry get(String entryId, int version) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("entryId", entryId);
        kparams.add("version", version);
        this.kalturaClient.queueServiceCall("data", "get", kparams, KalturaDataEntry.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaDataEntry.class, resultXmlElement);
    }

	/**  Update data entry. Only the properties that were set will be updated.     */
    public KalturaDataEntry update(String entryId, KalturaDataEntry documentEntry) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("entryId", entryId);
        kparams.add("documentEntry", documentEntry);
        this.kalturaClient.queueServiceCall("data", "update", kparams, KalturaDataEntry.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaDataEntry.class, resultXmlElement);
    }

	/**  Delete a data entry.     */
    public void delete(String entryId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("entryId", entryId);
        this.kalturaClient.queueServiceCall("data", "delete", kparams);
        if (this.kalturaClient.isMultiRequest())
            return ;
        this.kalturaClient.doQueue();
    }

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

    public KalturaDataListResponse list(KalturaDataEntryFilter filter) throws KalturaApiException {
        return this.list(filter, null);
    }

	/**  List data entries by filter with paging support.     */
    public KalturaDataListResponse list(KalturaDataEntryFilter filter, KalturaFilterPager pager) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("filter", filter);
        kparams.add("pager", pager);
        this.kalturaClient.queueServiceCall("data", "list", kparams, KalturaDataListResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaDataListResponse.class, resultXmlElement);
    }

    public String serve(String entryId) throws KalturaApiException {
        return this.serve(entryId, -1);
    }

    public String serve(String entryId, int version) throws KalturaApiException {
        return this.serve(entryId, version, false);
    }

	/**  serve action returan the file from dataContent field.     */
    public String serve(String entryId, int version, boolean forceProxy) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("entryId", entryId);
        kparams.add("version", version);
        kparams.add("forceProxy", forceProxy);
        this.kalturaClient.queueServiceCall("data", "serve", kparams);
        return this.kalturaClient.serve();
    }
}