Class GlossaryAuthorViewProjectClient
- java.lang.Object
-
- org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.project.GlossaryAuthorViewProjectClient
-
- All Implemented Interfaces:
ResponseParameterization<Project>,GlossaryAuthorViewProject
public class GlossaryAuthorViewProjectClient extends Object implements GlossaryAuthorViewProject, ResponseParameterization<Project>
The class acts as a wrapper class for calling the REST services for Glossary Author Project related services.
-
-
Field Summary
Fields Modifier and Type Field Description protected GlossaryAuthorViewRestClientclient
-
Constructor Summary
Constructors Constructor Description GlossaryAuthorViewProjectClient(GlossaryAuthorViewRestClient client)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Projectcreate(String userId, Project project)Create a project.voiddelete(String userId, String guid)Delete a Project.List<Project>find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase)Extract children within a ProjectList<Project>findAll(String userId)Find CategoryList<Relationship>getAllRelationships(String userId, String guid)Get a Project's relationshipsProjectgetByGUID(String userId, String guid)Get a Project.List<Category>getCategories(String userId, String projectGuid, FindRequest findRequest)Extract Categories within a ProjectList<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 Serviceprotected StringgetMethodInfo(String methodName)List<Relationship>getRelationships(String userId, String guid, FindRequest findRequest)Extract relationships within a ProjectList<ViewServiceConfig>getViewServiceConfigs(String userId)Get list of view service config on the serverClass<? extends GenericResponse>responseType()Projectrestore(String userId, String guid)Restore a soft-deleted Project.Projectupdate(String userId, String guid, Project project, boolean isReplace)Update a Project.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.odpi.openmetadata.commonservices.ffdc.rest.ResponseParameterization
getParameterizedType, resultType
-
-
-
-
Field Detail
-
client
protected final GlossaryAuthorViewRestClient client
-
-
Constructor Detail
-
GlossaryAuthorViewProjectClient
public GlossaryAuthorViewProjectClient(GlossaryAuthorViewRestClient client)
-
-
Method Detail
-
create
public Project create(String userId, Project project) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewProjectCreate a project.The result is the project object
- Specified by:
createin interfaceGlossaryAuthorViewProject- 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.InvalidParameterException- one of the parameters is null or invalidUserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
update
public Project update(String userId, String guid, Project project, boolean isReplace) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewProjectUpdate a Project.The result is the updated Glossary object
- Specified by:
updatein interfaceGlossaryAuthorViewProject- 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.InvalidParameterException- one of the parameters is null or invalidUserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
delete
public void delete(String userId, String guid) throws PropertyServerException
Description copied from interface:GlossaryAuthorViewProjectDelete a Project.The result Void object
- Specified by:
deletein interfaceGlossaryAuthorViewProject- 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
public Project restore(String userId, String guid) throws PropertyServerException, InvalidParameterException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewProjectRestore a soft-deleted Project.The result is the restored Project object
- Specified by:
restorein interfaceGlossaryAuthorViewProject- 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.InvalidParameterException- one of the parameters is null or invalidUserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
getCategoryChildren
public List<Category> getCategoryChildren(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewProjectExtract children within a Category- Specified by:
getCategoryChildrenin interfaceGlossaryAuthorViewProject- 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:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
findAll
public List<Project> findAll(String userId) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewProjectFind Category- Specified by:
findAllin interfaceGlossaryAuthorViewProject- Parameters:
userId- calling user- Returns:
- Categories belonging to Userid
- Throws:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
getByGUID
public Project getByGUID(String userId, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewProjectGet a Project.The result is the requested Project object
- Specified by:
getByGUIDin interfaceGlossaryAuthorViewProject- Parameters:
userId- userId under which the request is performedguid- guid of Project object to be retrieved- Returns:
- The requested Project
- Throws:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
find
public List<Project> find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewProjectExtract children within a Project- Specified by:
findin interfaceGlossaryAuthorViewProject- 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:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
getCategories
public List<Category> getCategories(String userId, String projectGuid, FindRequest findRequest) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewProjectExtract Categories within a Project- Specified by:
getCategoriesin interfaceGlossaryAuthorViewProject- 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:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
getConfig
public OMAGServerConfig getConfig(String userId) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewProjectGet config for server- Specified by:
getConfigin interfaceGlossaryAuthorViewProject- Parameters:
userId- calling user- Returns:
- Config for view server
- Throws:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
getGlossaryAuthViewServiceConfig
public ViewServiceConfig getGlossaryAuthViewServiceConfig(String userId) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewProjectGet service config for a particular view Service- Specified by:
getGlossaryAuthViewServiceConfigin interfaceGlossaryAuthorViewProject- Parameters:
userId- calling user- Returns:
- Config for view server
- Throws:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
getRelationships
public List<Relationship> getRelationships(String userId, String guid, FindRequest findRequest) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewProjectExtract relationships within a Project- Specified by:
getRelationshipsin interfaceGlossaryAuthorViewProject- Parameters:
userId- calling userguid- 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:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
getViewServiceConfigs
public List<ViewServiceConfig> getViewServiceConfigs(String userId) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewProjectGet list of view service config on the server- Specified by:
getViewServiceConfigsin interfaceGlossaryAuthorViewProject- Parameters:
userId- calling user- Returns:
- Config for view server
- Throws:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
getAllRelationships
public List<Relationship> getAllRelationships(String userId, String guid) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException
Description copied from interface:GlossaryAuthorViewProjectGet a Project's relationshipsThe result is a list of Relationships
- Specified by:
getAllRelationshipsin interfaceGlossaryAuthorViewProject- Parameters:
userId- userId under which the request is performedguid- guid of Project object to be retrieved- Returns:
- The list of Project relationships
- Throws:
InvalidParameterException- one of the parameters is null or invalidPropertyServerException- something went wrong with the REST call stack.UserNotAuthorizedException- the requesting user is not authorized to issue this request.
-
responseType
public Class<? extends GenericResponse> responseType()
- Specified by:
responseTypein interfaceResponseParameterization<Project>
-
-