public class GlossaryAuthorViewCategoryRESTServices extends BaseGlossaryAuthorView
instanceHandler, PAGE_OFFSET_DEFAULT_VALUE, PAGE_SIZE_DEFAULT_VALUE, restCallLogger| Constructor and Description |
|---|
GlossaryAuthorViewCategoryRESTServices()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
SubjectAreaOMASAPIResponse<Category> |
createCategory(String serverName,
String userId,
Category suppliedCategory)
Create a Category
|
SubjectAreaOMASAPIResponse<Category> |
deleteCategory(String serverName,
String userId,
String guid,
boolean isPurge)
Delete a Category instance
|
SubjectAreaOMASAPIResponse<Category> |
findCategory(String serverName,
String userId,
Date asOfTime,
String searchCriteria,
int offset,
int pageSize,
SequencingOrder sequencingOrder,
String sequencingProperty)
Find Category
|
SubjectAreaOMASAPIResponse<Category> |
getCategory(String serverName,
String userId,
String guid)
Get a category.
|
SubjectAreaOMASAPIResponse<Line> |
getCategoryRelationships(String serverName,
String userId,
String guid,
Date asOfTime,
int offset,
int pageSize,
SequencingOrder sequencingOrder,
String sequencingProperty)
Get Category relationships
|
SubjectAreaOMASAPIResponse<Category> |
restoreCategory(String serverName,
String userId,
String guid)
Restore a Category
|
SubjectAreaOMASAPIResponse<Category> |
updateCategory(String serverName,
String userId,
String guid,
Category category,
boolean isReplace)
Update a Category
|
getResponseForErrorpublic GlossaryAuthorViewCategoryRESTServices()
public SubjectAreaOMASAPIResponse<Category> createCategory(String serverName, String userId, Category suppliedCategory)
serverName - name of the local view server.userId - userId under which the request is performedsuppliedCategory - Category to createpublic SubjectAreaOMASAPIResponse<Category> getCategory(String serverName, String userId, String guid)
serverName - name of the local view server.userId - user identifierguid - guid of the category to getpublic SubjectAreaOMASAPIResponse<Category> findCategory(String serverName, String userId, Date asOfTime, String searchCriteria, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty)
serverName - name of the local view server.userId - user identifiersearchCriteria - String expression matching Category property values .asOfTime - the glossaries returned as they were at this time. null indicates at the current time.offset - the starting element number for this set of results. This is used when retrieving elements
beyond the first page of results. Zero means the results start from the first element.pageSize - the maximum number of elements that can be returned on this request.
0 means there is no limit to the page sizesequencingOrder - the sequencing order for the results.sequencingProperty - the name of the property that should be used to sequence the results.public SubjectAreaOMASAPIResponse<Line> getCategoryRelationships(String serverName, String userId, String guid, Date asOfTime, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty)
serverName - name of the local view server.userId - user identifierguid - guid of the category to getasOfTime - the relationships returned as they were at this time. null indicates at the current time. If specified, the date is in milliseconds since 1970-01-01 00:00:00.offset - the starting element number for this set of results. This is used when retrieving elements
beyond the first page of results. Zero means the results start from the first element.pageSize - the maximum number of elements that can be returned on this request.
0 means there is not limit to the page sizesequencingOrder - the sequencing order for the results.sequencingProperty - the name of the property that should be used to sequence the results.public SubjectAreaOMASAPIResponse<Category> updateCategory(String serverName, String userId, String guid, Category category, boolean isReplace)
Status is not updated using this call.
serverName - name of the local view server.userId - user identifierguid - guid of the category to updatecategory - category to updateisReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.public SubjectAreaOMASAPIResponse<Category> deleteCategory(String serverName, String userId, String guid, boolean isPurge)
The deletion of a category is only allowed if there is no category content (i.e. no categories or categories).
There are 2 types of deletion, a soft delete and a hard delete (also known as a purge). All repositories support hard deletes. Soft deletes support is optional. Soft delete is the default.
A soft delete means that the category instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete. A hard delete means that the category will not exist after the operation. when not successful the following Exceptions can occur
serverName - name of the local view server.userId - user identifierguid - guid of the category to be deleted.isPurge - true indicates a hard delete, false is a soft delete.public SubjectAreaOMASAPIResponse<Category> restoreCategory(String serverName, String userId, String guid)
Restore allows the deleted Category to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
serverName - name of the local view server.userId - user identifierguid - guid of the category to restoreCopyright © 2018–2020 ODPi. All rights reserved.