org.odpi.openmetadata.accessservices.subjectarea.handlers

Class SubjectAreaTermHandler

java.lang.Object

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

org.odpi.openmetadata.accessservices.subjectarea.handlers.SubjectAreaTermHandler

public class SubjectAreaTermHandler
extends SubjectAreaHandler

SubjectAreaTermHandler manages Term objects from the property server. It runs server-side in the subject Area OMAS and retrieves entities and relationships through the OMRSRepositoryConnector.

Field Summary

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

oMRSAPIHelper

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse	createTerm(SubjectAreaGlossaryHandler glossaryHandler, String userId, Term suppliedTerm) Create a Term.
SubjectAreaOMASAPIResponse	deleteTerm(String userId, String guid, Boolean isPurge) Delete a Term instance
SubjectAreaOMASAPIResponse	findTerm(String userId, String searchCriteria, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Find Term
protected SubjectAreaOMASAPIResponse	getResponse(SubjectAreaOMASAPIResponse response) Take an entityDetail response and map it to the appropriate Term orientated response
SubjectAreaOMASAPIResponse	getTermByGuid(String userId, String guid) Get a term by guid.
SubjectAreaOMASAPIResponse	getTermRelationships(String userId, String guid, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Get Term relationships
SubjectAreaOMASAPIResponse	restoreTerm(String userId, String guid) Restore a Term
SubjectAreaOMASAPIResponse	updateTerm(String userId, String guid, Term suppliedTerm, boolean isReplace) Update a Term

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

getRelationshipsFromGuid, validateGlossarySummaryDuringCreation

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaTermHandler

public SubjectAreaTermHandler(OMRSAPIHelper oMRSAPIHelper)

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

Parameters:

oMRSAPIHelper - omrs API helper

Method Detail

getResponse

protected SubjectAreaOMASAPIResponse getResponse(SubjectAreaOMASAPIResponse response)

Take an entityDetail response and map it to the appropriate Term orientated response

Specified by:

getResponse in class SubjectAreaHandler

Parameters:

response - entityDetailResponse

Returns:

Term response containing the appropriate Term object.

createTerm

public SubjectAreaOMASAPIResponse createTerm(SubjectAreaGlossaryHandler glossaryHandler,
                                             String userId,
                                             Term suppliedTerm)

Create a Term. There are specializations of terms that can also be created using this operation. To create a specialization, you should specify a nodeType other than Term in the supplied term.

Terms with the same name can be confusing. Best practise is to createTerms that have unique names. This Create call does not police that term names are unique. So it is possible to create Terms with the same name as each other.

Valid nodeTypes for this request are:

• Taxonomy to create a Taxonomy
• CanonicalTerm to create a canonical term
• TaxonomyAndCanonicalTerm to create a term that is both a taxonomy and a canonical term
• Term to create a term that is not a taxonomy or a canonical term

Parameters:

glossaryHandler - glossary handler

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

suppliedTerm - Term to create

Returns:

response, when successful contains the created term. 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.

getTermByGuid

public SubjectAreaOMASAPIResponse getTermByGuid(String userId,
                                                String guid)

Get a term by guid.

Parameters:

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

guid - guid of the term to get

Returns:

response which when successful contains the term 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

findTerm

public SubjectAreaOMASAPIResponse findTerm(String userId,
                                           String searchCriteria,
                                           Date asOfTime,
                                           Integer offset,
                                           Integer pageSize,
                                           SequencingOrder sequencingOrder,
                                           String sequencingProperty)

Find Term

Parameters:

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

searchCriteria - String expression matching Term property values. If not specified then all terms are returned.

asOfTime - the terms 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 Terms 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.
• FunctionNotSupportedException Function not supported this indicates that a find was issued but the repository does not implement find functionality in some way.

getTermRelationships

public SubjectAreaOMASAPIResponse getTermRelationships(String userId,
                                                       String guid,
                                                       Date asOfTime,
                                                       Integer offset,
                                                       Integer pageSize,
                                                       SequencingOrder sequencingOrder,
                                                       String sequencingProperty)

Get Term relationships

Parameters:

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

guid - guid of the term 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 Term 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.

updateTerm

public SubjectAreaOMASAPIResponse updateTerm(String userId,
                                             String guid,
                                             Term suppliedTerm,
                                             boolean isReplace)

Update a Term

If the caller has chosen to incorporate the term name in their Term Terms or Categories qualified name, renaming the term will cause those qualified names to mismatch the Term name. If the caller has chosen to incorporate the term qualifiedName in their Term Terms or Categories qualified name, changing the qualified name of the term will cause those qualified names to mismatch the Term name. Status is not updated using this call.

Parameters:

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

guid - guid of the term to update

suppliedTerm - term 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 term 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.

deleteTerm

public SubjectAreaOMASAPIResponse deleteTerm(String userId,
                                             String guid,
                                             Boolean isPurge)

Delete a Term instance

The deletion of a term is only allowed if there is no term content (i.e. no terms or categories).

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 term 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 term will not exist after the operation. when not successful the following Exceptions can occur

Parameters:

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

guid - guid of the term 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 term was not deleted.
• EntityNotPurgedException a hard delete was issued but the term was not purged

restoreTerm

public SubjectAreaOMASAPIResponse restoreTerm(String userId,
                                              String guid)

Restore a Term

Restore allows the deleted Term 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 term to restore

Returns:

response which when successful contains the restored term 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.