org.odpi.openmetadata.accessservices.subjectarea

Interface SubjectAreaTerm

All Known Implementing Classes:

SubjectAreaTermImpl

public interface SubjectAreaTerm

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

Method Summary

Modifier and Type	Method and Description
Term	createTerm(String userId, Term suppliedTerm) Create a Term
Term	deleteTerm(String userId, String guid) Delete a Term instance A delete (also known as a soft delete) means that the term instance will exist in a deleted state in the repository after the delete operation.
List<Term>	findTerm(String userId, String searchCriteria, Date asOfTime, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Find Term
Term	getTermByGuid(String userId, String guid) Get a term by guid.
List<Line>	getTermRelationships(String userId, String guid, Date asOfTime, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Get Term relationships
void	purgeTerm(String userId, String guid) Purge a Term instance A purge means that the term will not exist after the operation.
Term	replaceTerm(String userId, String guid, Term suppliedTerm) Replace a Term.
Term	restoreTerm(String userId, String guid) Restore a Term Restore allows the deleted Term to be made active again.
Term	updateTerm(String userId, String guid, Term suppliedTerm) Update a Term.

Method Detail

createTerm

Term createTerm(String userId,
                Term suppliedTerm)
         throws MetadataServerUncontactableException,
                InvalidParameterException,
                UserNotAuthorizedException,
                ClassificationException,
                FunctionNotSupportedException,
                UnexpectedResponseException

Create a Term

Parameters:

userId - userId under which the request is performed

suppliedTerm - Term to create

Returns:

the created term. 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.

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

getTermByGuid

Term getTermByGuid(String userId,
                   String guid)
            throws MetadataServerUncontactableException,
                   UserNotAuthorizedException,
                   InvalidParameterException,
                   FunctionNotSupportedException,
                   UnexpectedResponseException

Get a term by guid.

Parameters:

userId - userId under which the request is performed

guid - guid of the term to get

Returns:

the requested term. 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 Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getTermRelationships

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

Get Term relationships

Parameters:

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

guid - guid of the term 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 Term 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 Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

replaceTerm

Term replaceTerm(String userId,
                 String guid,
                 Term suppliedTerm)
          throws UnexpectedResponseException,
                 UserNotAuthorizedException,
                 FunctionNotSupportedException,
                 InvalidParameterException,
                 MetadataServerUncontactableException

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

Status is not updated using this call. The GovernanceAction content if specified replaces what is on the server.

Parameters:

userId - userId under which the request is performed

guid - guid of the term to update

suppliedTerm - term to be updated

Returns:

replaced term

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

updateTerm

Term updateTerm(String userId,
                String guid,
                Term suppliedTerm)
         throws UnexpectedResponseException,
                UserNotAuthorizedException,
                FunctionNotSupportedException,
                InvalidParameterException,
                MetadataServerUncontactableException

Update a Term. This means to update the term with any non-null attributes from the supplied term.

If the caller has chosen to incorporate the term name in their Term Terms or Categories qualified name, renaming the term will cause those qualified names to mismatch the Term name. If the caller has chosen to incorporate the term qualifiedName in their Term Terms or Categories qualified name, changing the qualified name of the term will cause those qualified names to mismatch the Term name. Status is not updated using this call. The GovernanceAction content if specified replaces what is on the server.

Parameters:

userId - userId under which the request is performed

guid - guid of the term to update

suppliedTerm - term to be updated

Returns:

a response which when successful contains the updated term 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

deleteTerm

Term deleteTerm(String userId,
                String guid)
         throws InvalidParameterException,
                MetadataServerUncontactableException,
                UserNotAuthorizedException,
                FunctionNotSupportedException,
                UnrecognizedGUIDException,
                UnexpectedResponseException,
                EntityNotDeletedException

Delete a Term instance A delete (also known as a soft delete) means that the term 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 term to be deleted.

Returns:

the deleted term Exceptions returned by the server

Throws:

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.

MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.

EntityNotDeletedException - a soft delete was issued but the relationship was not deleted.

UnrecognizedGUIDException - the supplied guid was not recognised Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

purgeTerm

void purgeTerm(String userId,
               String guid)
        throws InvalidParameterException,
               UserNotAuthorizedException,
               MetadataServerUncontactableException,
               GUIDNotPurgedException,
               FunctionNotSupportedException,
               UnrecognizedGUIDException,
               UnexpectedResponseException

Purge a Term instance A purge means that the term will not exist after the operation.

Parameters:

userId - userId under which the request is performed

guid - guid of the term to be deleted.

Throws:

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 term was not purged

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

restoreTerm

Term restoreTerm(String userId,
                 String guid)
          throws InvalidParameterException,
                 UserNotAuthorizedException,
                 MetadataServerUncontactableException,
                 UnrecognizedGUIDException,
                 FunctionNotSupportedException,
                 UnexpectedResponseException

Restore a Term Restore allows the deleted Term 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 term to restore

Returns:

the restored term

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 soft delete was issued but the repository does not support it. Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

findTerm

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

Find Term

Parameters:

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

searchCriteria - String expression matching Term property values (this does not include the GlossarySummary content).

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 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 Terms 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 Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server