org.odpi.openmetadata.accessservices.subjectarea.client

Class SubjectAreaGlossaryImpl

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaGlossaryImpl

All Implemented Interfaces:

SubjectAreaGlossary

public class SubjectAreaGlossaryImpl
extends Object
implements SubjectAreaGlossary

SubjectAreaImpl is the OMAS client library implementation of the SubjectAreaImpl OMAS. This interface provides glossary authoring interface for subject area experts.

Constructor Summary

Constructors

Constructor and Description
SubjectAreaGlossaryImpl(String omasServerURL) Default Constructor used once a connector is created.

Method Summary

Modifier and Type	Method and Description
Glossary	createGlossary(String userid, Glossary suppliedGlossary) Create a Glossary.
Glossary	deleteGlossary(String userid, String guid) Delete a Glossary instance The deletion of a glossary is only allowed if there is no glossary content (i.e.
Glossary	getGlossaryByGuid(String userid, String guid) Get a glossary by guid.
Glossary	getGlossaryByName(String userid, String name) Get a Glossary by name Glossaries should have unique names.
void	purgeGlossary(String userid, String guid) Purge a Glossary instance The purge of a glossary is only allowed if there is no glossary content (i.e.
Glossary	replaceGlossary(String userid, String guid, Glossary suppliedGlossary) Replace 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

SubjectAreaGlossaryImpl

public SubjectAreaGlossaryImpl(String omasServerURL)

Default Constructor used once a connector is created.

Parameters:

omasServerURL - - unique id for the connector instance

Method Detail

createGlossary

public Glossary createGlossary(String userid,
                               Glossary suppliedGlossary)
                        throws MetadataServerUncontactableException,
                               InvalidParameterException,
                               UserNotAuthorizedException,
                               UnrecognizedGUIDException,
                               ClassificationException,
                               FunctionNotSupportedException,
                               UnexpectedResponseException

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

Specified by:

createGlossary in interface SubjectAreaGlossary

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.

UnrecognizedGUIDException - the supplied guid was not recognised

ClassificationException - Error processing a classification

FunctionNotSupportedException - Function not supported Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getGlossaryByGuid

public Glossary getGlossaryByGuid(String userid,
                                  String guid)
                           throws MetadataServerUncontactableException,
                                  UnrecognizedGUIDException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  FunctionNotSupportedException,
                                  UnexpectedResponseException

Get a glossary by guid.

Specified by:

getGlossaryByGuid in interface SubjectAreaGlossary

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.

UnrecognizedGUIDException - the supplied guid was not recognised

FunctionNotSupportedException - Function not supported Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getGlossaryByName

public Glossary getGlossaryByName(String userid,
                                  String name)
                           throws MetadataServerUncontactableException,
                                  UnrecognizedNameException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  FunctionNotSupportedException,
                                  UnexpectedResponseException

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

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

UnrecognizedNameException - the supplied name was not recognised

FunctionNotSupportedException - Function not supported Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

replaceGlossary

public Glossary replaceGlossary(String userid,
                                String guid,
                                Glossary suppliedGlossary)
                         throws UnexpectedResponseException,
                                UserNotAuthorizedException,
                                UnrecognizedNameException,
                                FunctionNotSupportedException,
                                InvalidParameterException,
                                MetadataServerUncontactableException

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.

Specified by:

replaceGlossary in interface SubjectAreaGlossary

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.

FunctionNotSupportedException - Function not supported

InvalidParameterException - one of the parameters is null or invalid. Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

UnrecognizedNameException

updateGlossary

public Glossary updateGlossary(String userid,
                               String guid,
                               Glossary suppliedGlossary)
                        throws UnexpectedResponseException,
                               UserNotAuthorizedException,
                               UnrecognizedNameException,
                               FunctionNotSupportedException,
                               InvalidParameterException,
                               MetadataServerUncontactableException

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.

Specified by:

updateGlossary in interface SubjectAreaGlossary

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.

FunctionNotSupportedException - Function not supported

InvalidParameterException - one of the parameters is null or invalid. Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

UnrecognizedNameException

deleteGlossary

public Glossary deleteGlossary(String userid,
                               String guid)
                        throws InvalidParameterException,
                               MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               UnrecognizedGUIDException,
                               FunctionNotSupportedException,
                               UnexpectedResponseException,
                               EntityNotDeletedException

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.

Specified by:

deleteGlossary in interface SubjectAreaGlossary

Parameters:

userid - userid under which the request is performed

guid - guid of the glossary to be deleted.

Returns:

the deleted glossary

Throws:

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.

EntityNotDeletedException - a delete was issued but the glossary was not deleted.

MetadataServerUncontactableException - unable to contact server

UnexpectedResponseException

purgeGlossary

public void purgeGlossary(String userid,
                          String guid)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          MetadataServerUncontactableException,
                          UnrecognizedGUIDException,
                          GUIDNotPurgedException,
                          UnexpectedResponseException

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.

Specified by:

purgeGlossary in interface SubjectAreaGlossary

Parameters:

userid - userid under which the request is performed

guid - guid of the glossary to be deleted.

Throws:

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.

GUIDNotPurgedException - a hard delete was issued but the glossary was not purged

MetadataServerUncontactableException - unable to contact server

UnexpectedResponseException