Package com.kaltura.client.services

Class CategoryService

java.lang.Object

com.kaltura.client.services.CategoryService

public class CategoryService
extends Object

Add & Manage Categories

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CategoryService.AddCategoryBuilder
static class	CategoryService.AddFromBulkUploadCategoryBuilder
static class	CategoryService.CloneCategoryBuilder
static class	CategoryService.DeleteCategoryBuilder
static class	CategoryService.ExportToCsvCategoryBuilder
static class	CategoryService.GetCategoryBuilder
static class	CategoryService.IndexCategoryBuilder
static class	CategoryService.ListCategoryBuilder
static class	CategoryService.MoveCategoryBuilder
static class	CategoryService.UnlockCategoriesCategoryBuilder
static class	CategoryService.UpdateCategoryBuilder

Constructor Summary

Constructors

Constructor	Description
CategoryService()

Method Summary

Modifier and Type	Method	Description
static CategoryService.AddCategoryBuilder	add(Category category)	Add new Category
static CategoryService.AddFromBulkUploadCategoryBuilder	addFromBulkUpload(FileHolder fileData)
static CategoryService.AddFromBulkUploadCategoryBuilder	addFromBulkUpload(FileHolder fileData, BulkUploadJobData bulkUploadData)
static CategoryService.AddFromBulkUploadCategoryBuilder	addFromBulkUpload(FileHolder fileData, BulkUploadJobData bulkUploadData, BulkUploadCategoryData bulkUploadCategoryData)
static CategoryService.AddFromBulkUploadCategoryBuilder	addFromBulkUpload(File fileData)
static CategoryService.AddFromBulkUploadCategoryBuilder	addFromBulkUpload(FileInputStream fileData, String fileDataMimeType, String fileDataName)
static CategoryService.AddFromBulkUploadCategoryBuilder	addFromBulkUpload(FileInputStream fileData, String fileDataMimeType, String fileDataName, BulkUploadJobData bulkUploadData)
static CategoryService.AddFromBulkUploadCategoryBuilder	addFromBulkUpload(FileInputStream fileData, String fileDataMimeType, String fileDataName, BulkUploadJobData bulkUploadData, BulkUploadCategoryData bulkUploadCategoryData)
static CategoryService.AddFromBulkUploadCategoryBuilder	addFromBulkUpload(File fileData, BulkUploadJobData bulkUploadData)
static CategoryService.AddFromBulkUploadCategoryBuilder	addFromBulkUpload(File fileData, BulkUploadJobData bulkUploadData, BulkUploadCategoryData bulkUploadCategoryData)
static CategoryService.AddFromBulkUploadCategoryBuilder	addFromBulkUpload(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize)
static CategoryService.AddFromBulkUploadCategoryBuilder	addFromBulkUpload(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize, BulkUploadJobData bulkUploadData)
static CategoryService.AddFromBulkUploadCategoryBuilder	addFromBulkUpload(InputStream fileData, String fileDataMimeType, String fileDataName, long fileDataSize, BulkUploadJobData bulkUploadData, BulkUploadCategoryData bulkUploadCategoryData)
static CategoryService.CloneCategoryBuilder	clone(int categoryId, int fromPartnerId)
static CategoryService.CloneCategoryBuilder	clone(int categoryId, int fromPartnerId, int parentCategoryId)	Clone Category
static CategoryService.DeleteCategoryBuilder	delete(long id)
static CategoryService.DeleteCategoryBuilder	delete(long id, Boolean moveEntriesToParentCategory)	Delete a Category
static CategoryService.ExportToCsvCategoryBuilder	exportToCsv()
static CategoryService.ExportToCsvCategoryBuilder	exportToCsv(CategoryFilter filter)
static CategoryService.ExportToCsvCategoryBuilder	exportToCsv(CategoryFilter filter, int metadataProfileId)
static CategoryService.ExportToCsvCategoryBuilder	exportToCsv(CategoryFilter filter, int metadataProfileId, List<CsvAdditionalFieldInfo> additionalFields)
static CategoryService.ExportToCsvCategoryBuilder	exportToCsv(CategoryFilter filter, int metadataProfileId, List<CsvAdditionalFieldInfo> additionalFields, List<KeyValue> mappedFields)
static CategoryService.ExportToCsvCategoryBuilder	exportToCsv(CategoryFilter filter, int metadataProfileId, List<CsvAdditionalFieldInfo> additionalFields, List<KeyValue> mappedFields, ExportToCsvOptions options)	Creates a batch job that sends an email with a link to download a CSV containing a list of categories
static CategoryService.GetCategoryBuilder	get(long id)	Get Category by id
static CategoryService.IndexCategoryBuilder	index(long id)
static CategoryService.IndexCategoryBuilder	index(long id, boolean shouldUpdate)	Index Category by id
static CategoryService.ListCategoryBuilder	list()
static CategoryService.ListCategoryBuilder	list(CategoryFilter filter)
static CategoryService.ListCategoryBuilder	list(CategoryFilter filter, FilterPager pager)	List all categories
static CategoryService.MoveCategoryBuilder	move(String categoryIds, int targetCategoryParentId)	Move categories that belong to the same parent category to a target category - enabled only for ks with disable entitlement
static CategoryService.UnlockCategoriesCategoryBuilder	unlockCategories()	Unlock categories
static CategoryService.UpdateCategoryBuilder	update(long id, Category category)	Update Category

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CategoryService

