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

Class SubjectAreaGlossaryRESTServices

java.lang.Object

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

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

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

Modifier and Type	Field and Description
static String	CATEGORY_ANCHOR_RELATIONSHIP_GUID
static String	CATEGORY_HIERARCHY_LINK_GUID
static String	GLOSSARY_TYPE_GUID
static String	TERM_ANCHOR_RELATIONSHIP_GUID

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

oMRSAPIHelper

Constructor Summary

Constructors

Constructor and Description
SubjectAreaGlossaryRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse	createGlossary(String userid, Glossary suppliedGlossary) Create a Glossary.
SubjectAreaOMASAPIResponse	deleteGlossary(String userid, String guid, Boolean isPurge) Delete a Glossary instance
SubjectAreaOMASAPIResponse	getGlossaryByGuid(String userid, String guid) Get a glossary by guid.
SubjectAreaOMASAPIResponse	getGlossaryByName(String userid, String name) Get a Glossary by name
SubjectAreaOMASAPIResponse	updateGlossary(String userid, String guid, Glossary suppliedGlossary, boolean isReplace) Update a Glossary

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

Field Detail

GLOSSARY_TYPE_GUID

public static final String GLOSSARY_TYPE_GUID

See Also:

Constant Field Values

TERM_ANCHOR_RELATIONSHIP_GUID

public static final String TERM_ANCHOR_RELATIONSHIP_GUID

See Also:

Constant Field Values

CATEGORY_ANCHOR_RELATIONSHIP_GUID

public static final String CATEGORY_ANCHOR_RELATIONSHIP_GUID

See Also:

Constant Field Values

CATEGORY_HIERARCHY_LINK_GUID

public static final String CATEGORY_HIERARCHY_LINK_GUID

See Also:

Constant Field Values

Constructor Detail

SubjectAreaGlossaryRESTServices

public SubjectAreaGlossaryRESTServices()

Default constructor

Method Detail

createGlossary

public SubjectAreaOMASAPIResponse createGlossary(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.

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 glosary
• Glossary to create a glossary that is not a taxonomy or a canonical glossary

Parameters:

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

getGlossaryByGuid

public SubjectAreaOMASAPIResponse getGlossaryByGuid(String userid,
                                                    String guid)

Get a glossary by guid.

Parameters:

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
• FunctionNotSupportedException Function not supported

updateGlossary

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

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.

getGlossaryByName

public SubjectAreaOMASAPIResponse getGlossaryByName(String userid,
                                                    String name)

Get a Glossary by name

Glossaries should have unique names. If repositories were not able to contact each other on the network, it is possible that glossaries of the same name might be added. If this has occured this operation may not retun the glossary you are interested in. The guid of the glossary is the way to uniquely identify a glossary; a get for glossary by guid can be issued to find glossaries with particular guids.

Parameters:

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

name - find the glossary with this name.

Returns:

the requested glossary. when not successful the following Exception responses can occur

• InvalidParameterException one of the parameters is null or invalid.
• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• MetadataServerUncontactableException not able to communicate with a Metadata respository service.
• FunctionNotSupportedException Function not supported

deleteGlossary

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

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