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

Class SubjectAreaCategoryRESTServices

java.lang.Object

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

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

public class SubjectAreaCategoryRESTServices
extends SubjectAreaRESTServicesInstance

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.server.services.SubjectAreaRESTServicesInstance

PAGE_OFFSET_DEFAULT_VALUE, PAGE_SIZE_DEFAULT_VALUE

Constructor Summary

Constructors

Constructor and Description
SubjectAreaCategoryRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse<Category>	createCategory(String serverName, String userId, Category suppliedCategory) Create a Category.
SubjectAreaOMASAPIResponse<Category>	deleteCategory(String serverName, String userId, String guid, Boolean isPurge) Delete a Category or SubjectAreaDefinition instance
SubjectAreaOMASAPIResponse<Category>	findCategory(String serverName, String userId, String searchCriteria, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Find Category
SubjectAreaOMASAPIResponse<Category>	getCategory(String serverName, String userId, String guid) Get a Category
SubjectAreaOMASAPIResponse<Line>	getCategoryRelationships(String serverName, String userId, String guid, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Get Category relationships
SubjectAreaOMASAPIResponse<Category>	restoreCategory(String serverName, String userId, String guid) Restore a Category or a SubjectAreaDefinition Restore allows the deleted Category to be made active again.
SubjectAreaOMASAPIResponse<Category>	updateCategory(String serverName, String userId, String guid, Category suppliedCategory, boolean isReplace) Update a Category

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

createLine, deleteLine, getLine, restoreLine, updateLine

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<Category> createCategory(String serverName,
                                                           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:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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.

getCategory

public SubjectAreaOMASAPIResponse<Category> getCategory(String serverName,
                                                        String userId,
                                                        String guid)

Get a Category

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

findCategory

public SubjectAreaOMASAPIResponse<Category> findCategory(String serverName,
                                                         String userId,
                                                         String searchCriteria,
                                                         Date asOfTime,
                                                         Integer offset,
                                                         Integer pageSize,
                                                         SequencingOrder sequencingOrder,
                                                         String sequencingProperty)

Find Category

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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). When not specified, all terms are returned.

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 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 serverName,
                                                                 String userId,
                                                                 String guid,
                                                                 Date asOfTime,
                                                                 Integer offset,
                                                                 Integer pageSize,
                                                                 SequencingOrder sequencingOrder,
                                                                 String sequencingProperty)

Get Category relationships

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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. If specified, the date is in milliseconds since 1970-01-01 00:00:00.

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 userId 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 serverName,
                                                           String userId,
                                                           String guid,
                                                           Category suppliedCategory,
                                                           boolean isReplace)

Update a Category

Status is not updated using this call.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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 serverName,
                                                           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:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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 serverName,
                                                            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:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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.