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 -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCreate a Category.void
Delete a Category.find
(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase) Extract children within a CategoryFind CategorygetAllRelationships
(String userId, String guid) Get a Category's relationshipsGet a Category.getCategoryChildren
(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase) Extract children within a Categoryprotected String
getMethodInfo
(String methodName) getRelationships
(String userId, String guid, FindRequest findRequest) Get a Category's relationshipsgetTerms
(String userId, String guid, FindRequest findRequest) Extract terms within a CategorygetTerms
(String userId, String guid, FindRequest findRequest, boolean exactValue, boolean ignoreCase, Integer maximumPageSizeOnRestCall) Class<? extends GenericResponse>
Restore a soft-deleted Category.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
-
-
Constructor Details
-
GlossaryAuthorViewCategoryClient
-
-
Method Details
-
getMethodInfo
-
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 interfaceGlossaryAuthorViewCategory
- Parameters:
userId
- userId under which the request is performedcategory
- 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 invalidUserNotAuthorizedException
- 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 interfaceGlossaryAuthorViewCategory
- Parameters:
userId
- userId under which the request is performedguid
- guid of Glossary object to be updatedcategory
- Glossary object with updated valuesisReplace
- 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 invalidUserNotAuthorizedException
- the requesting user is not authorized to issue this request.
-
delete
Description copied from interface:GlossaryAuthorViewCategory
Delete a Category.The result Void object
- Specified by:
delete
in interfaceGlossaryAuthorViewCategory
- Parameters:
userId
- userId under which the request is performedguid
- 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 interfaceGlossaryAuthorViewCategory
- Parameters:
userId
- userId under which the request is performedguid
- 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 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:GlossaryAuthorViewCategory
Extract children within a Category- Specified by:
getCategoryChildren
in interfaceGlossaryAuthorViewCategory
- 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<Category> findAll(String userId) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Description copied from interface:GlossaryAuthorViewCategory
Find Category- Specified by:
findAll
in interfaceGlossaryAuthorViewCategory
- 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 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 interfaceGlossaryAuthorViewCategory
- Parameters:
userId
- userId under which the request is performedguid
- guid of Category object to be retrieved- Returns:
- The requested Category
- 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<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 interfaceGlossaryAuthorViewCategory
- 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.
-
getRelationships
public List<Relationship> getRelationships(String userId, String guid, FindRequest findRequest) throws InvalidParameterException, PropertyServerException, UserNotAuthorizedException Description copied from interface:GlossaryAuthorViewCategory
Get a Category's relationshipsThe result is a list of Relationships
- Specified by:
getRelationships
in interfaceGlossaryAuthorViewCategory
- Parameters:
userId
- userId under which the request is performedguid
- guid of Category object to be retrievedfindRequest
- 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 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:GlossaryAuthorViewCategory
Get a Category's relationshipsThe result is a list of Relationships
- Specified by:
getAllRelationships
in interfaceGlossaryAuthorViewCategory
- Parameters:
userId
- userId under which the request is performedguid
- guid of Category object to be retrieved- Returns:
- The list of Category 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.
-
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 interfaceGlossaryAuthorViewCategory
- Parameters:
userId
- calling userguid
- Category GUIDfindRequest
- 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 invalidPropertyServerException
- 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 -
responseType
- Specified by:
responseType
in interfaceResponseParameterization<Category>
- Returns:
- the response class type inherited from
GenericResponse
-