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

Class SubjectAreaGlossaryRESTServices

java.lang.Object

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

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

public class SubjectAreaGlossaryRESTServices
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

instanceHandler, oMRSAPIHelper

Constructor Summary

Constructors

Constructor and Description
SubjectAreaGlossaryRESTServices() Default constructor
SubjectAreaGlossaryRESTServices(OMRSAPIHelper oMRSAPIHelper)

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse	createGlossary(String serverName, String userId, Glossary suppliedGlossary) Create a Glossary.
SubjectAreaOMASAPIResponse	deleteGlossary(String serverName, String userId, String guid, Boolean isPurge) Delete a Glossary instance
SubjectAreaOMASAPIResponse	findGlossary(String serverName, String userId, String searchCriteria, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Find Glossary
SubjectAreaOMASAPIResponse	getGlossaryByGuid(String serverName, String userId, String guid) Get a glossary by guid.
SubjectAreaOMASAPIResponse	getGlossaryRelationships(String serverName, String userId, String guid, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty)
protected SubjectAreaOMASAPIResponse	getResponse(SubjectAreaOMASAPIResponse response) Take an entityDetail response and map it to the appropriate glossary orientated response
SubjectAreaOMASAPIResponse	restoreGlossary(String serverName, String userId, String guid) Restore a Glossary Restore allows the deleted Glossary to be made active again.
SubjectAreaOMASAPIResponse	updateGlossary(String serverName, String userId, String guid, Glossary suppliedGlossary, boolean isReplace) Update a Glossary

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

createLine, deleteLine, getLine, getRelationshipsFromGuid, initializeAPI, initializeAPI, restoreLine, setOMRSAPIHelper, updateLine

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaGlossaryRESTServices

public SubjectAreaGlossaryRESTServices()

Default constructor

SubjectAreaGlossaryRESTServices

public SubjectAreaGlossaryRESTServices(OMRSAPIHelper oMRSAPIHelper)

Method Detail

createGlossary

public SubjectAreaOMASAPIResponse createGlossary(String serverName,
                                                 String userId,
                                                 Glossary suppliedGlossary)

Create a Glossary. There are specializations of glossaries that can also be created using this operation. To create a specialization, you should specify a nodeType other than Glossary in the supplied glossary. Glossaries with the same name can be confusing. Best practise is to createGlossaries that have unique names. This Create call does not police that glossary names are unique. So it is possible to create Glossaries with the same name as each other.

Valid nodeTypes for this request are:

• Taxonomy to create a Taxonomy
• CanonicalGlossary to create a canonical glossary
• TaxonomyAndCanonicalGlossary to create a glossary that is both a taxonomy and a canonical glossary
• Glossary to create a glossary that is not a taxonomy or a canonical glossary

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

suppliedGlossary - Glossary to create

Returns:

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

getGlossaryByGuid

public SubjectAreaOMASAPIResponse getGlossaryByGuid(String serverName,
                                                    String userId,
                                                    String guid)

Get a glossary by guid.

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 glossary to get

Returns:

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

findGlossary

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

Find Glossary

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 Glossary property values. If not specified then all glossaries are returned.

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

getGlossaryRelationships

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

updateGlossary

public SubjectAreaOMASAPIResponse updateGlossary(String serverName,
                                                 String userId,
                                                 String guid,
                                                 Glossary suppliedGlossary,
                                                 boolean isReplace)

Update a Glossary

If the caller has chosen to incorporate the glossary name in their Glossary Terms or Categories qualified name, renaming the glossary will cause those qualified names to mismatch the Glossary name. If the caller has chosen to incorporate the glossary qualifiedName in their Glossary Terms or Categories qualified name, changing the qualified name of the glossary will cause those qualified names to mismatch the Glossary name. 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 - unique identifier for requesting user, under which the request is performed

guid - guid of the glossary to update

suppliedGlossary - glossary 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 glossary 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.

deleteGlossary

public SubjectAreaOMASAPIResponse deleteGlossary(String serverName,
                                                 String userId,
                                                 String guid,
                                                 Boolean isPurge)

Delete a Glossary instance

The deletion of a glossary is only allowed if there is no glossary 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 glossary 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 glossary will not exist after the operation. when not successful the following Exceptions can occur

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

restoreGlossary

public SubjectAreaOMASAPIResponse restoreGlossary(String serverName,
                                                  String userId,
                                                  String guid)

Restore a Glossary Restore allows the deleted Glossary 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 glossary to restore

Returns:

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

getResponse

protected SubjectAreaOMASAPIResponse getResponse(SubjectAreaOMASAPIResponse response)

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

Parameters:

response - entityDetailResponse

Returns:

glossary response containing the appropriate glossary object.