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

Class SubjectAreaTermRESTServices

java.lang.Object

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

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

public class SubjectAreaTermRESTServices
extends SubjectAreaRESTServicesInstance

The SubjectAreaTermRESTServices provides the server-side implementation of the SubjectArea Open Metadata Access Service (OMAS) for Terms. This interface provides term 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
SubjectAreaTermRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse<Term>	createTerm(String serverName, String userId, Term suppliedTerm) Create a Term
SubjectAreaOMASAPIResponse<Term>	deleteTerm(String serverName, String userId, String guid, Boolean isPurge) Delete a Term instance
SubjectAreaOMASAPIResponse<Term>	findTerm(String serverName, String userId, String searchCriteria, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Find Term
SubjectAreaOMASAPIResponse<Term>	getTermByGuid(String serverName, String userId, String guid) Get a Term
SubjectAreaOMASAPIResponse<Line>	getTermRelationships(String serverName, String userId, String guid, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Get Term relationships
SubjectAreaOMASAPIResponse<Term>	restoreTerm(String serverName, String userId, String guid) Restore a Term Restore allows the deleted Term to be made active again.
SubjectAreaOMASAPIResponse<Term>	updateTerm(String serverName, String userId, String guid, Term suppliedTerm, boolean isReplace) Update a Term

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

SubjectAreaTermRESTServices

public SubjectAreaTermRESTServices()

Default constructor

Method Detail

createTerm

public SubjectAreaOMASAPIResponse<Term> createTerm(String serverName,
                                                   String userId,
                                                   Term suppliedTerm)

Create a Term

The name needs to be specified - as this is the main identifier for the term. The name should be unique for canonical glossaries. This API does not police the uniqueness in this case.

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 GlossaryTerm concatinated with the the guid.

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

Parameters:

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

userId - userId

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 repository 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<Term> getTermByGuid(String serverName,
                                                      String userId,
                                                      String guid)

Get a Term

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

getTermRelationships

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

Get Term 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

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.
• 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

findTerm

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

Find Term

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 Term property values (this does not include the TermSummary 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 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.

updateTerm

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

Update a Term

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 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. The GovernanceAction content is always replaced.

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

deleteTerm

public SubjectAreaOMASAPIResponse<Term> deleteTerm(String serverName,
                                                   String userId,
                                                   String guid,
                                                   Boolean isPurge)

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

restoreTerm

public SubjectAreaOMASAPIResponse<Term> restoreTerm(String serverName,
                                                    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:

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 term to delete

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.