Interface GlossaryAuthorViewSubjectAreaDefinitionCategory
- All Known Implementing Classes:
GlossaryAuthorViewSubjectAreaDefinitionCategoryClient
public interface GlossaryAuthorViewSubjectAreaDefinitionCategory
-
Method Summary
Modifier and TypeMethodDescriptioncreate
(String userId, SubjectAreaDefinition subjectAreaDefinition) Create a subjectAreaDefinition.void
Delete a SubjectAreaDefinition.find
(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase) Extract children within a SubjectAreaDefinitionFind CategoryGet a SubjectAreaDefinition.getCategories
(String userId, String subjectAreaDefinitionGuid, FindRequest findRequest) Extract categories for a SubjectAreaDefinitiongetCategoryChildren
(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase) Extract children within a CategoryGet config for serverGet service config for a particular view ServicegetViewServiceConfigs
(String userId) Get list of view service config on the serverRestore a soft-deleted SubjectAreaDefinition.update
(String userId, String guid, SubjectAreaDefinition subjectAreaDefinition, boolean isReplace) Update a SubjectAreaDefinition.
-
Method Details
-
create
SubjectAreaDefinition create(String userId, SubjectAreaDefinition subjectAreaDefinition) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Create a subjectAreaDefinition.The result is the subjectAreaDefinition object
- Parameters:
userId
- userId under which the request is performedsubjectAreaDefinition
- SubjectAreaDefinition object to be created- Returns:
- The SubjectAreaDefinition
- 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
SubjectAreaDefinition getByGUID(String userId, String guid) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Get a SubjectAreaDefinition.The result is the requested SubjectAreaDefinition object
- Parameters:
userId
- userId under which the request is performedguid
- guid of SubjectAreaDefinition object to be retrieved- Returns:
- The requested SubjectAreaDefinition
- 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
SubjectAreaDefinition update(String userId, String guid, SubjectAreaDefinition subjectAreaDefinition, boolean isReplace) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException Update a SubjectAreaDefinition.The result is the updated Glossary object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Glossary object to be updatedsubjectAreaDefinition
- Glossary object with updated valuesisReplace
- If the object is to be replaced- Returns:
- The updated SubjectAreaDefinition
- 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 SubjectAreaDefinition.The result Void object
- Parameters:
userId
- userId under which the request is performedguid
- guid of SubjectAreaDefinition object to be retrieved- Throws:
PropertyServerException
- something went wrong with the REST call stack.
-
restore
SubjectAreaDefinition restore(String userId, String guid) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Restore a soft-deleted SubjectAreaDefinition.The result is the restored SubjectAreaDefinition object
- Parameters:
userId
- userId under which the request is performedguid
- guid of SubjectAreaDefinition object to be restored- Returns:
- The restored SubjectAreaDefinition
- 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<SubjectAreaDefinition> 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<SubjectAreaDefinition> find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Extract children within a SubjectAreaDefinition- 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
-
getCategories
List<Category> getCategories(String userId, String subjectAreaDefinitionGuid, FindRequest findRequest) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Extract categories for a SubjectAreaDefinition- Parameters:
userId
- calling usersubjectAreaDefinitionGuid
- RelationShip GUIDfindRequest
- information object for find calls. This include pageSize to limit the number of elements returned.- 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
-
getConfig
OMAGServerConfig getConfig(String userId) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Get config for server- Parameters:
userId
- calling user- Returns:
- Config for view server
- 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
-
getViewServiceConfigs
List<ViewServiceConfig> getViewServiceConfigs(String userId) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Get list of view service config on the server- Parameters:
userId
- calling user- Returns:
- Config for view server
- 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
-
getGlossaryAuthViewServiceConfig
ViewServiceConfig getGlossaryAuthViewServiceConfig(String userId) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Get service config for a particular view Service- Parameters:
userId
- calling user- Returns:
- Config for view server
- 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
-