org.odpi.openmetadata.viewservices.glossaryauthor.services

Class GlossaryAuthorViewGlossaryRESTServices

java.lang.Object

org.odpi.openmetadata.viewservices.glossaryauthor.services.BaseGlossaryAuthorView

org.odpi.openmetadata.viewservices.glossaryauthor.services.GlossaryAuthorViewGlossaryRESTServices

public class GlossaryAuthorViewGlossaryRESTServices
extends BaseGlossaryAuthorView

The GlossaryAuthorViewGlossaryRESTServices provides the org.odpi.openmetadata.viewservices.glossaryauthor.services implementation of the GlossaryAuthor Open Metadata View Service (OMVS). This interface provides view glossary authoring interfaces for subject area experts.

Field Summary

Fields inherited from class org.odpi.openmetadata.viewservices.glossaryauthor.services.BaseGlossaryAuthorView

instanceHandler, invalidParameterHandler, restCallLogger

Constructor Summary

Constructors

Constructor and Description
GlossaryAuthorViewGlossaryRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse<Glossary>	createGlossary(String serverName, String userId, Glossary suppliedGlossary) Create a Glossary.
SubjectAreaOMASAPIResponse<SubjectAreaOMASAPIResponse<Term>>	createMultipleTermsInAGlossary(String serverName, String userId, String guid, Term[] terms) Create the supplied list of Terms in the glossary, identified by the supplied guid.
SubjectAreaOMASAPIResponse<Glossary>	deleteGlossary(String serverName, String userId, String guid, boolean isPurge) Delete a Glossary instance
SubjectAreaOMASAPIResponse<Glossary>	findGlossary(String serverName, String userId, Date asOfTime, String searchCriteria, Integer startingFrom, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Find Glossary
SubjectAreaOMASAPIResponse<BreadCrumb>	getBreadCrumbTrail(String serverName, String userId, String guid, String rootCategoryGuid, String leafCategoryGuid, String termGuid) Get BreadCrumbTrail.
SubjectAreaOMASAPIResponse<Category>	getCategories(String serverName, String userId, String guid, Integer startingFrom, Integer pageSize, Boolean onlyTop)
SubjectAreaOMASAPIResponse<Glossary>	getGlossary(String serverName, String userId, String guid) Get a glossary.
SubjectAreaOMASAPIResponse<Line>	getGlossaryRelationships(String serverName, String userId, String guid, Date asOfTime, Integer startingFrom, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Get Glossary relationships
SubjectAreaOMASAPIResponse<Term>	getTerms(String serverName, String userId, String guid, Integer startingFrom, Integer pageSize)
SubjectAreaOMASAPIResponse<Glossary>	restoreGlossary(String serverName, String userId, String guid) Restore a Glossary
SubjectAreaOMASAPIResponse<Glossary>	updateGlossary(String serverName, String userId, String guid, Glossary glossary, boolean isReplace) Update a Glossary

Methods inherited from class org.odpi.openmetadata.viewservices.glossaryauthor.services.BaseGlossaryAuthorView

getResponseForError

Methods inherited from class java.lang.Object

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

Constructor Detail

GlossaryAuthorViewGlossaryRESTServices

public GlossaryAuthorViewGlossaryRESTServices()

Default constructor

Method Detail

createGlossary

public SubjectAreaOMASAPIResponse<Glossary> 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.

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:

serverName - name of the local UI server.

userId - user identifier

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.
• InvalidParameterException one of the parameters is null or invalid.
• PropertyServerException Property server exception.

getGlossary

public SubjectAreaOMASAPIResponse<Glossary> getGlossary(String serverName,
                                                        String userId,
                                                        String guid)

Get a glossary.

Parameters:

serverName - name of the local UI server.

userId - user identifier

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.
• InvalidParameterException one of the parameters is null or invalid.
• PropertyServerException Property server exception.

findGlossary

public SubjectAreaOMASAPIResponse<Glossary> findGlossary(String serverName,
                                                         String userId,
                                                         Date asOfTime,
                                                         String searchCriteria,
                                                         Integer startingFrom,
                                                         Integer pageSize,
                                                         SequencingOrder sequencingOrder,
                                                         String sequencingProperty)

Find Glossary

Parameters:

serverName - name of the local UI server.

userId - user identifier

searchCriteria - String expression matching Glossary property values .

asOfTime - the glossaries returned as they were at this time. null indicates at the current time.

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

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.
• InvalidParameterException one of the parameters is null or invalid.
• PropertyServerException Property server exception.

getGlossaryRelationships

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

Get Glossary relationships

Parameters:

serverName - name of the local UI server.

userId - user identifier

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

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

sequencingOrder - the sequencing order for the results.

sequencingProperty - the name of the property that should be used to sequence the results.

Returns:

a response which when successful contains the glossary relationships 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.
• PropertyServerException Property server exception.

updateGlossary

public SubjectAreaOMASAPIResponse<Glossary> updateGlossary(String serverName,
                                                           String userId,
                                                           String guid,
                                                           Glossary glossary,
                                                           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 - name of the local UI server.

userId - user identifier

guid - guid of the glossary to update

glossary - glossary to update

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

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• InvalidParameterException one of the parameters is null or invalid.
• PropertyServerException Property server exception.

deleteGlossary

public SubjectAreaOMASAPIResponse<Glossary> 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 - name of the local UI server.

userId - user identifier

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

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• InvalidParameterException one of the parameters is null or invalid.
• PropertyServerException Property server exception.

restoreGlossary

public SubjectAreaOMASAPIResponse<Glossary> 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 - name of the local UI server.

userId - user identifier

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

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• InvalidParameterException one of the parameters is null or invalid.
• PropertyServerException Property server exception.

createMultipleTermsInAGlossary

public SubjectAreaOMASAPIResponse<SubjectAreaOMASAPIResponse<Term>> createMultipleTermsInAGlossary(String serverName,
                                                                                                   String userId,
                                                                                                   String guid,
                                                                                                   Term[] terms)

Create the supplied list of Terms in the glossary, identified by the supplied guid. Each term does not need to specify a glossary.

Parameters:

serverName - local UI server name

userId - user identifier

guid - guid of the glossary under which the Terms will be created

terms - terms to create

Returns:

a response which when successful contains a list of the responses from the Term creates (successful or otherwise). The order of the responses is the same as the supplied terms order. 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.

getBreadCrumbTrail

public SubjectAreaOMASAPIResponse<BreadCrumb> getBreadCrumbTrail(String serverName,
                                                                 String userId,
                                                                 String guid,
                                                                 String rootCategoryGuid,
                                                                 String leafCategoryGuid,
                                                                 String termGuid)

Get BreadCrumbTrail. The user interface experience can start with a particular Glossary, navigate to a child Category, then to another child category then to a categories term. When such a user interface navigation occurs, it is helpful for the user to be displayed a 'breadcrumb' trail of where they have been, showing how nested they are in the glossary artifacts. The Get BreadcrumbTrail API returns information that allows the user interface to easy construct a trail of breadcrumbs. Each breadcrumb contains

• a displayName that is intended to be shown to the user
• a guid that uniquely identifies a breadcrumb but is not intended to be shown to the user
• a types, allowing the user interface to display an appropriate icon.
• a path that can be used to determine all the elements in the breadcrumb

Parameters:

serverName - local UI server name

userId - user identifier

guid - Glossary guid.

rootCategoryGuid - Root Category guid

leafCategoryGuid - Leaf Category Guid

termGuid - Term Guid.

Returns:

a response which when successful contains a list of breadcrumbs corresponding to the supplied guids. 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.

getCategories

public SubjectAreaOMASAPIResponse<Category> getCategories(String serverName,
                                                          String userId,
                                                          String guid,
                                                          Integer startingFrom,
                                                          Integer pageSize,
                                                          Boolean onlyTop)

getTerms

public SubjectAreaOMASAPIResponse<Term> getTerms(String serverName,
                                                 String userId,
                                                 String guid,
                                                 Integer startingFrom,
                                                 Integer pageSize)