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
Category	deleteCategory(String userId, String guid) 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.
List<Category>	findCategory(String userId, String searchCriteria, Date asOfTime, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Find Category
Category	getCategoryByGuid(String userId, String guid) Get a category by guid.
List<Line>	getCategoryRelationships(String userId, String guid, Date asOfTime, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Get Category relationships
void	purgeCategory(String userId, String guid) Purge a Category instance A purge means that the category will not exist after the operation.
Category	replaceCategory(String userId, String guid, Category suppliedCategory) Replace a Category.
Category	restoreCategory(String userId, String guid) Restore a Category Restore allows the deleted Category to be made active again.
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 MetadataServerUncontactableException,
                               ClassificationException,
                               FunctionNotSupportedException,
                               UnexpectedResponseException,
                               InvalidParameterException,
                               UserNotAuthorizedException,
                               UnrecognizedGUIDException

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.

ClassificationException - Error processing a classification

FunctionNotSupportedException - Function not supported

UnrecognizedGUIDException - Unrecognised GUID Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getCategoryByGuid

public Category getCategoryByGuid(String userId,
                                  String guid)
                           throws MetadataServerUncontactableException,
                                  FunctionNotSupportedException,
                                  UnexpectedResponseException,
                                  InvalidParameterException,
                                  UserNotAuthorizedException,
                                  UnrecognizedGUIDException

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.

FunctionNotSupportedException - Function not supported

UnrecognizedGUIDException - unrecognised GUID Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

findCategory

public List<Category> findCategory(String userId,
                                   String searchCriteria,
                                   Date asOfTime,
                                   int offset,
                                   int pageSize,
                                   SequencingOrder sequencingOrder,
                                   String sequencingProperty)
                            throws MetadataServerUncontactableException,
                                   FunctionNotSupportedException,
                                   UnexpectedResponseException,
                                   InvalidParameterException,
                                   UserNotAuthorizedException

Find Category

Parameters:

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

searchCriteria - String expression matching Category property values (this does not include the CategorySummary content).

asOfTime - the relationships returned as they were at this time. null indicates at the current time.

offset - the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.

pageSize - the maximum number of elements that can be returned on this request. 0 means there is no limit to the page size

sequencingOrder - the sequencing order for the results.

sequencingProperty - the name of the property that should be used to sequence the results.

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.

FunctionNotSupportedException - Function not supported Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

replaceCategory

public Category replaceCategory(String userId,
                                String guid,
                                Category suppliedCategory)
                         throws UnexpectedResponseException,
                                FunctionNotSupportedException,
                                MetadataServerUncontactableException,
                                InvalidParameterException,
                                UserNotAuthorizedException

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.

FunctionNotSupportedException - Function not supported

InvalidParameterException - one of the parameters is null or invalid. Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

updateCategory

public Category updateCategory(String userId,
                               String guid,
                               Category suppliedCategory)
                        throws UnexpectedResponseException,
                               FunctionNotSupportedException,
                               MetadataServerUncontactableException,
                               InvalidParameterException,
                               UserNotAuthorizedException

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.

FunctionNotSupportedException - Function not supported

InvalidParameterException - one of the parameters is null or invalid. Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

deleteCategory

public Category deleteCategory(String userId,
                               String guid)
                        throws MetadataServerUncontactableException,
                               UnrecognizedGUIDException,
                               FunctionNotSupportedException,
                               UnexpectedResponseException,
                               EntityNotDeletedException,
                               InvalidParameterException,
                               UserNotAuthorizedException

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.

Returns:

the deleted category Exceptions returned by the server

Throws:

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

FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.

InvalidParameterException - one of the parameters is null or invalid.

MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.

EntityNotDeletedException - a soft delete was issued but the relationship was not deleted.

UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

purgeCategory

public void purgeCategory(String userId,
                          String guid)
                   throws MetadataServerUncontactableException,
                          UnrecognizedGUIDException,
                          EntityNotPurgedException,
                          UnexpectedResponseException,
                          FunctionNotSupportedException,
                          InvalidParameterException,
                          UserNotAuthorizedException

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.

EntityNotPurgedException - a hard delete was issued but the category was not purged

UnrecognizedGUIDException - the supplied guid was not recognised

FunctionNotSupportedException - Function not supported Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

restoreCategory

public Category restoreCategory(String userId,
                                String guid)
                         throws MetadataServerUncontactableException,
                                UnrecognizedGUIDException,
                                FunctionNotSupportedException,
                                UnexpectedResponseException,
                                InvalidParameterException,
                                UserNotAuthorizedException

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:

UnrecognizedGUIDException - the supplied guid was not recognised

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

InvalidParameterException - one of the parameters is null or invalid.

FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it. Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getCategoryRelationships

public List<Line> getCategoryRelationships(String userId,
                                           String guid,
                                           Date asOfTime,
                                           int offset,
                                           int pageSize,
                                           SequencingOrder sequencingOrder,
                                           String sequencingProperty)
                                    throws MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           InvalidParameterException,
                                           FunctionNotSupportedException,
                                           UnexpectedResponseException

Get Category relationships

Parameters:

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

guid - guid of the category to get

asOfTime - the relationships returned as they were at this time. null indicates at the current time.

offset - the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.

pageSize - the maximum number of elements that can be returned on this request. 0 means there is not limit to the page size

sequencingOrder - the sequencing order for the results.

sequencingProperty - the name of the property that should be used to sequence the results.

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.

FunctionNotSupportedException - Function not supported Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server