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

Class GlossaryAuthorViewGlossaryClient

java.lang.Object

org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.glossarys.GlossaryAuthorViewGlossaryClient

All Implemented Interfaces:

ResponseParameterization<Glossary>, GlossaryAuthorViewGlossary

public class GlossaryAuthorViewGlossaryClient
extends Object
implements GlossaryAuthorViewGlossary, ResponseParameterization<Glossary>

The class acts as a wrapper class for calling the REST services for Glossary Author Glossary related services.

Field Summary

Fields

Modifier and Type	Field	Description
protected GlossaryAuthorViewRestClient	client

Constructor Summary

Constructors

Constructor	Description
GlossaryAuthorViewGlossaryClient(String serverName, String url)
GlossaryAuthorViewGlossaryClient(GlossaryAuthorViewRestClient client)

Method Summary

Modifier and Type	Method	Description
Glossary	create(String userId, Glossary glossary)	Create a Glossary.
List<Term>	createTerms(String userId, String guid, Term[] termArray)	Create multiple terms within a glossary
void	delete(String userId, String guid)	Delete a Glossary.
List<Glossary>	find(String userId, FindRequest findRequest)
List<Glossary>	find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase)
List<Glossary>	find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase, Integer maximumPageSizeOnRestCall)
List<Relationship>	getAllRelationships(String userId, String guid)	Get a Glossary's relationships
Glossary	getByGUID(String userId, String guid)	Get a Glossary.
List<Category>	getCategories(String userId, String guid, FindRequest findRequest)	Get the Categories owned by this glossary.
List<Category>	getCategories(String userId, String guid, FindRequest findRequest, boolean onlyTop)	Get the Categories owned by this glossary.
protected String	getMethodInfo(String methodName)
List<Term>	getTerms(String userId, String guid, FindRequest findRequest)	Extract terms within a glossary
List<Term>	getTerms(String userId, String guid, FindRequest findRequest, boolean exactValue, boolean ignoreCase, Integer maximumPageSizeOnRestCall)
Class<? extends GenericResponse>	responseType()
Glossary	restore(String userId, String guid)	Restore a soft-deleted Glossary.
Glossary	update(String userId, String guid, Glossary glossary, boolean isReplace)	Update a Glossary.

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

GlossaryAuthorViewGlossaryClient

public GlossaryAuthorViewGlossaryClient(GlossaryAuthorViewRestClient client)

GlossaryAuthorViewGlossaryClient

public GlossaryAuthorViewGlossaryClient(String serverName,
                                        String url)
                                 throws InvalidParameterException

Throws:

InvalidParameterException

Method Detail

find

public List<Glossary> find(String userId,
                           FindRequest findRequest)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Throws:

InvalidParameterException

PropertyServerException

UserNotAuthorizedException

find

public List<Glossary> find(String userId,
                           FindRequest findRequest,
                           boolean exactValue,
                           boolean ignoreCase)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Throws:

InvalidParameterException

PropertyServerException

UserNotAuthorizedException

find

public List<Glossary> find(String userId,
                           FindRequest findRequest,
                           boolean exactValue,
                           boolean ignoreCase,
                           Integer maximumPageSizeOnRestCall)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Throws:

InvalidParameterException

PropertyServerException

UserNotAuthorizedException

responseType

public Class<? extends GenericResponse> responseType()

Specified by:

responseType in interface ResponseParameterization<Glossary>

create

public Glossary create(String userId,
                       Glossary glossary)
                throws InvalidParameterException,
                       PropertyServerException,
                       UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewGlossary

Create a Glossary.

The result is the Glossary object

Specified by:

create in interface GlossaryAuthorViewGlossary

Parameters:

userId - userId under which the request is performed

glossary - Glossary object to be created

Returns:

The Glossary

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.

update

public Glossary update(String userId,
                       String guid,
                       Glossary glossary,
                       boolean isReplace)
                throws PropertyServerException,
                       InvalidParameterException,
                       UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewGlossary

Update a Glossary.

The result is the updated Glossary object

Specified by:

update in interface GlossaryAuthorViewGlossary

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be updated

glossary - Glossary object with updated values

isReplace - To replace existing Glossary or not

Returns:

The updated Glossary

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.

getByGUID

public Glossary getByGUID(String userId,
                          String guid)
                   throws InvalidParameterException,
                          PropertyServerException,
                          UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewGlossary

Get a Glossary.

The result is the requested Glossary object

Specified by:

getByGUID in interface GlossaryAuthorViewGlossary

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be retrieved

Returns:

The requested Glossary

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.

delete

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

Description copied from interface: GlossaryAuthorViewGlossary

Delete a Glossary.

The result Void object

Specified by:

delete in interface GlossaryAuthorViewGlossary

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be retrieved

Throws:

PropertyServerException - something went wrong with the REST call stack.

restore

public Glossary restore(String userId,
                        String guid)
                 throws PropertyServerException,
                        InvalidParameterException,
                        UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewGlossary

Restore a soft-deleted Glossary.

The result is the restored Glossary object

Specified by:

restore in interface GlossaryAuthorViewGlossary

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be restored

Returns:

The restored Glossary

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.

getAllRelationships

public List<Relationship> getAllRelationships(String userId,
                                              String guid)
                                       throws InvalidParameterException,
                                              PropertyServerException,
                                              UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewGlossary

Get a Glossary's relationships

The result is a list of Relationships

Specified by:

getAllRelationships in interface GlossaryAuthorViewGlossary

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be retrieved

Returns:

The list of Glossary 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.

getCategories

public List<Category> getCategories(String userId,
                                    String guid,
                                    FindRequest findRequest,
                                    boolean onlyTop)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewGlossary

Get the Categories owned by this glossary.

Specified by:

getCategories in interface GlossaryAuthorViewGlossary

Parameters:

userId - unique identifier for requesting user, under which the request is performed.

guid - unique identifier of the object to which the found objects should relate.

findRequest - information object for find calls. This include pageSize to limit the number of elements returned.

onlyTop - when only the top categories (those categories without parents) are 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.

getCategories

public List<Category> getCategories(String userId,
                                    String guid,
                                    FindRequest findRequest)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewGlossary

Get the Categories owned by this glossary.

Specified by:

getCategories in interface GlossaryAuthorViewGlossary

Parameters:

userId - unique identifier for requesting user, under which the request is performed.

guid - unique identifier of the object to which the found objects should relate.

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.

getTerms

public List<Term> getTerms(String userId,
                           String guid,
                           FindRequest findRequest)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewGlossary

Extract terms within a glossary

Specified by:

getTerms in interface GlossaryAuthorViewGlossary

Parameters:

userId - calling user

guid - glossary GUID

findRequest - information object for find calls. This include pageSize to limit the number of elements returned.

Returns:

list of terms

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.

createTerms

public List<Term> createTerms(String userId,
                              String guid,
                              Term[] termArray)
                       throws PropertyServerException,
                              InvalidParameterException,
                              UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewGlossary

Create multiple terms within a glossary

Specified by:

createTerms in interface GlossaryAuthorViewGlossary

Parameters:

userId - calling user

guid - glossary GUID

termArray - array of glossary objects that are to be created.

Returns:

list of terms created

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.

getTerms

public List<Term> getTerms(String userId,
                           String guid,
                           FindRequest findRequest,
                           boolean exactValue,
                           boolean ignoreCase,
                           Integer maximumPageSizeOnRestCall)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Throws:

InvalidParameterException

PropertyServerException

UserNotAuthorizedException

getMethodInfo

protected String getMethodInfo(String methodName)