org.odpi.openmetadata.accessservices.subjectarea

Interface SubjectAreaGlossary

All Known Implementing Classes:

SubjectAreaGlossaryImpl

public interface SubjectAreaGlossary

The SubjectAreaDefinition Open Metadata Access Service (OMAS) API for glossaries.

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
List<Glossary>	findGlossary(String userId, String searchCriteria, Date asOfTime, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Find Glossary
Glossary	getGlossaryByGuid(String userId, String guid) Get a glossary by guid.
List<Line>	getGlossaryRelationships(String userId, String guid, Date asOfTime, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty) 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.

Method Detail

createGlossary

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

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.

UnrecognizedGUIDException - the supplied guid was not recognised

ClassificationException - Error processing a classification

FunctionNotSupportedException - Function not supported

PropertyServerException - property server exception

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

UnrecognizedGUIDException - the supplied guid was not recognised

FunctionNotSupportedException - Function not supported

PropertyServerException - Property Server Exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getGlossaryRelationships

List<Line> getGlossaryRelationships(String userId,
                                    String guid,
                                    Date asOfTime,
                                    int offset,
                                    int pageSize,
                                    SequencingOrder sequencingOrder,
                                    String sequencingProperty)
                             throws UserNotAuthorizedException,
                                    InvalidParameterException,
                                    FunctionNotSupportedException,
                                    UnexpectedResponseException,
                                    MetadataServerUncontactableException,
                                    PropertyServerException

Get Glossary relationships

Parameters:

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

guid - guid of the glossary to get

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

offset - 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. 0 means there is not limit to the page size

sequencingOrder - the sequencing order for the results.

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

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.

FunctionNotSupportedException - Function not supported

PropertyServerException - property server exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

findGlossary

List<Glossary> findGlossary(String userId,
                            String searchCriteria,
                            Date asOfTime,
                            int offset,
                            int pageSize,
                            SequencingOrder sequencingOrder,
                            String sequencingProperty)
                     throws MetadataServerUncontactableException,
                            UserNotAuthorizedException,
                            InvalidParameterException,
                            FunctionNotSupportedException,
                            UnexpectedResponseException,
                            PropertyServerException

Find Glossary

Parameters:

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

searchCriteria - String expression matching glossary properties. If not specified then all glossaries are returned.

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

offset - 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. 0 means there is no limit to the page size

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

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.

FunctionNotSupportedException - Function not supported

PropertyServerException - property server exception

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,
                         InvalidParameterException,
                         FunctionNotSupportedException,
                         MetadataServerUncontactableException,
                         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.

FunctionNotSupportedException - Function not supported

PropertyServerException - property server exception

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,
                        InvalidParameterException,
                        FunctionNotSupportedException,
                        MetadataServerUncontactableException,
                        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.

FunctionNotSupportedException - Function not supported

PropertyServerException - property server exception

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

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.

PropertyServerException - property server exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

purgeGlossary

void purgeGlossary(String userId,
                   String guid)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   MetadataServerUncontactableException,
                   UnrecognizedGUIDException,
                   EntityNotPurgedException,
                   UnexpectedResponseException,
                   FunctionNotSupportedException,
                   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:

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.

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

FunctionNotSupportedException - Function not supported

PropertyServerException - property server exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

restoreGlossary

Glossary restoreGlossary(String userId,
                         String guid)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         MetadataServerUncontactableException,
                         UnrecognizedGUIDException,
                         FunctionNotSupportedException,
                         UnexpectedResponseException,
                         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:

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.

FunctionNotSupportedException - Function not supported this indicates that a restore was issued but the repository does not support it.

PropertyServerException - property server exception

Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server