org.odpi.openmetadata.accessservices.subjectarea.handlers

Class SubjectAreaCategoryHandler

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaHandler

org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaCategoryHandler

public class SubjectAreaCategoryHandler
extends SubjectAreaHandler

The SubjectAreaRESTServicesInstance provides the org.odpi.openmetadata.accessservices.subjectarea.server-side implementation of the SubjectArea Open Metadata Access Service (OMAS). This interface provides glossary authoring interfaces for subject area experts.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaHandler

CATEGORY_ANCHOR_RELATIONSHIP_NAME, CATEGORY_HIERARCHY_LINK_RELATIONSHIP_NAME, CATEGORY_TYPE_NAME, GLOSSARY_TYPE_NAME, mappersFactory, oMRSAPIHelper, PROJECT_SCOPE_RELATIONSHIP_NAME, PROJECT_TYPE_NAME, TERM_ANCHOR_RELATIONSHIP_NAME, TERM_TYPE_NAME

Constructor Summary

Constructors

Constructor and Description
SubjectAreaCategoryHandler(OMRSAPIHelper oMRSAPIHelper) Construct the Subject Area Category Handler needed to operate within a single server instance.

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse<Category>	createCategory(String userId, Category suppliedCategory) Create a Category.
SubjectAreaOMASAPIResponse<Category>	deleteCategory(String userId, String guid, Boolean isPurge) Delete a Category or SubjectAreaDefinition instance
SubjectAreaOMASAPIResponse<Category>	findCategory(String userId, FindRequest findRequest) Find Category
SubjectAreaOMASAPIResponse<Category>	getCategoryByGuid(String userId, String guid) Get a Category
SubjectAreaOMASAPIResponse<Line>	getCategoryRelationships(String userId, String guid, FindRequest findRequest) Get Category relationships
SubjectAreaOMASAPIResponse<Category>	restoreCategory(String userId, String guid) Restore a Category or a SubjectAreaDefinition
SubjectAreaOMASAPIResponse<Category>	updateCategory(String userId, String guid, Category suppliedCategory, boolean isReplace) Update a Category

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaHandler

convertOmrsToOmas, findEntities, getAllLineForEntity, getAllRelationshipsForEntity, getLinesFromRelationships, getNodesFromEntityDetails, validateGlossarySummaryDuringCreation

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaCategoryHandler

public SubjectAreaCategoryHandler(OMRSAPIHelper oMRSAPIHelper)

Construct the Subject Area Category Handler needed to operate within a single server instance.

Parameters:

oMRSAPIHelper - omrs API helper

Method Detail

createCategory

public SubjectAreaOMASAPIResponse<Category> createCategory(String userId,
                                                           Category suppliedCategory)

Create a Category. There is specialization of a Category that can also be created using this operation. To create this specialization, you should specify a nodeType other than Category in the supplied category.

Valid nodeTypes for this request are:

• SubjectAreaDefinition to create a Category that represents a subject area
• Category to create a category that is not a subject area

The qualifiedName can be specified and will be honoured. If it is specified then the caller may wish to ensure that it is unique. If this qualifiedName is not specified then one will be generated as GlossaryCategory concatinated with the the guid.

Failure to create the Categories classifications, link to its glossary or its icon, results in the create failing and the category being deleted

Parameters:

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

suppliedCategory - category to create

Returns:

response, when successful contains the created category. when not successful the following Exception responses can occur

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.
• InvalidParameterException one of the parameters is null or invalid.
• UnrecognizedGUIDException the supplied guid was not recognised
• ClassificationException Error processing a classification
• StatusNotSupportedException A status value is not supported
• FunctionNotSupportedException Function not supported.

getCategoryByGuid

public SubjectAreaOMASAPIResponse<Category> getCategoryByGuid(String userId,
                                                              String guid)

Get a Category

Parameters:

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

guid - guid of the category to get. This could be a guid for a SubjectAreaDefinition, which is a type of category

Returns:

response which when successful contains the category with the requested guid when not successful the following Exception responses can occur

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• MetadataServerUncontactableException not able to communicate with a Metadata repository service.
• InvalidParameterException one of the parameters is null or invalid.
• UnrecognizedGUIDException the supplied guid was not recognised

findCategory

public SubjectAreaOMASAPIResponse<Category> findCategory(String userId,
                                                         FindRequest findRequest)

Find Category

Parameters:

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

findRequest - FindRequest

Returns:

A list of Glossaries meeting the search Criteria

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.
• InvalidParameterException one of the parameters is null or invalid.

getCategoryRelationships

public SubjectAreaOMASAPIResponse<Line> getCategoryRelationships(String userId,
                                                                 String guid,
                                                                 FindRequest findRequest)

Get Category relationships

Parameters:

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

guid - guid

findRequest - FindRequest

Returns:

the relationships associated with the requested Category guid when not successful the following Exception responses can occur

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• InvalidParameterException one of the parameters is null or invalid.
• FunctionNotSupportedException Function not supported.

updateCategory

public SubjectAreaOMASAPIResponse<Category> updateCategory(String userId,
                                                           String guid,
                                                           Category suppliedCategory,
                                                           boolean isReplace)

Update a Category

Status is not updated using this call.

Parameters:

userId - userId under which the request is performed

guid - guid of the category to update

suppliedCategory - category to be updated

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

Returns:

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

• 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.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.
• FunctionNotSupportedException Function not supported.

deleteCategory

public SubjectAreaOMASAPIResponse<Category> deleteCategory(String userId,
                                                           String guid,
                                                           Boolean isPurge)

Delete a Category or SubjectAreaDefinition instance

There are 2 types of deletion, a soft delete and a hard delete (also known as a purge). All repositories support hard deletes. Soft deletes support is optional. Soft delete is the default.

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. A hard delete means that the category will not exist after the operation. when not successful the following Exception responses can occur

Parameters:

userId - userId under which the request is performed

guid - guid of the category to be deleted.

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

a void response when not successful the following Exception responses can occur

• UnrecognizedGUIDException the supplied guid was not recognised
• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• FunctionNotSupportedException Function not supported.
• 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 category was not deleted.
• EntityNotPurgedException a hard delete was issued but the category was not purged

restoreCategory

public SubjectAreaOMASAPIResponse<Category> restoreCategory(String userId,
                                                            String guid)

Restore a Category or a SubjectAreaDefinition

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:

response which when successful contains the restored category when not successful the following Exception responses can occur

• UnrecognizedGUIDException the supplied guid was not recognised
• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• FunctionNotSupportedException Function not supported.
• 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.