Interface GlossaryAuthorViewRelationships
-
- All Known Implementing Classes:
GlossaryAuthorViewRelationshipsClient
public interface GlossaryAuthorViewRelationships
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Relationshipcreate(String userId, Relationship relationship)Create a Relationship.voiddelete(String userId, String guid)Delete a Relationship.List<Relationship>find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase)Extract children within a RelationshipList<Relationship>findAll(String userId)Find CategoryRelationshipgetByGUID(String userId, String guid)Get a Relationship.List<Category>getCategories(String userId, String relationshipGuid, FindRequest findRequest)Extract categories for a RelationshipList<Category>getCategoryChildren(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase)Extract children within a CategoryOMAGServerConfiggetConfig(String userId)Get config for serverViewServiceConfiggetGlossaryAuthViewServiceConfig(String userId)Get service config for a particular view ServiceList<ViewServiceConfig>getViewServiceConfigs(String userId)Get list of view service config on the serverRelationshiprestore(String userId, String guid)Restore a soft-deleted Relationship.Relationshipupdate(String userId, String guid, Relationship relationship, boolean isReplace)Update a Relationship.
-
-
-
Method Detail
-
create
Relationship create(String userId, Relationship relationship) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException
Create a Relationship.The result is the Relationship object
- Parameters:
userId- userId under which the request is performedrelationship- Relationship object to be created- Returns:
- The Relationship
- 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
Relationship getByGUID(String userId, String guid) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException
Get a Relationship.The result is the requested Relationship object
- Parameters:
userId- userId under which the request is performedguid- guid of Relationship object to be retrieved- Returns:
- The requested Relationship
- 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
Relationship update(String userId, String guid, Relationship relationship, boolean isReplace) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException
Update a Relationship.The result is the updated Glossary object
- Parameters:
userId- userId under which the request is performedguid- guid of Glossary object to be updatedrelationship- Glossary object with updated valuesisReplace- If the object is to be replaced- Returns:
- The updated Relationship
- 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
void delete(String userId, String guid) throws PropertyServerException
Delete a Relationship.The result Void object
- Parameters:
userId- userId under which the request is performedguid- guid of Relationship object to be retrieved- Throws:
PropertyServerException- something went wrong with the REST call stack.
-
restore
Relationship restore(String userId, String guid) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException
Restore a soft-deleted Relationship.The result is the restored Relationship object
- Parameters:
userId- userId under which the request is performedguid- guid of Relationship object to be restored- Returns:
- The restored Relationship
- 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<Relationship> 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<Relationship> find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException
Extract children within a Relationship- 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 relationshipGuid, FindRequest findRequest) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Extract categories for a Relationship- Parameters:
userId- calling userrelationshipGuid- 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
-
-