org.odpi.openmetadata.accessservices.subjectarea

Interface SubjectAreaGlossary

All Known Implementing Classes:

SubjectAreaGlossaryImpl

public interface SubjectAreaGlossary

The SubjectAreaImpl Open Metadata Access Service (OMAS).

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

Method Detail

createGlossary

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

Create a Glossary

Parameters:

userId - userId under which the request is performed

suppliedGlossary - details of 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

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

Get a glossary by guid.

Parameters:

userId - userId under which the request is performed

guid - guid of the glossary to get

Returns:

Glossary with the requested 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.

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

replaceGlossary

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.

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.

UnrecognizedNameException - Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

updateGlossary

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.

Parameters:

userId - userId under which the request is performed

guid - guid of the glossary to update

suppliedGlossary - glossary to be updated

Returns:

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

UnrecognizedNameException - unrecognised name Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

deleteGlossary

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.

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

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.

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