org.odpi.openmetadata.accessservices.subjectarea.client

Class SubjectAreaTermImpl

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaTermImpl

All Implemented Interfaces:

SubjectAreaTerm

public class SubjectAreaTermImpl
extends Object
implements SubjectAreaTerm

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

Constructor Summary

Constructors

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

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.
Term	getTermByGuid(String userId, String guid) Get a term by guid.
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	updateTerm(String userId, String guid, Term suppliedTerm) Update a Term.

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaTermImpl

public SubjectAreaTermImpl(String omasServerURL)

Default Constructor used once a connector is created.

Parameters:

omasServerURL - - unique id for the connector instance

Method Detail

createTerm

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

Create a Term

Specified by:

createTerm in interface SubjectAreaTerm

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

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

Get a term by guid.

Specified by:

getTermByGuid in interface SubjectAreaTerm

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

replaceTerm

public Term replaceTerm(String userId,
                        String guid,
                        Term suppliedTerm)
                 throws UnexpectedResponseException,
                        UserNotAuthorizedException,
                        UnrecognizedNameException,
                        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.

Specified by:

replaceTerm in interface SubjectAreaTerm

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

UnrecognizedNameException

updateTerm

public Term updateTerm(String userId,
                       String guid,
                       Term suppliedTerm)
                throws UnexpectedResponseException,
                       UserNotAuthorizedException,
                       UnrecognizedNameException,
                       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.

Specified by:

updateTerm in interface SubjectAreaTerm

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

UnrecognizedNameException

deleteTerm

public Term deleteTerm(String userId,
                       String guid)
                throws InvalidParameterException,
                       MetadataServerUncontactableException,
                       UserNotAuthorizedException,
                       FunctionNotSupportedException,
                       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.

Specified by:

deleteTerm in interface SubjectAreaTerm

Parameters:

userId - userId under which the request is performed

guid - guid of the term to be deleted.

Returns:

the deleted term

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.

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

MetadataServerUncontactableException - unable to contact server

UnexpectedResponseException

purgeTerm

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

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

Specified by:

purgeTerm in interface SubjectAreaTerm

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

MetadataServerUncontactableException - unable to contact server

UnexpectedResponseException