org.odpi.openmetadata.viewservices.glossaryauthor.handlers

Class GlossaryHandler

java.lang.Object

org.odpi.openmetadata.viewservices.glossaryauthor.handlers.GlossaryHandler

public class GlossaryHandler
extends Object

The glossary handler is initialised with a SubjectAreaGlossary, that contains the server the call should be sent to. The handler exposes methods for glossary functionality for the glossary author view

Constructor Summary

Constructors

Constructor and Description
GlossaryHandler(SubjectAreaGlossary subjectAreaGlossary) initialize the glossary handler with the subjectarea glossary object.

Method Summary

Modifier and Type	Method and Description
Glossary	createGlossary(String userId, Glossary suppliedGlossary) Create a Glossary.
void	deleteGlossary(String userId, String guid) Delete a Glossary instance
List<Glossary>	findGlossary(String userId, FindRequest findRequest) Find Glossary
Glossary	getGlossaryByGuid(String userId, String guid) Get a glossary by guid.
List<Line>	getGlossaryRelationships(String userId, String guid, FindRequest findRequest) Get Glossary relationships
void	purgeGlossary(String userId, String guid) Purge a Glossary instance
Glossary	replaceGlossary(String userId, String guid, Glossary suppliedGlossary) Replace a Glossary.
Glossary	restoreGlossary(String userId, String guid) Restore a Glossary
Glossary	updateGlossary(String userId, String guid, Glossary suppliedGlossary) Update a Glossary.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlossaryHandler

public GlossaryHandler(SubjectAreaGlossary subjectAreaGlossary)

initialize the glossary handler with the subjectarea glossary object.

Parameters:

subjectAreaGlossary - The SubjectAreaDefinition Open Metadata Access Service (OMAS) API for glossaries. This is the same as the The SubjectAreaDefinition Open Metadata View Service (OMVS) API for glossaries.

Method Detail

createGlossary

public Glossary createGlossary(String userId,
                               Glossary suppliedGlossary)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

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.

Parameters:

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

suppliedGlossary - Glossary to create

Returns:

the created glossary.

Exceptions returned by the server

Throws:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - Property Server Exception

getGlossaryByGuid

public Glossary getGlossaryByGuid(String userId,
                                  String guid)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Get a glossary by guid.

Parameters:

userId - userId under which the request is performed

guid - guid of the glossary to get

Returns:

the requested glossary.

Exceptions returned by the server

Throws:

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 List<Line> getGlossaryRelationships(String userId,
                                           String guid,
                                           FindRequest findRequest)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Get Glossary relationships

Parameters:

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

guid - guid of the glossary to get

findRequest - FindRequest

Returns:

the relationships associated with the requested Glossary guid

Exceptions returned by the server

Throws:

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 List<Glossary> findGlossary(String userId,
                                   FindRequest findRequest)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Find Glossary

Parameters:

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

findRequest - FindRequest

Returns:

A list of Glossaries meeting the search Criteria

Exceptions returned by the server

Throws:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - Property Server Exception

replaceGlossary

public Glossary replaceGlossary(String userId,
                                String guid,
                                Glossary suppliedGlossary)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Replace a Glossary. This means to override all the existing attributes with the supplied attributes.

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 - userId under which the request is performed

guid - guid of the glossary to update

suppliedGlossary - glossary to be updated

Returns:

replaced glossary

Throws:

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 Glossary updateGlossary(String userId,
                               String guid,
                               Glossary suppliedGlossary)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Update a Glossary. This means to update the glossary with any non-null attributes from the supplied 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 - userId under which the request is performed

guid - guid of the glossary to update

suppliedGlossary - glossary to be updated

Returns:

a response which when successful contains the updated glossary when not successful the following Exceptions can occur

Throws:

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 void deleteGlossary(String userId,
                           String guid)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Delete a Glossary instance

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

A delete (also known as 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.

Parameters:

userId - userId under which the request is performed

guid - guid of the glossary to be deleted.

Throws:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - Property Server Exception

purgeGlossary

public void purgeGlossary(String userId,
                          String guid)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Purge a Glossary instance

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

A purge means that the glossary will not exist after the operation.

Parameters:

userId - userId under which the request is performed

guid - guid of the glossary to be deleted.

Throws:

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 Glossary restoreGlossary(String userId,
                                String guid)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

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:

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

guid - guid of the glossary to restore

Returns:

the restored glossary

Throws:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - Property Server Exception