Provides methods to create, update, delete and retrieve the categories. More...
Public Member Functions | |
CategoryIdentity | AddCategory (string sessionId, Category category) |
Adds a new category, and associated resources, with the specified details. More... | |
void | DeleteCategory (string sessionId, CategoryIdentity category) |
Deletes the specified category. More... | |
CategorySummaryCollection | GetCategories (string sessionId, CategoryFilter categoryFilter) |
Retrieves the list of categories for the specified search criteria. More... | |
Category | GetCategory (string sessionId, CategoryIdentity categoryIdentity) |
Retrieves the specified category. More... | |
CategorySummaryCollection | GetImmediateSubcategories (string sessionId, CategoryIdentity parentCategoryIdentity) |
Retrieves the immediate subcategories of the specified category. More... | |
bool | HasAccess (string sessionId, CategoryIdentity category) |
Determines whether the resource has access to a specified category. More... | |
void | UpdateCategory (string sessionId, Category category) |
Updates a category with the specified details More... | |
Provides methods to create, update, delete and retrieve the categories.
CategoryIdentity AddCategory | ( | string | sessionId, |
Category | category | ||
) |
Adds a new category, and associated resources, with the specified details.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||||||||||||||||||
category | A Category object containing the category information that needs to be added.
Details of ResourceAccess
|
Name | Type | Comment |
---|---|---|
Id | String | Id of the category |
Name | String | Name of the category |
void DeleteCategory | ( | string | sessionId, |
CategoryIdentity | category | ||
) |
Deletes the specified category.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
category | A CategoryIdentity object containing the category identity that needs to be deleted.
|
CategorySummaryCollection GetCategories | ( | string | sessionId, |
CategoryFilter | categoryFilter | ||
) |
Retrieves the list of categories for the specified search criteria.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
categoryFilter | A CategoryFilter object containing the search criteria to retrieve the categories.
|
Name | Type | Comment | Required |
---|---|---|---|
Identity | Identity | Id of the category | No |
Description | String | Text description of the category | No |
ParentCategory | Identity | Details of the category's parent category | No |
CategorySummaryCollection | Collection | A collection of CategorySummary that have this category marked as their parent category. | No |
true
Category GetCategory | ( | string | sessionId, |
CategoryIdentity | categoryIdentity | ||
) |
Retrieves the specified category.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
categoryIdentity | A CategoryIdentity object containing the category identity that needs to be retrieved.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Id of the category |
Description | String | Text description of the category |
ResourceAccess | Collection | List of resources with access to the category |
ParentCategory | Identity | Details of the category's parent category |
CategorySummaryCollection GetImmediateSubcategories | ( | string | sessionId, |
CategoryIdentity | parentCategoryIdentity | ||
) |
Retrieves the immediate subcategories of the specified category.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
parentCategoryIdentity | A Model.Categories.CategoryIdentity containing the unique identity of the parent category to retrieve its immediate sub categories.
|
Name | Type | Comment |
---|---|---|
Identity | Identity | Id of the category |
Description | String | Text description of the category |
ParentCategory | Identity | Details of the category's parent category |
CategorySummaryCollection | Collection | Not populated |
bool HasAccess | ( | string | sessionId, |
CategoryIdentity | category | ||
) |
Determines whether the resource has access to a specified category.
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||
category | Details of the Category to check.
|
true
if the resource has access to a specified category; otherwise, false
. void UpdateCategory | ( | string | sessionId, |
Category | category | ||
) |
Updates a category with the specified details
sessionId | A string that uniquely identifies the Session for the current logged on user. If the SessionId is invalid then an exception will be raised. | ||||||||||||||||||||
category | A Category object containing the category information that needs to be updated.
|