public CategoryService()

Method Detail

add

public static CategoryService.AddCategoryBuilder add(Category category)

Add new Category

Parameters:

category -

addFromBulkUpload

public static CategoryService.AddFromBulkUploadCategoryBuilder addFromBulkUpload(FileHolder fileData)

addFromBulkUpload

public static CategoryService.AddFromBulkUploadCategoryBuilder addFromBulkUpload(File fileData)

addFromBulkUpload

public static CategoryService.AddFromBulkUploadCategoryBuilder addFromBulkUpload(InputStream fileData,
                                                                                 String fileDataMimeType,
                                                                                 String fileDataName,
                                                                                 long fileDataSize)

addFromBulkUpload

public static CategoryService.AddFromBulkUploadCategoryBuilder addFromBulkUpload(FileInputStream fileData,
                                                                                 String fileDataMimeType,
                                                                                 String fileDataName)

addFromBulkUpload

public static CategoryService.AddFromBulkUploadCategoryBuilder addFromBulkUpload(FileHolder fileData,
                                                                                 BulkUploadJobData bulkUploadData)

addFromBulkUpload

public static CategoryService.AddFromBulkUploadCategoryBuilder addFromBulkUpload(File fileData,
                                                                                 BulkUploadJobData bulkUploadData)

addFromBulkUpload

public static CategoryService.AddFromBulkUploadCategoryBuilder addFromBulkUpload(InputStream fileData,
                                                                                 String fileDataMimeType,
                                                                                 String fileDataName,
                                                                                 long fileDataSize,
                                                                                 BulkUploadJobData bulkUploadData)

addFromBulkUpload

public static CategoryService.AddFromBulkUploadCategoryBuilder addFromBulkUpload(FileInputStream fileData,
                                                                                 String fileDataMimeType,
                                                                                 String fileDataName,
                                                                                 BulkUploadJobData bulkUploadData)

addFromBulkUpload

public static CategoryService.AddFromBulkUploadCategoryBuilder addFromBulkUpload(File fileData,
                                                                                 BulkUploadJobData bulkUploadData,
                                                                                 BulkUploadCategoryData bulkUploadCategoryData)

addFromBulkUpload

public static CategoryService.AddFromBulkUploadCategoryBuilder addFromBulkUpload(InputStream fileData,
                                                                                 String fileDataMimeType,
                                                                                 String fileDataName,
                                                                                 long fileDataSize,
                                                                                 BulkUploadJobData bulkUploadData,
                                                                                 BulkUploadCategoryData bulkUploadCategoryData)

