org.odpi.openmetadata.viewservices.glossaryauthor.handlers

Class CategoryHandler

java.lang.Object

org.odpi.openmetadata.viewservices.glossaryauthor.handlers.CategoryHandler

public class CategoryHandler
extends Object

The category handler is initialised with a SubjectAreaCategory, that contains the server the call should be sent to. The handler exposes methods for category functionality for the glossary author view

Constructor Summary

Constructors

Constructor and Description
CategoryHandler(SubjectAreaCategory subjectAreaCategory) Constructor for the CategoryHandler

Method Summary

Modifier and Type	Method and Description
Category	createCategory(String userId, Category suppliedCategory) Create a Category
void	deleteCategory(String userId, String guid) Delete a Category instance
List<Category>	findCategory(String userId, FindRequest findRequest) Find Category
Category	getCategoryByGuid(String userId, String guid) Get a category by guid.
List<Line>	getCategoryRelationships(String userId, String guid, FindRequest findRequest) Get Category relationships
void	purgeCategory(String userId, String guid) Purge a Category instance
Category	replaceCategory(String userId, String guid, Category suppliedCategory) Replace a Category.
Category	restoreCategory(String userId, String guid) Restore a Category
Category	updateCategory(String userId, String guid, Category suppliedCategory) Update a Category.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CategoryHandler

public CategoryHandler(SubjectAreaCategory subjectAreaCategory)

Constructor for the CategoryHandler

Parameters:

subjectAreaCategory - The SubjectAreaDefinition Open Metadata Access Service (OMAS) API for categories. This is the same as the The Glossary author Open Metadata View Service (OMVS) API for categories.

Method Detail

createCategory

public Category createCategory(String userId,
                               Category suppliedCategory)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Create a Category

Parameters:

userId - userId under which the request is performed

suppliedCategory - Category to create

Returns:

the created category.

Exceptions returned by the server

Throws:

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

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

getCategoryByGuid

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

Get a category by guid.

Parameters:

userId - userId under which the request is performed

guid - guid of the category to get

Returns:

the requested category.

Exceptions returned by the server

Throws:

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

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

findCategory

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

Find Category

Parameters:

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

findRequest - FindRequest

Returns:

A list of Categorys meeting the search Criteria

Exceptions returned by the server

Throws:

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

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

replaceCategory

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

Replace a Category. This means to override all the existing attributes with the supplied attributes.

Status is not updated using this call. The GovernanceAction content if specified replaces what is on the server.

Parameters:

userId - userId under which the request is performed

guid - guid of the category to update

suppliedCategory - category to be updated

Returns:

replaced category

Throws:

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

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

updateCategory

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

Update a Category. This means to update the category with any non-null attributes from the supplied category.

Status is not updated using this call. The GovernanceAction content if specified replaces what is on the server.

Parameters:

userId - userId under which the request is performed

guid - guid of the category to update

suppliedCategory - category to be updated

Returns:

a response which when successful contains the updated category when not successful the following Exceptions can occur

Throws:

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

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

deleteCategory

public void deleteCategory(String userId,
                           String guid)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Delete a Category instance

A delete (also known as a soft delete) means that the category instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.

Parameters:

userId - userId under which the request is performed

guid - guid of the category to be deleted. Exceptions returned by the server

Throws:

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

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

purgeCategory

public void purgeCategory(String userId,
                          String guid)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Purge a Category instance

A purge means that the category will not exist after the operation.

Parameters:

userId - userId under which the request is performed

guid - guid of the category to be deleted.

Throws:

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

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

restoreCategory

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

Restore a Category

Restore allows the deleted Category to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

Parameters:

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

guid - guid of the category to restore

Returns:

the restored category

Throws:

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

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

getCategoryRelationships

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

Get Category relationships

Parameters:

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

guid - guid of the category to get

findRequest - FindRequest

Returns:

the relationships associated with the requested Category guid

Exceptions returned by the server

Throws:

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

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception