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

Class GlossaryAuthorViewCategoryClient

java.lang.Object

org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.category.GlossaryAuthorViewCategoryClient

All Implemented Interfaces:

ResponseParameterization<Category>, GlossaryAuthorViewCategory

public class GlossaryAuthorViewCategoryClient
extends Object
implements GlossaryAuthorViewCategory, ResponseParameterization<Category>

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final GlossaryAuthorViewRestClient	client

Constructor Summary

Constructors

Constructor	Description
GlossaryAuthorViewCategoryClient(GlossaryAuthorViewRestClient client)

Method Summary

Modifier and Type	Method	Description
Category	create(String userId, Category category)	Create a Category.
void	delete(String userId, String guid)	Delete a Category.
List<Category>	find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Extract children within a Category
List<Category>	findAll(String userId)	Find Category
List<Relationship>	getAllRelationships(String userId, String guid)	Get a Category's relationships
Category	getByGUID(String userId, String guid)	Get a Category.
List<Category>	getCategoryChildren(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Extract children within a Category
protected String	getMethodInfo(String methodName)
List<Relationship>	getRelationships(String userId, String guid, FindRequest findRequest)	Get a Category's relationships
List<Term>	getTerms(String userId, String guid, FindRequest findRequest)	Extract terms within a Category
List<Term>	getTerms(String userId, String guid, FindRequest findRequest, boolean exactValue, boolean ignoreCase, Integer maximumPageSizeOnRestCall)
Class<? extends GenericResponse>	responseType()
Category	restore(String userId, String guid)	Restore a soft-deleted Category.
Category	update(String userId, String guid, Category category, boolean isReplace)	Update a Category.

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 Details

client

protected final GlossaryAuthorViewRestClient client

Constructor Details

GlossaryAuthorViewCategoryClient

public GlossaryAuthorViewCategoryClient(GlossaryAuthorViewRestClient client)

Method Details

getMethodInfo

protected String getMethodInfo(String methodName)

create

public Category create(String userId,
 Category category)
                throws PropertyServerException,
InvalidParameterException,
UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewCategory

Create a Category.

The result is the Category object

Specified by:

create in interface GlossaryAuthorViewCategory

Parameters:

userId - userId under which the request is performed

category - Glossary object to be created

Returns:

The Category

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 Category update(String userId,
 String guid,
 Category category,
 boolean isReplace)
                throws PropertyServerException,
InvalidParameterException,
UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewCategory

Update a Category.

The result is the updated Glossary object

Specified by:

update in interface GlossaryAuthorViewCategory

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be updated

category - Glossary object with updated values

isReplace - If the object is to be replaced

Returns:

The updated Category

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

Delete a Category.

The result Void object

Specified by:

delete in interface GlossaryAuthorViewCategory

Parameters:

userId - userId under which the request is performed

guid - guid of Category object to be retrieved

Throws:

PropertyServerException - something went wrong with the REST call stack.

restore

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

Description copied from interface: GlossaryAuthorViewCategory

Restore a soft-deleted Category.

The result is the restored Category object

Specified by:

restore in interface GlossaryAuthorViewCategory

Parameters:

userId - userId under which the request is performed

guid - guid of Category object to be restored

Returns:

The restored Category

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

Extract children within a Category

Specified by:

getCategoryChildren in interface GlossaryAuthorViewCategory

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<Category> findAll(String userId)
                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewCategory

Find Category

Specified by:

findAll in interface GlossaryAuthorViewCategory

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 Category getByGUID(String userId,
 String guid)
                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewCategory

Get a Category.

The result is the requested Category object

Specified by:

getByGUID in interface GlossaryAuthorViewCategory

Parameters:

userId - userId under which the request is performed

guid - guid of Category object to be retrieved

Returns:

The requested Category

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<Category> find(String userId,
 FindRequest findRequest,
 boolean exactValue,
 boolean ignoreCase)
                    throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Description copied from interface: GlossaryAuthorViewCategory

Extract children within a Category

Specified by:

find in interface GlossaryAuthorViewCategory

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.

getRelationships

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

Description copied from interface: GlossaryAuthorViewCategory

Get a Category's relationships

The result is a list of Relationships

Specified by:

getRelationships in interface GlossaryAuthorViewCategory

Parameters:

userId - userId under which the request is performed

guid - guid of Category object to be retrieved

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

Returns:

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

getAllRelationships

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

Description copied from interface: GlossaryAuthorViewCategory

Get a Category's relationships

The result is a list of Relationships

Specified by:

getAllRelationships in interface GlossaryAuthorViewCategory

Parameters:

userId - userId under which the request is performed

guid - guid of Category object to be retrieved

Returns:

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

getTerms

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

Description copied from interface: GlossaryAuthorViewCategory

Extract terms within a Category

Specified by:

getTerms in interface GlossaryAuthorViewCategory

Parameters:

userId - calling user

guid - Category 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.

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

responseType

public Class<? extends GenericResponse> responseType()

Specified by:

responseType in interface ResponseParameterization<Category>

Returns:

the response class type inherited from GenericResponse