org.odpi.openmetadata.accessservices.subjectarea.server.services

Class SubjectAreaCategoryRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRESTServices

org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaCategoryRESTServices

public class SubjectAreaCategoryRESTServices
extends SubjectAreaRESTServices

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

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRESTServices

oMRSAPIHelper

Constructor Summary

Constructors

Constructor and Description
SubjectAreaCategoryRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse	checkSiblingCategoryNames(String userid, String methodName, String suppliedCategoryName, String suppliedCategoryParentGuid, SubjectAreaErrorCode errorCode) Check that the requested name is not already used in a sibling category.
SubjectAreaOMASAPIResponse	createCategory(String userid, Category suppliedCategory) Create a Category.
SubjectAreaOMASAPIResponse	deleteCategory(String userid, String guid, Boolean isPurge) Delete a Category instance
SubjectAreaOMASAPIResponse	getCategory(String userid, String guid) Get a Category
SubjectAreaOMASAPIResponse	updateCategory(String userid, String guid, Category suppliedCategory, boolean isReplace) Update a Category

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRESTServices

getPossibleClassificationsForTerm, getPossibleRelationshipsForTerm, getRepositoryConnector, setOMRSAPIHelper, setRepositoryConnector

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaCategoryRESTServices

public SubjectAreaCategoryRESTServices()

Default constructor

Method Detail

createCategory

public SubjectAreaOMASAPIResponse 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:

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

A category is always associated with a glossary so there needs to be a named existing glossary name supplied with this request. A category may have a category parent, the create looks at the Category parent guid property, if this is null then the category is a top level category in the glossary; if this is not null then this needs to be a valid guid of a Category. The name of the requested category needs to be unique within its sibling categories i.e. categories with the same category parent.

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
• FunctionNotSupportedException Function not supported
• StatusNotSupportedException A status value is not supported

getCategory

public SubjectAreaOMASAPIResponse getCategory(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

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 respository service.
• InvalidParameterException one of the parameters is null or invalid.
• UnrecognizedGUIDException the supplied guid was not recognised
• FunctionNotSupportedException Function not supported

updateCategory

public SubjectAreaOMASAPIResponse 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.
• FunctionNotSupportedException Function not supported
• InvalidParameterException one of the parameters is null or invalid.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.

deleteCategory

public SubjectAreaOMASAPIResponse deleteCategory(String userid,
                                                 String guid,
                                                 Boolean isPurge)

Delete a Category 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 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 category was not deleted.
• GUIDNotPurgedException a hard delete was issued but the category was not purged

checkSiblingCategoryNames

public SubjectAreaOMASAPIResponse checkSiblingCategoryNames(String userid,
                                                            String methodName,
                                                            String suppliedCategoryName,
                                                            String suppliedCategoryParentGuid,
                                                            SubjectAreaErrorCode errorCode)

Check that the requested name is not already used in a sibling category. Category children name should be unique under a parent.

Parameters:

userid - user idendifier

methodName -

suppliedCategoryName - non-null category name

suppliedCategoryParentGuid - parent category guid. Do nothing if null.

errorCode - error code to use if there is an existing sibling categorey with the same name.