org.odpi.openmetadata.accessservices.subjectarea.client

Class SubjectAreaTermImpl

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaBaseImpl

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

All Implemented Interfaces:

SubjectAreaTerm

public class SubjectAreaTermImpl
extends SubjectAreaBaseImpl
implements SubjectAreaTerm

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

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor and Description
SubjectAreaTermImpl(String serverName, String serverPlatformURLRoot) Constructor for no authentication.

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
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
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 org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaBaseImpl

deleteEntityRESTCall, deleteRelationshipRESTCall, encodeQueryProperty, findRESTCall, getByIdRESTCall, getRelationships, postRESTCall, purgeEntityRESTCall, purgeRelationshipRESTCall, putRESTCall, restoreRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, callStringMapGetRESTCall, callVoidGetRESTCall, callVoidPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

callDeleteRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaTermImpl

public SubjectAreaTermImpl(String serverName,
                           String serverPlatformURLRoot)
                    throws InvalidParameterException

Constructor for no authentication.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Detail

createTerm

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

Description copied from interface: SubjectAreaTerm

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:

MetadataServerUncontactableException - Unable to contact the server

InvalidParameterException - one of the parameters is null or invalid.

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

ClassificationException - Error processing a classification

FunctionNotSupportedException - Function not supported

UnexpectedResponseException - an unexpected response was returned from the server

PropertyServerException - property server exception

Client library Exceptions

getTermByGuid

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

Description copied from interface: SubjectAreaTerm

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:

MetadataServerUncontactableException - Unable to contact the server

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

InvalidParameterException - one of the parameters is null or invalid.

FunctionNotSupportedException - Function not supported

UnexpectedResponseException - an unexpected response was returned from the server

PropertyServerException - property server exception

Client library Exceptions

getTermRelationships

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

Description copied from interface: SubjectAreaTerm

Get Term relationships

Specified by:

getTermRelationships in interface SubjectAreaTerm

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

UnexpectedResponseException - an unexpected response was returned from the server

MetadataServerUncontactableException - Unable to contact the server

PropertyServerException - property server exception

Client library Exceptions

replaceTerm

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

Description copied from interface: SubjectAreaTerm

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.

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:

UnexpectedResponseException - an unexpected response was returned from the server

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

FunctionNotSupportedException - Function not supported

InvalidParameterException - one of the parameters is null or invalid.

MetadataServerUncontactableException - Unable to contact the server

PropertyServerException - property server exception

Client library Exceptions

updateTerm

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

Description copied from interface: SubjectAreaTerm

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.

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:

UnexpectedResponseException - an unexpected response was returned from the server

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

FunctionNotSupportedException - Function not supported

InvalidParameterException - one of the parameters is null or invalid.

MetadataServerUncontactableException - Unable to contact the server

PropertyServerException - property server exception

Client library Exceptions

deleteTerm

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

Description copied from interface: SubjectAreaTerm

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 Exceptions returned by the server

Throws:

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.

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.

UnrecognizedGUIDException - the supplied guid was not recognised

UnexpectedResponseException - an unexpected response was returned from the server

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

PropertyServerException - property server exception

Client library Exceptions

purgeTerm

public void purgeTerm(String userId,
                      String guid)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      MetadataServerUncontactableException,
                      UnrecognizedGUIDException,
                      FunctionNotSupportedException,
                      EntityNotPurgedException,
                      PropertyServerException

Description copied from interface: SubjectAreaTerm

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:

InvalidParameterException - one of the parameters is null or invalid.

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

MetadataServerUncontactableException - Unable to contact the server

UnrecognizedGUIDException - the supplied guid was not recognised

FunctionNotSupportedException - Function not supported

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

PropertyServerException - property server exception Client library Exceptions

restoreTerm

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

Specified by:

restoreTerm in interface SubjectAreaTerm

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

PropertyServerException - property server exception

Client library Exceptions

findTerm

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

Find Term

Specified by:

findTerm in interface SubjectAreaTerm

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

PropertyServerException - property server exception

Client library Exceptions