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

/**  UserRole service lets you create and manage user roles    */
@SuppressWarnings("serial")
public class KalturaUserRoleService extends KalturaServiceBase {
    public KalturaUserRoleService(KalturaClient client) {
        this.kalturaClient = client;
    }

	/**  Adds a new user role object to the account.     */
    public KalturaUserRole add(KalturaUserRole userRole) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("userRole", userRole);
        this.kalturaClient.queueServiceCall("userrole", "add", kparams, KalturaUserRole.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaUserRole.class, resultXmlElement);
    }

	/**  Retrieves a user role object using its ID.     */
    public KalturaUserRole get(int userRoleId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("userRoleId", userRoleId);
        this.kalturaClient.queueServiceCall("userrole", "get", kparams, KalturaUserRole.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaUserRole.class, resultXmlElement);
    }

	/**  Updates an existing user role object.     */
    public KalturaUserRole update(int userRoleId, KalturaUserRole userRole) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("userRoleId", userRoleId);
        kparams.add("userRole", userRole);
        this.kalturaClient.queueServiceCall("userrole", "update", kparams, KalturaUserRole.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaUserRole.class, resultXmlElement);
    }

	/**  Deletes an existing user role object.     */
    public KalturaUserRole delete(int userRoleId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("userRoleId", userRoleId);
        this.kalturaClient.queueServiceCall("userrole", "delete", kparams, KalturaUserRole.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaUserRole.class, resultXmlElement);
    }

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

    public KalturaUserRoleListResponse list(KalturaUserRoleFilter filter) throws KalturaApiException {
        return this.list(filter, null);
    }

	/**  Lists user role objects that are associated with an account.   Blocked user
	  roles are listed unless you use a filter to exclude them.   Deleted user roles
	  are not listed unless you use a filter to include them.     */
    public KalturaUserRoleListResponse list(KalturaUserRoleFilter filter, KalturaFilterPager pager) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("filter", filter);
        kparams.add("pager", pager);
        this.kalturaClient.queueServiceCall("userrole", "list", kparams, KalturaUserRoleListResponse.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaUserRoleListResponse.class, resultXmlElement);
    }

	/**  Creates a new user role object that is a duplicate of an existing role.     */
    public KalturaUserRole clone(int userRoleId) throws KalturaApiException {
        KalturaParams kparams = new KalturaParams();
        kparams.add("userRoleId", userRoleId);
        this.kalturaClient.queueServiceCall("userrole", "clone", kparams, KalturaUserRole.class);
        if (this.kalturaClient.isMultiRequest())
            return null;
        Element resultXmlElement = this.kalturaClient.doQueue();
        return ParseUtils.parseObject(KalturaUserRole.class, resultXmlElement);
    }
}