org.odpi.openmetadata.viewservices.glossaryauthor.handlers

Class TermHandler

java.lang.Object

org.odpi.openmetadata.viewservices.glossaryauthor.handlers.TermHandler

public class TermHandler
extends Object

The term handler is initialised with a SubjectAreaTerm, that contains the server the call should be sent to. The handler exposes methods for term functionality for the glossary author view

Constructor Summary

Constructors

Constructor and Description
TermHandler(SubjectAreaTerm subjectAreaTerm) Constructor for the TermHandler

Method Summary

Modifier and Type	Method and Description
Term	createTerm(String userId, Term suppliedTerm) Create a Term
void	deleteTerm(String userId, String guid) Delete a Term instance
List<Term>	findTerm(String userId, FindRequest findRequest) Find Term
Term	getTermByGuid(String userId, String guid) Get a term by guid.
List<Line>	getTermRelationships(String userId, String guid, FindRequest findRequest) Get Term relationships
void	purgeTerm(String userId, String guid) Purge a Term instance
Term	replaceTerm(String userId, String guid, Term suppliedTerm) Replace a Term.
Term	restoreTerm(String userId, String guid) Restore 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

TermHandler

public TermHandler(SubjectAreaTerm subjectAreaTerm)

Constructor for the TermHandler

Parameters:

subjectAreaTerm - The SubjectAreaDefinition Open Metadata Access Service (OMAS) API for terms. This is the same as the The SubjectAreaDefinition Open Metadata View Service (OMVS) API for terms.

Method Detail

createTerm

public Term createTerm(String userId,
                       Term suppliedTerm)
                throws InvalidParameterException,
                       PropertyServerException,
                       UserNotAuthorizedException

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.

PropertyServerException - property server exception

getTermByGuid

public Term getTermByGuid(String userId,
                          String guid)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

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.

PropertyServerException - property server exception

findTerm

public List<Term> findTerm(String userId,
                           FindRequest findRequest)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Find Term

Parameters:

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

findRequest - FindRequest

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.

PropertyServerException - property server exception

replaceTerm

public Term replaceTerm(String userId,
                        String guid,
                        Term suppliedTerm)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

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.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

updateTerm

public Term updateTerm(String userId,
                       String guid,
                       Term suppliedTerm)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

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

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.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

deleteTerm

public void deleteTerm(String userId,
                       String guid)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

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

PropertyServerException - property server exception

purgeTerm

public void purgeTerm(String userId,
                      String guid)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

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.

PropertyServerException - property server exception

restoreTerm

public Term restoreTerm(String userId,
                        String guid)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

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:

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - property server exception

getTermRelationships

public List<Line> getTermRelationships(String userId,
                                       String guid,
                                       FindRequest findRequest)
                                throws UserNotAuthorizedException,
                                       InvalidParameterException,
                                       PropertyServerException

Get Term relationships

Parameters:

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

guid - guid of the term to get

findRequest - FindRequest

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.

PropertyServerException - Property Server exception