addFromBulkUpload

public static CategoryService.AddFromBulkUploadCategoryBuilder addFromBulkUpload(FileInputStream fileData,
                                                                                 String fileDataMimeType,
                                                                                 String fileDataName,
                                                                                 BulkUploadJobData bulkUploadData,
                                                                                 BulkUploadCategoryData bulkUploadCategoryData)

addFromBulkUpload

public static CategoryService.AddFromBulkUploadCategoryBuilder addFromBulkUpload(FileHolder fileData,
                                                                                 BulkUploadJobData bulkUploadData,
                                                                                 BulkUploadCategoryData bulkUploadCategoryData)

clone

public static CategoryService.CloneCategoryBuilder clone(int categoryId,
                                                         int fromPartnerId)

clone

public static CategoryService.CloneCategoryBuilder clone(int categoryId,
                                                         int fromPartnerId,
                                                         int parentCategoryId)

Clone Category

Parameters:

categoryId -

fromPartnerId -

parentCategoryId -

delete

public static CategoryService.DeleteCategoryBuilder delete(long id)

delete

public static CategoryService.DeleteCategoryBuilder delete(long id,
                                                           Boolean moveEntriesToParentCategory)

Delete a Category

Parameters:

id -

moveEntriesToParentCategory -

exportToCsv

public static CategoryService.ExportToCsvCategoryBuilder exportToCsv()

exportToCsv

public static CategoryService.ExportToCsvCategoryBuilder exportToCsv(CategoryFilter filter)

exportToCsv

public static CategoryService.ExportToCsvCategoryBuilder exportToCsv(CategoryFilter filter,
                                                                     int metadataProfileId)

exportToCsv

public static CategoryService.ExportToCsvCategoryBuilder exportToCsv(CategoryFilter filter,
                                                                     int metadataProfileId,
                                                                     List<CsvAdditionalFieldInfo> additionalFields)

exportToCsv

public static CategoryService.ExportToCsvCategoryBuilder exportToCsv(CategoryFilter filter,
                                                                     int metadataProfileId,
                                                                     List<CsvAdditionalFieldInfo> additionalFields,
                                                                     List<KeyValue> mappedFields)

exportToCsv

public static CategoryService.ExportToCsvCategoryBuilder exportToCsv(CategoryFilter filter,
                                                                     int metadataProfileId,
                                                                     List<CsvAdditionalFieldInfo> additionalFields,
                                                                     List<KeyValue> mappedFields,
                                                                     ExportToCsvOptions options)

Creates a batch job that sends an email with a link to download a CSV containing a list of categories

Parameters:

filter - A filter used to exclude specific categories

metadataProfileId -

additionalFields -

mappedFields - mapping between field headline and its mapped value

options -

get

public static CategoryService.GetCategoryBuilder get(long id)

Get Category by id

Parameters:

id -

index

public static CategoryService.IndexCategoryBuilder index(long id)

index

public static CategoryService.IndexCategoryBuilder index(long id,
                                                         boolean shouldUpdate)

Index Category by id

Parameters:

id -

shouldUpdate -

list

public static CategoryService.ListCategoryBuilder list()

list

public static CategoryService.ListCategoryBuilder list(CategoryFilter filter)

list

public static CategoryService.ListCategoryBuilder list(CategoryFilter filter,
                                                       FilterPager pager)

List all categories

Parameters:

filter -

pager -

move

public static CategoryService.MoveCategoryBuilder move(String categoryIds,
                                                       int targetCategoryParentId)

Move categories that belong to the same parent category to a target category - enabled only for ks with disable entitlement

Parameters:

categoryIds -

targetCategoryParentId -

unlockCategories

public static CategoryService.UnlockCategoriesCategoryBuilder unlockCategories()

Unlock categories

update

public static CategoryService.UpdateCategoryBuilder update(long id,
                                                           Category category)

Update Category

Parameters:

id -

category -