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

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

There is a newer version: 19.3.0

Show newest version

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

import com.kaltura.client.types.FilterPager;
import com.kaltura.client.types.PermissionItem;
import com.kaltura.client.types.PermissionItemFilter;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;

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

/**
 * PermissionItem service lets you create and manage permission items
 * 
 * @param permissionItem The new permission item
 * @param permissionItemId The permission item's unique identifier
 * @param permissionItemId The permission item's unique identifier
 * @param filter A filter used to exclude specific types of permission items
 * @param pager A limit for the number of records to display on a page
 * @param permissionItemId The permission item's unique identifier
 * @param permissionItem Id The permission item's unique identifier
 */
public class PermissionItemService {
	
	public static class AddPermissionItemBuilder extends RequestBuilder {
		
		public AddPermissionItemBuilder(PermissionItem permissionItem) {
			super(PermissionItem.class, "permissionitem", "add");
			params.add("permissionItem", permissionItem);
		}
	}

	/**
	 * Adds a new permission item object to the account.   This action is available
	  only to Kaltura system administrators.
	 * 
	 * @param permissionItem The new permission item
	 */
    public static AddPermissionItemBuilder add(PermissionItem permissionItem)  {
		return new AddPermissionItemBuilder(permissionItem);
	}
	
	public static class DeletePermissionItemBuilder extends RequestBuilder {
		
		public DeletePermissionItemBuilder(int permissionItemId) {
			super(PermissionItem.class, "permissionitem", "delete");
			params.add("permissionItemId", permissionItemId);
		}
		
		public void permissionItemId(String multirequestToken) {
			params.add("permissionItemId", multirequestToken);
		}
	}

	/**
	 * Deletes an existing permission item object.   This action is available only to
	  Kaltura system administrators.
	 * 
	 * @param permissionItemId The permission item's unique identifier
	 */
    public static DeletePermissionItemBuilder delete(int permissionItemId)  {
		return new DeletePermissionItemBuilder(permissionItemId);
	}
	
	public static class GetPermissionItemBuilder extends RequestBuilder {
		
		public GetPermissionItemBuilder(int permissionItemId) {
			super(PermissionItem.class, "permissionitem", "get");
			params.add("permissionItemId", permissionItemId);
		}
		
		public void permissionItemId(String multirequestToken) {
			params.add("permissionItemId", multirequestToken);
		}
	}

	/**
	 * Retrieves a permission item object using its ID.
	 * 
	 * @param permissionItemId The permission item's unique identifier
	 */
    public static GetPermissionItemBuilder get(int permissionItemId)  {
		return new GetPermissionItemBuilder(permissionItemId);
	}
	
	public static class ListPermissionItemBuilder extends ListResponseRequestBuilder {
		
		public ListPermissionItemBuilder(PermissionItemFilter filter, FilterPager pager) {
			super(PermissionItem.class, "permissionitem", "list");
			params.add("filter", filter);
			params.add("pager", pager);
		}
	}

	public static ListPermissionItemBuilder list()  {
		return list(null);
	}

	public static ListPermissionItemBuilder list(PermissionItemFilter filter)  {
		return list(filter, null);
	}

	/**
	 * Lists permission item objects that are associated with an account.
	 * 
	 * @param filter A filter used to exclude specific types of permission items
	 * @param pager A limit for the number of records to display on a page
	 */
    public static ListPermissionItemBuilder list(PermissionItemFilter filter, FilterPager pager)  {
		return new ListPermissionItemBuilder(filter, pager);
	}
	
	public static class UpdatePermissionItemBuilder extends RequestBuilder {
		
		public UpdatePermissionItemBuilder(int permissionItemId, PermissionItem permissionItem) {
			super(PermissionItem.class, "permissionitem", "update");
			params.add("permissionItemId", permissionItemId);
			params.add("permissionItem", permissionItem);
		}
		
		public void permissionItemId(String multirequestToken) {
			params.add("permissionItemId", multirequestToken);
		}
	}

	/**
	 * Updates an existing permission item object.   This action is available only to
	  Kaltura system administrators.
	 * 
	 * @param permissionItemId The permission item's unique identifier
	 * @param permissionItem Id The permission item's unique identifier
	 */
    public static UpdatePermissionItemBuilder update(int permissionItemId, PermissionItem permissionItem)  {
		return new UpdatePermissionItemBuilder(permissionItemId, permissionItem);
	}
}