com.kaltura.client.services.KalturaMetadataProfileService 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 java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import com.kaltura.client.KalturaFiles;
import com.kaltura.client.KalturaFile;

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

/**  Metadata Profile service    */
@SuppressWarnings("serial")
public class KalturaMetadataProfileService extends KalturaServiceBase {
    public KalturaMetadataProfileService(KalturaClient client) {
        this.kalturaClient = client;
    }

    public KalturaMetadataProfile add(KalturaMetadataProfile metadataProfile, String xsdData) throws KalturaApiException {
        return this.add(metadataProfile, xsdData, null);
    }

	/**  Allows you to add a metadata profile object and metadata profile content
	  associated with Kaltura object type     */
    public KalturaMetadataProfile add(KalturaMetadataProfile metadataProfile, String xsdData, String viewsData) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("metadataProfile", metadataProfile);
        kparams.add("xsdData", xsdData);
        kparams.add("viewsData", viewsData);
        this.kalturaClient.queueServiceCall("metadata_metadataprofile", "add", kparams, KalturaMetadataProfile.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaMetadataProfile.class, resultXmlElement);
    }

    public KalturaMetadataProfile addFromFile(KalturaMetadataProfile metadataProfile, KalturaFile xsdFile) throws KalturaApiException {
        return this.addFromFile(metadataProfile, xsdFile, (KalturaFile)null);
    }

    public KalturaMetadataProfile addFromFile(KalturaMetadataProfile metadataProfile, File xsdFile) throws KalturaApiException {
        return this.addFromFile(metadataProfile, new KalturaFile(xsdFile), (KalturaFile)null);
    }

    public KalturaMetadataProfile addFromFile(KalturaMetadataProfile metadataProfile, InputStream xsdFile, String xsdFileName, long xsdFileSize) throws KalturaApiException {
        return this.addFromFile(metadataProfile, new KalturaFile(xsdFile, xsdFileName, xsdFileSize), (KalturaFile)null);
    }

    public KalturaMetadataProfile addFromFile(KalturaMetadataProfile metadataProfile, FileInputStream xsdFile, String xsdFileName) throws KalturaApiException {
        return this.addFromFile(metadataProfile, new KalturaFile(xsdFile, xsdFileName), (KalturaFile)null);
    }

    public KalturaMetadataProfile addFromFile(KalturaMetadataProfile metadataProfile, File xsdFile, File viewsFile) throws KalturaApiException {
        return this.addFromFile(metadataProfile, new KalturaFile(xsdFile), new KalturaFile(viewsFile));
    }

    public KalturaMetadataProfile addFromFile(KalturaMetadataProfile metadataProfile, InputStream xsdFile, String xsdFileName, long xsdFileSize, InputStream viewsFile, String viewsFileName, long viewsFileSize) throws KalturaApiException {
        return this.addFromFile(metadataProfile, new KalturaFile(xsdFile, xsdFileName, xsdFileSize), new KalturaFile(viewsFile, viewsFileName, viewsFileSize));
    }

    public KalturaMetadataProfile addFromFile(KalturaMetadataProfile metadataProfile, FileInputStream xsdFile, String xsdFileName, FileInputStream viewsFile, String viewsFileName) throws KalturaApiException {
        return this.addFromFile(metadataProfile, new KalturaFile(xsdFile, xsdFileName), new KalturaFile(viewsFile, viewsFileName));
    }

	/**  Allows you to add a metadata profile object and metadata profile file associated
	  with Kaltura object type     */
    public KalturaMetadataProfile addFromFile(KalturaMetadataProfile metadataProfile, KalturaFile xsdFile, KalturaFile viewsFile) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("metadataProfile", metadataProfile);
        KalturaFiles kfiles = new KalturaFiles();
        kfiles.add("xsdFile", xsdFile);
        kfiles.add("viewsFile", viewsFile);
        this.kalturaClient.queueServiceCall("metadata_metadataprofile", "addFromFile", kparams, kfiles, KalturaMetadataProfile.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaMetadataProfile.class, resultXmlElement);
    }

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

    public KalturaMetadataProfile update(int id, KalturaMetadataProfile metadataProfile) throws KalturaApiException {
        return this.update(id, metadataProfile, null);
    }

    public KalturaMetadataProfile update(int id, KalturaMetadataProfile metadataProfile, String xsdData) throws KalturaApiException {
        return this.update(id, metadataProfile, xsdData, null);
    }

	/**  Update an existing metadata object     */
    public KalturaMetadataProfile update(int id, KalturaMetadataProfile metadataProfile, String xsdData, String viewsData) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        kparams.add("metadataProfile", metadataProfile);
        kparams.add("xsdData", xsdData);
        kparams.add("viewsData", viewsData);
        this.kalturaClient.queueServiceCall("metadata_metadataprofile", "update", kparams, KalturaMetadataProfile.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaMetadataProfile.class, resultXmlElement);
    }

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

    public KalturaMetadataProfileListResponse list(KalturaMetadataProfileFilter filter) throws KalturaApiException {
        return this.list(filter, null);
    }

	/**  List metadata profile objects by filter and pager     */
    public KalturaMetadataProfileListResponse list(KalturaMetadataProfileFilter filter, KalturaFilterPager pager) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("filter", filter);
        kparams.add("pager", pager);
        this.kalturaClient.queueServiceCall("metadata_metadataprofile", "list", kparams, KalturaMetadataProfileListResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaMetadataProfileListResponse.class, resultXmlElement);
    }

	/**  List metadata profile fields by metadata profile id     */
    public KalturaMetadataProfileFieldListResponse listFields(int metadataProfileId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("metadataProfileId", metadataProfileId);
        this.kalturaClient.queueServiceCall("metadata_metadataprofile", "listFields", kparams, KalturaMetadataProfileFieldListResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaMetadataProfileFieldListResponse.class, resultXmlElement);
    }

	/**  Delete an existing metadata profile     */
    public void delete(int id) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        this.kalturaClient.queueServiceCall("metadata_metadataprofile", "delete", kparams);
        if (this.kalturaClient.isMultiRequest())
            return ;
        this.kalturaClient.doQueue();
    }

	/**  Update an existing metadata object definition file     */
    public KalturaMetadataProfile revert(int id, int toVersion) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        kparams.add("toVersion", toVersion);
        this.kalturaClient.queueServiceCall("metadata_metadataprofile", "revert", kparams, KalturaMetadataProfile.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaMetadataProfile.class, resultXmlElement);
    }

    public KalturaMetadataProfile updateDefinitionFromFile(int id, File xsdFile) throws KalturaApiException {
        return this.updateDefinitionFromFile(id, new KalturaFile(xsdFile));
    }

    public KalturaMetadataProfile updateDefinitionFromFile(int id, InputStream xsdFile, String xsdFileName, long xsdFileSize) throws KalturaApiException {
        return this.updateDefinitionFromFile(id, new KalturaFile(xsdFile, xsdFileName, xsdFileSize));
    }

    public KalturaMetadataProfile updateDefinitionFromFile(int id, FileInputStream xsdFile, String xsdFileName) throws KalturaApiException {
        return this.updateDefinitionFromFile(id, new KalturaFile(xsdFile, xsdFileName));
    }

	/**  Update an existing metadata object definition file     */
    public KalturaMetadataProfile updateDefinitionFromFile(int id, KalturaFile xsdFile) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        KalturaFiles kfiles = new KalturaFiles();
        kfiles.add("xsdFile", xsdFile);
        this.kalturaClient.queueServiceCall("metadata_metadataprofile", "updateDefinitionFromFile", kparams, kfiles, KalturaMetadataProfile.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaMetadataProfile.class, resultXmlElement);
    }

    public KalturaMetadataProfile updateViewsFromFile(int id, File viewsFile) throws KalturaApiException {
        return this.updateViewsFromFile(id, new KalturaFile(viewsFile));
    }

    public KalturaMetadataProfile updateViewsFromFile(int id, InputStream viewsFile, String viewsFileName, long viewsFileSize) throws KalturaApiException {
        return this.updateViewsFromFile(id, new KalturaFile(viewsFile, viewsFileName, viewsFileSize));
    }

    public KalturaMetadataProfile updateViewsFromFile(int id, FileInputStream viewsFile, String viewsFileName) throws KalturaApiException {
        return this.updateViewsFromFile(id, new KalturaFile(viewsFile, viewsFileName));
    }

	/**  Update an existing metadata object views file     */
    public KalturaMetadataProfile updateViewsFromFile(int id, KalturaFile viewsFile) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        KalturaFiles kfiles = new KalturaFiles();
        kfiles.add("viewsFile", viewsFile);
        this.kalturaClient.queueServiceCall("metadata_metadataprofile", "updateViewsFromFile", kparams, kfiles, KalturaMetadataProfile.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaMetadataProfile.class, resultXmlElement);
    }

    public KalturaMetadataProfile updateTransformationFromFile(int id, File xsltFile) throws KalturaApiException {
        return this.updateTransformationFromFile(id, new KalturaFile(xsltFile));
    }

    public KalturaMetadataProfile updateTransformationFromFile(int id, InputStream xsltFile, String xsltFileName, long xsltFileSize) throws KalturaApiException {
        return this.updateTransformationFromFile(id, new KalturaFile(xsltFile, xsltFileName, xsltFileSize));
    }

    public KalturaMetadataProfile updateTransformationFromFile(int id, FileInputStream xsltFile, String xsltFileName) throws KalturaApiException {
        return this.updateTransformationFromFile(id, new KalturaFile(xsltFile, xsltFileName));
    }

	/**  Update an existing metadata object xslt file     */
    public KalturaMetadataProfile updateTransformationFromFile(int id, KalturaFile xsltFile) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        KalturaFiles kfiles = new KalturaFiles();
        kfiles.add("xsltFile", xsltFile);
        this.kalturaClient.queueServiceCall("metadata_metadataprofile", "updateTransformationFromFile", kparams, kfiles, KalturaMetadataProfile.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaMetadataProfile.class, resultXmlElement);
    }

	/**  Serves metadata profile XSD file     */
    public String serve(int id) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        this.kalturaClient.queueServiceCall("metadata_metadataprofile", "serve", kparams);
        return this.kalturaClient.serve();
    }

	/**  Serves metadata profile view file     */
    public String serveView(int id) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("id", id);
        this.kalturaClient.queueServiceCall("metadata_metadataprofile", "serveView", kparams);
        return this.kalturaClient.serve();
    }
}