Package org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.project

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 GlossaryAuthorViewRestClient	client

Constructor Summary

Constructors

Constructor	Description
GlossaryAuthorViewProjectClient(GlossaryAuthorViewRestClient client)

Method Summary

Modifier and Type	Method	Description
Project	create(String userId, Project project)	Create a project.
void	delete(String userId, String guid)	Delete a Project.
List<Project>	find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Extract children within a Project
List<Project>	findAll(String userId)	Find Category
List<Relationship>	getAllRelationships(String userId, String guid)	Get a Project's relationships
Project	getByGUID(String userId, String guid)	Get a Project.
List<Category>	getCategories(String userId, String projectGuid, FindRequest findRequest)	Extract Categories within a Project
List<Category>	getCategoryChildren(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Extract children within a Category
OMAGServerConfig	getConfig(String userId)	Get config for server
ViewServiceConfig	getGlossaryAuthViewServiceConfig(String userId)	Get service config for a particular view Service
protected String	getMethodInfo(String methodName)
List<Relationship>	getRelationships(String userId, String guid, FindRequest findRequest)	Extract relationships within a Project
List<ViewServiceConfig>	getViewServiceConfigs(String userId)	Get list of view service config on the server
Class<? extends GenericResponse>	responseType()
Project	restore(String userId, String guid)	Restore a soft-deleted Project.
Project	update(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

getMethodInfo

protected String getMethodInfo(String methodName)

create

public Project create(String userId,
                      Project project)
               throws PropertyServerException,
                      InvalidParameterException,
                      UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewProject

Create a project.

The result is the project object

Specified by:

create in interface GlossaryAuthorViewProject

Parameters:

userId - userId under which the request is performed

project - 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 invalid

UserNotAuthorizedException - 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: GlossaryAuthorViewProject

Update a Project.

The result is the updated Glossary object

Specified by:

update in interface GlossaryAuthorViewProject

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be updated

project - Glossary object with updated values

isReplace - 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 invalid

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

delete

public void delete(String userId,
                   String guid)
            throws PropertyServerException

Description copied from interface: GlossaryAuthorViewProject

Delete a Project.

The result Void object

Specified by:

delete in interface GlossaryAuthorViewProject

Parameters:

userId - userId under which the request is performed

guid - 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: GlossaryAuthorViewProject

Restore a soft-deleted Project.

The result is the restored Project object

Specified by:

restore in interface GlossaryAuthorViewProject

Parameters:

userId - userId under which the request is performed

guid - 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 invalid

UserNotAuthorizedException - 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: GlossaryAuthorViewProject

Extract children within a Category

Specified by:

getCategoryChildren in interface GlossaryAuthorViewProject

Parameters:

userId - calling user

parentGuid - Category GUID

findRequest - 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 invalid

PropertyServerException - 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: GlossaryAuthorViewProject

Find Category

Specified by:

findAll in interface GlossaryAuthorViewProject

Parameters:

userId - calling user

Returns:

Categories belonging to Userid

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - 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: GlossaryAuthorViewProject

Get a Project.

The result is the requested Project object

Specified by:

getByGUID in interface GlossaryAuthorViewProject

Parameters:

userId - userId under which the request is performed

guid - guid of Project object to be retrieved

Returns:

The requested Project

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - 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: GlossaryAuthorViewProject

Extract children within a Project

Specified by:

find in interface GlossaryAuthorViewProject

Parameters:

userId - calling user

findRequest - 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 invalid

PropertyServerException - 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: GlossaryAuthorViewProject

Extract Categories within a Project

Specified by:

getCategories in interface GlossaryAuthorViewProject

Parameters:

userId - calling user

projectGuid - 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 invalid

PropertyServerException - 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: GlossaryAuthorViewProject

Get config for server

Specified by:

getConfig in interface GlossaryAuthorViewProject

Parameters:

userId - calling user

Returns:

Config for view server

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - 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: GlossaryAuthorViewProject

Get service config for a particular view Service

Specified by:

getGlossaryAuthViewServiceConfig in interface GlossaryAuthorViewProject

Parameters:

userId - calling user

Returns:

Config for view server

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - 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: GlossaryAuthorViewProject

Extract relationships within a Project

Specified by:

getRelationships in interface GlossaryAuthorViewProject

Parameters:

userId - calling user

guid - 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 invalid

PropertyServerException - 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: GlossaryAuthorViewProject

Get list of view service config on the server

Specified by:

getViewServiceConfigs in interface GlossaryAuthorViewProject

Parameters:

userId - calling user

Returns:

Config for view server

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - 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: GlossaryAuthorViewProject

Get a Project's relationships

The result is a list of Relationships

Specified by:

getAllRelationships in interface GlossaryAuthorViewProject

Parameters:

userId - userId under which the request is performed

guid - guid of Project object to be retrieved

Returns:

The list of Project relationships

Throws:

InvalidParameterException - one of the parameters is null or invalid

PropertyServerException - 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:

responseType in interface ResponseParameterization<Project>