com.kaltura.client.services.CategoryService Maven / Gradle / Ivy
// ===================================================================================================
// _ __ _ _
// | |/ /__ _| | |_ _ _ _ _ __ _
// | ' .
//
// @ignore
// ===================================================================================================
package com.kaltura.client.services;
import com.kaltura.client.FileHolder;
import com.kaltura.client.Files;
import com.kaltura.client.types.BulkUpload;
import com.kaltura.client.types.BulkUploadCategoryData;
import com.kaltura.client.types.BulkUploadJobData;
import com.kaltura.client.types.Category;
import com.kaltura.client.types.CategoryFilter;
import com.kaltura.client.types.CsvAdditionalFieldInfo;
import com.kaltura.client.types.ExportToCsvOptions;
import com.kaltura.client.types.FilterPager;
import com.kaltura.client.types.KeyValue;
import com.kaltura.client.utils.request.ListResponseRequestBuilder;
import com.kaltura.client.utils.request.NullRequestBuilder;
import com.kaltura.client.utils.request.RequestBuilder;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.util.List;
/**
* This class was generated using exec.php
* against an XML schema provided by Kaltura.
*
* MANUAL CHANGES TO THIS CLASS WILL BE OVERWRITTEN.
*/
/**
* Add & Manage Categories
*
* @param category
* @param fileData
* @param bulkUploadData
* @param bulkUploadCategoryData
* @param categoryId
* @param fromPartnerId
* @param parentCategoryId
* @param id
* @param moveEntriesToParentCategory
* @param filter A filter used to exclude specific categories
* @param metadataProfileId
* @param additionalFields
* @param mappedFields mapping between field headline and its mapped value
* @param options
* @param id
* @param id
* @param shouldUpdate
* @param filter
* @param pager
* @param categoryIds
* @param targetCategoryParentId
* @param id
* @param category
*/
public class CategoryService {
public static class AddCategoryBuilder extends RequestBuilder {
public AddCategoryBuilder(Category category) {
super(Category.class, "category", "add");
params.add("category", category);
}
}
/**
* Add new Category
*
* @param category
*/
public static AddCategoryBuilder add(Category category) {
return new AddCategoryBuilder(category);
}
public static class AddFromBulkUploadCategoryBuilder extends RequestBuilder {
public AddFromBulkUploadCategoryBuilder(FileHolder fileData, BulkUploadJobData bulkUploadData, BulkUploadCategoryData bulkUploadCategoryData) {
super(BulkUpload.class, "category", "addFromBulkUpload");
files = new Files();
files.add("fileData", fileData);
params.add("bulkUploadData", bulkUploadData);
params.add("bulkUploadCategoryData", bulkUploadCategoryData);
}
}
public static AddFromBulkUploadCategoryBuilder addFromBulkUpload(FileHolder fileData) {
return addFromBulkUpload(fileData, null);
}
public static AddFromBulkUploadCategoryBuilder addFromBulkUpload(File fileData) {
return addFromBulkUpload(new FileHolder(fileData), null);
}
public static AddFromBulkUploadCategoryBuilder addFromBulkUpload(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize) {
return addFromBulkUpload(new FileHolder(fileData, fileDataMimeType, fileDataName, fileDataSize), null);
}
public static AddFromBulkUploadCategoryBuilder addFromBulkUpload(FileInputStream fileData, String fileDataMimeType, String fileDataName) {
return addFromBulkUpload(new FileHolder(fileData, fileDataMimeType, fileDataName), null);
}
public static AddFromBulkUploadCategoryBuilder addFromBulkUpload(FileHolder fileData, BulkUploadJobData bulkUploadData) {
return addFromBulkUpload(fileData, bulkUploadData, null);
}
public static AddFromBulkUploadCategoryBuilder addFromBulkUpload(File fileData, BulkUploadJobData bulkUploadData) {
return addFromBulkUpload(new FileHolder(fileData), bulkUploadData, null);
}
public static AddFromBulkUploadCategoryBuilder addFromBulkUpload(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize, BulkUploadJobData bulkUploadData) {
return addFromBulkUpload(new FileHolder(fileData, fileDataMimeType, fileDataName, fileDataSize), bulkUploadData, null);
}
public static AddFromBulkUploadCategoryBuilder addFromBulkUpload(FileInputStream fileData, String fileDataMimeType, String fileDataName, BulkUploadJobData bulkUploadData) {
return addFromBulkUpload(new FileHolder(fileData, fileDataMimeType, fileDataName), bulkUploadData, null);
}
public static AddFromBulkUploadCategoryBuilder addFromBulkUpload(File fileData, BulkUploadJobData bulkUploadData, BulkUploadCategoryData bulkUploadCategoryData) {
return addFromBulkUpload(new FileHolder(fileData), bulkUploadData, bulkUploadCategoryData);
}
public static AddFromBulkUploadCategoryBuilder addFromBulkUpload(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize, BulkUploadJobData bulkUploadData, BulkUploadCategoryData bulkUploadCategoryData) {
return addFromBulkUpload(new FileHolder(fileData, fileDataMimeType, fileDataName, fileDataSize), bulkUploadData, bulkUploadCategoryData);
}
public static AddFromBulkUploadCategoryBuilder addFromBulkUpload(FileInputStream fileData, String fileDataMimeType, String fileDataName, BulkUploadJobData bulkUploadData, BulkUploadCategoryData bulkUploadCategoryData) {
return addFromBulkUpload(new FileHolder(fileData, fileDataMimeType, fileDataName), bulkUploadData, bulkUploadCategoryData);
}
public static AddFromBulkUploadCategoryBuilder addFromBulkUpload(FileHolder fileData, BulkUploadJobData bulkUploadData, BulkUploadCategoryData bulkUploadCategoryData) {
return new AddFromBulkUploadCategoryBuilder(fileData, bulkUploadData, bulkUploadCategoryData);
}
public static class CloneCategoryBuilder extends RequestBuilder {
public CloneCategoryBuilder(int categoryId, int fromPartnerId, int parentCategoryId) {
super(Category.class, "category", "clone");
params.add("categoryId", categoryId);
params.add("fromPartnerId", fromPartnerId);
params.add("parentCategoryId", parentCategoryId);
}
public void categoryId(String multirequestToken) {
params.add("categoryId", multirequestToken);
}
public void fromPartnerId(String multirequestToken) {
params.add("fromPartnerId", multirequestToken);
}
public void parentCategoryId(String multirequestToken) {
params.add("parentCategoryId", multirequestToken);
}
}
public static CloneCategoryBuilder clone(int categoryId, int fromPartnerId) {
return clone(categoryId, fromPartnerId, Integer.MIN_VALUE);
}
/**
* Clone Category
*
* @param categoryId
* @param fromPartnerId
* @param parentCategoryId
*/
public static CloneCategoryBuilder clone(int categoryId, int fromPartnerId, int parentCategoryId) {
return new CloneCategoryBuilder(categoryId, fromPartnerId, parentCategoryId);
}
public static class DeleteCategoryBuilder extends NullRequestBuilder {
public DeleteCategoryBuilder(long id, Boolean moveEntriesToParentCategory) {
super("category", "delete");
params.add("id", id);
params.add("moveEntriesToParentCategory", moveEntriesToParentCategory);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
public void moveEntriesToParentCategory(String multirequestToken) {
params.add("moveEntriesToParentCategory", multirequestToken);
}
}
public static DeleteCategoryBuilder delete(long id) {
return delete(id, true);
}
/**
* Delete a Category
*
* @param id
* @param moveEntriesToParentCategory
*/
public static DeleteCategoryBuilder delete(long id, Boolean moveEntriesToParentCategory) {
return new DeleteCategoryBuilder(id, moveEntriesToParentCategory);
}
public static class ExportToCsvCategoryBuilder extends RequestBuilder {
public ExportToCsvCategoryBuilder(CategoryFilter filter, int metadataProfileId, List additionalFields, List mappedFields, ExportToCsvOptions options) {
super(String.class, "category", "exportToCsv");
params.add("filter", filter);
params.add("metadataProfileId", metadataProfileId);
params.add("additionalFields", additionalFields);
params.add("mappedFields", mappedFields);
params.add("options", options);
}
public void metadataProfileId(String multirequestToken) {
params.add("metadataProfileId", multirequestToken);
}
}
public static ExportToCsvCategoryBuilder exportToCsv() {
return exportToCsv(null);
}
public static ExportToCsvCategoryBuilder exportToCsv(CategoryFilter filter) {
return exportToCsv(filter, Integer.MIN_VALUE);
}
public static ExportToCsvCategoryBuilder exportToCsv(CategoryFilter filter, int metadataProfileId) {
return exportToCsv(filter, metadataProfileId, null);
}
public static ExportToCsvCategoryBuilder exportToCsv(CategoryFilter filter, int metadataProfileId, List additionalFields) {
return exportToCsv(filter, metadataProfileId, additionalFields, null);
}
public static ExportToCsvCategoryBuilder exportToCsv(CategoryFilter filter, int metadataProfileId, List additionalFields, List mappedFields) {
return exportToCsv(filter, metadataProfileId, additionalFields, mappedFields, null);
}
/**
* Creates a batch job that sends an email with a link to download a CSV containing
a list of categories
*
* @param filter A filter used to exclude specific categories
* @param metadataProfileId
* @param additionalFields
* @param mappedFields mapping between field headline and its mapped value
* @param options
*/
public static ExportToCsvCategoryBuilder exportToCsv(CategoryFilter filter, int metadataProfileId, List additionalFields, List mappedFields, ExportToCsvOptions options) {
return new ExportToCsvCategoryBuilder(filter, metadataProfileId, additionalFields, mappedFields, options);
}
public static class GetCategoryBuilder extends RequestBuilder {
public GetCategoryBuilder(long id) {
super(Category.class, "category", "get");
params.add("id", id);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
}
/**
* Get Category by id
*
* @param id
*/
public static GetCategoryBuilder get(long id) {
return new GetCategoryBuilder(id);
}
public static class IndexCategoryBuilder extends RequestBuilder {
public IndexCategoryBuilder(long id, boolean shouldUpdate) {
super(Integer.class, "category", "index");
params.add("id", id);
params.add("shouldUpdate", shouldUpdate);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
public void shouldUpdate(String multirequestToken) {
params.add("shouldUpdate", multirequestToken);
}
}
public static IndexCategoryBuilder index(long id) {
return index(id, true);
}
/**
* Index Category by id
*
* @param id
* @param shouldUpdate
*/
public static IndexCategoryBuilder index(long id, boolean shouldUpdate) {
return new IndexCategoryBuilder(id, shouldUpdate);
}
public static class ListCategoryBuilder extends ListResponseRequestBuilder {
public ListCategoryBuilder(CategoryFilter filter, FilterPager pager) {
super(Category.class, "category", "list");
params.add("filter", filter);
params.add("pager", pager);
}
}
public static ListCategoryBuilder list() {
return list(null);
}
public static ListCategoryBuilder list(CategoryFilter filter) {
return list(filter, null);
}
/**
* List all categories
*
* @param filter
* @param pager
*/
public static ListCategoryBuilder list(CategoryFilter filter, FilterPager pager) {
return new ListCategoryBuilder(filter, pager);
}
public static class MoveCategoryBuilder extends RequestBuilder {
public MoveCategoryBuilder(String categoryIds, int targetCategoryParentId) {
super(Boolean.class, "category", "move");
params.add("categoryIds", categoryIds);
params.add("targetCategoryParentId", targetCategoryParentId);
}
public void categoryIds(String multirequestToken) {
params.add("categoryIds", multirequestToken);
}
public void targetCategoryParentId(String multirequestToken) {
params.add("targetCategoryParentId", multirequestToken);
}
}
/**
* Move categories that belong to the same parent category to a target category -
enabled only for ks with disable entitlement
*
* @param categoryIds
* @param targetCategoryParentId
*/
public static MoveCategoryBuilder move(String categoryIds, int targetCategoryParentId) {
return new MoveCategoryBuilder(categoryIds, targetCategoryParentId);
}
public static class UnlockCategoriesCategoryBuilder extends NullRequestBuilder {
public UnlockCategoriesCategoryBuilder() {
super("category", "unlockCategories");
}
}
/**
* Unlock categories
*/
public static UnlockCategoriesCategoryBuilder unlockCategories() {
return new UnlockCategoriesCategoryBuilder();
}
public static class UpdateCategoryBuilder extends RequestBuilder {
public UpdateCategoryBuilder(long id, Category category) {
super(Category.class, "category", "update");
params.add("id", id);
params.add("category", category);
}
public void id(String multirequestToken) {
params.add("id", multirequestToken);
}
}
/**
* Update Category
*
* @param id
* @param category
*/
public static UpdateCategoryBuilder update(long id, Category category) {
return new UpdateCategoryBuilder(id, category);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy