Interface GlossaryAuthorViewTerm
- All Known Implementing Classes:
GlossaryAuthorViewTermClient
public interface GlossaryAuthorViewTerm
-
Method Summary
Modifier and TypeMethodDescriptionCreate a Term.void
Delete a Term.find
(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase) Extract children within a TermFind TermsgetAllRelationships
(String userId, String guid) Get a Term's relationshipsGet a Term.getCategories
(String userId, String termGuid, FindRequest findRequest) Extract Categories for a termgetCategoryChildren
(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase) Extract children within a CategoryGet config for serverGet service config for a particular view ServicegetRelationships
(String userId, String termGuid, FindRequest findRequest) Extract Relationships for a termgetViewServiceConfigs
(String userId) Get list of view service config on the serverRestore a soft-deleted Term.Update a Term.Update a Term.
-
Method Details
-
create
Term create(String userId, Term term) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Create a Term.The result is the Term object
- Parameters:
userId
- userId under which the request is performedterm
- Term object to be created- Returns:
- The Term
- 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
Term getByGUID(String userId, String guid) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Get a Term.The result is the requested Term object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Term object to be retrieved- Returns:
- The requested Term
- 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
Term update(String userId, String guid, Term term, boolean isReplace) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException Update a Term.The result is the updated Glossary object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Glossary object to be updatedterm
- Glossary object with updated valuesisReplace
- If the object is to be replaced- Returns:
- The updated Term
- 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
Term update(String userId, String guid, Term term) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException Update a Term.The result is the updated Glossary object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Glossary object to be updatedterm
- Glossary object with updated values- Returns:
- The updated Term
- 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 Term.The result Void object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Term object to be retrieved- Throws:
PropertyServerException
- something went wrong with the REST call stack.
-
restore
Term restore(String userId, String guid) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Restore a soft-deleted Term.The result is the restored Term object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Term object to be restored- Returns:
- The restored Term
- 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 Term's relationshipsThe result is a list of Relationships
- Parameters:
userId
- userId under which the request is performedguid
- guid of Term object to be retrieved- Returns:
- The list of Term 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
-
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<Term> findAll(String userId) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Find Terms- 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<Term> find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Extract children within a Term- 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 termGuid, FindRequest findRequest) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Extract Categories for a term- Parameters:
userId
- calling usertermGuid
- GUID for the termfindRequest
- information object for find calls. This include pageSize to limit the number of elements returned.- Returns:
- list of 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
-
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
-
getRelationships
List<Relationship> getRelationships(String userId, String termGuid, FindRequest findRequest) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Extract Relationships for a term- Parameters:
userId
- calling usertermGuid
- GUID for the termfindRequest
- information object for find calls. This include pageSize to limit the number of elements returned.- Returns:
- list of 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
-