Package org.alfresco.rest.requests

Class Categories

java.lang.Object

org.alfresco.rest.requests.ModelRequest<Categories>

org.alfresco.rest.requests.Categories

public class Categories
extends ModelRequest<Categories>

Field Summary

Fields inherited from class org.alfresco.rest.requests.ModelRequest

restWrapper

Constructor Summary

Constructors

Constructor	Description
Categories(RestWrapper restWrapper, RestCategoryModel category)

Method Summary

Modifier and Type	Method	Description
RestCategoryModelsCollection	createCategoriesList(List<RestCategoryModel> restCategoryModels)	Create several categories in one request.
RestCategoryModel	createSingleCategory(RestCategoryModel restCategoryModel)	Create single category.
void	deleteCategory()	Delete category
RestCategoryModel	getCategory()	Retrieves a category with ID using GET call on "/categories/{categoryId}"
RestCategoryModelsCollection	getCategoryChildren()	Get parent category children.
RestCategoryModel	updateCategory(RestCategoryModel restCategoryModel)	Update single category

Methods inherited from class org.alfresco.rest.requests.ModelRequest

include, includePath, usingParams

Methods inherited from class java.lang.Object

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

Constructor Details

Categories

public Categories(RestWrapper restWrapper,
 RestCategoryModel category)

Method Details

getCategory

public RestCategoryModel getCategory()

Retrieves a category with ID using GET call on "/categories/{categoryId}"

Returns:

RestCategoryModel

createCategoriesList

public RestCategoryModelsCollection createCategoriesList(List<RestCategoryModel> restCategoryModels)

Create several categories in one request.

Parameters:

restCategoryModels - The list of categories to create.

Returns:

The list of created categories with additional data populated by the repository.

createSingleCategory

public RestCategoryModel createSingleCategory(RestCategoryModel restCategoryModel)

Create single category.

Parameters:

restCategoryModel - The category to create.

Returns:

Created category with additional data populated by the repository.

getCategoryChildren

public RestCategoryModelsCollection getCategoryChildren()

Get parent category children.

Returns:

The list of child categories.

updateCategory

public RestCategoryModel updateCategory(RestCategoryModel restCategoryModel)

Update single category. - PUT /categories/{categoryId}

Parameters:

restCategoryModel - The categories to update.

Returns:

Created category with additional data populated by the repository.

deleteCategory

public void deleteCategory()

Delete category. - DELETE /categories/{categoryId}