Interface GlossaryAuthorViewProject
- All Known Implementing Classes:
GlossaryAuthorViewProjectClient
public interface GlossaryAuthorViewProject
-
Method Summary
Modifier and TypeMethodDescriptionCreate a project.void
Delete a Project.find
(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase) Extract children within a ProjectFind CategorygetAllRelationships
(String userId, String guid) Get a Project's relationshipsGet a Project.getCategories
(String userId, String projectGuid, FindRequest findRequest) Extract Categories within a ProjectgetCategoryChildren
(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 projectGuid, FindRequest findRequest) Extract relationships within a ProjectgetViewServiceConfigs
(String userId) Get list of view service config on the serverRestore a soft-deleted Project.Update a Project.
-
Method Details
-
create
Project create(String userId, Project project) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Create a project.The result is the project object
- Parameters:
userId
- userId under which the request is performedproject
- Project object to be created- Returns:
- The Project
- 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
Project getByGUID(String userId, String guid) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Get a Project.The result is the requested Project object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Project object to be retrieved- Returns:
- The requested Project
- 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
Project update(String userId, String guid, Project project, boolean isReplace) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException Update a Project.The result is the updated Glossary object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Glossary object to be updatedproject
- Glossary object with updated valuesisReplace
- If the object is to be replaced- Returns:
- The updated Project
- 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 Project.The result Void object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Project object to be retrieved- Throws:
PropertyServerException
- something went wrong with the REST call stack.
-
restore
Project restore(String userId, String guid) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Restore a soft-deleted Project.The result is the restored Project object
- Parameters:
userId
- userId under which the request is performedguid
- guid of Project object to be restored- Returns:
- The restored Project
- 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 Project's relationshipsThe result is a list of Relationships
- Parameters:
userId
- userId under which the request is performedguid
- guid of Project object to be retrieved- Returns:
- The list of Project 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<Project> 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<Project> find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase) throws PropertyServerException, UserNotAuthorizedException, InvalidParameterException Extract children within a Project- 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 projectGuid, FindRequest findRequest) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Extract Categories within a Project- Parameters:
userId
- calling userprojectGuid
- exactValue - when false values with trailing characters will match.findRequest
- 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
-
getRelationships
List<Relationship> getRelationships(String userId, String projectGuid, FindRequest findRequest) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Extract relationships within a Project- Parameters:
userId
- calling userprojectGuid
- exactValue - when false values with trailing characters will match.findRequest
- 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
-