Interface GlossaryAuthorViewCategory
- All Known Implementing Classes:
GlossaryAuthorViewCategoryClient
public interface GlossaryAuthorViewCategory
-
Method Summary
Modifier and TypeMethodDescriptionCreate a Category.void
Delete a Category.find
(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase) Extract children within a CategoryFind CategorygetAllRelationships
(String userId, String guid) Get a Category's relationshipsGet a Category.getCategoryChildren
(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase) Extract children within a CategorygetRelationships
(String userId, String guid, FindRequest findRequest) Get a Category's relationshipsgetTerms
(String userId, String categoryGuid, FindRequest findRequest) Extract terms within a CategoryRestore a soft-deleted Category.Update a Category.
-
Method Details
-
create
Category create(String userId, Category category) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Create a Category.The result is the Category object
- Parameters:
userId
- userId under which the request is performedcategory
- Glossary object to be created- Returns:
- The Category
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
getByGUID
Category getByGUID(String userId, String guid) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Get a Category.The result is the requested Category object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Category object to be retrieved- Returns:
- The requested Category
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
update
Category update(String userId, String guid, Category category, boolean isReplace) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException Update a Category.The result is the updated Glossary object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Glossary object to be updatedcategory
- Glossary object with updated valuesisReplace
- If the object is to be replaced- Returns:
- The updated Category
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
delete
Delete a Category.The result Void object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Category object to be retrieved- Throws:
PropertyServerException
- something went wrong with the REST call stack.
-
restore
Category restore(String userId, String guid) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Restore a soft-deleted Category.The result is the restored Category object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Category object to be restored- Returns:
- The restored Category
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
getRelationships
List<Relationship> getRelationships(String userId, String guid, FindRequest findRequest) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Get a Category's relationshipsThe result is a list of Relationships
- Parameters:
userId
- userId under which the request is performedguid
- guid of Category object to be retrievedfindRequest
- information object for find calls. This include pageSize to limit the number of elements returned.- Returns:
- The list of Category relationships
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
getAllRelationships
List<Relationship> getAllRelationships(String userId, String guid) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Get a Category's relationshipsThe result is a list of Relationships
- Parameters:
userId
- userId under which the request is performedguid
- guid of Category object to be retrieved- Returns:
- The list of Category relationships
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
getTerms
List<Term> getTerms(String userId, String categoryGuid, FindRequest findRequest) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Extract terms within a Category- Parameters:
userId
- calling usercategoryGuid
- Category GUIDfindRequest
- information object for find calls. This include pageSize to limit the number of elements returned.- Returns:
- list of terms
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
getCategoryChildren
List<Category> getCategoryChildren(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Extract children within a Category- Parameters:
userId
- calling userparentGuid
- Category GUIDfindRequest
- information object for find calls. This include pageSize to limit the number of elements returned.exactValue
- exactValue - when false values with trailing characters will match.ignoreCase
- ignore the case when matching.- Returns:
- list of Categories
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
findAll
List<Category> findAll(String userId) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Find Category- Parameters:
userId
- calling user- Returns:
- Categories belonging to Userid
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-
find
List<Category> find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Extract children within a Category- Parameters:
userId
- calling userfindRequest
- information object for find calls. This include pageSize to limit the number of elements returned.exactValue
- exactValue - when false values with trailing characters will match.ignoreCase
- ignore the case when matching.- Returns:
- list of Categories
- Throws:
PropertyServerException
- something went wrong with the REST call stack.UserNotAuthorizedException
- the requesting user is not authorized to issue this request.InvalidParameterException
- one of the parameters is null or invalid
-