org.odpi.openmetadata.accessservices.subjectarea.client

Class SubjectAreaCategoryImpl

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

All Implemented Interfaces:

SubjectAreaCategory

public class SubjectAreaCategoryImpl
extends SubjectAreaBaseImpl
implements SubjectAreaCategory

SubjectAreaImpl is the OMAS client library implementation of the Subject Area API This interface provides glossary category authoring interfaces 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
SubjectAreaCategoryImpl(String serverName, String serverPlatformURLRoot) Constructor for no authentication.

Method Summary

Modifier and Type	Method and Description
Category	createCategory(String userId, Category suppliedCategory) Create a Category
SubjectAreaDefinition	createSubjectAreaDefinition(String userId, SubjectAreaDefinition suppliedSubjectAreaDefinition) Create a SubjectAreaDefinition
Category	deleteCategory(String userId, String guid) Delete a Category instance
SubjectAreaDefinition	deleteSubjectAreaDefinition(String userId, String guid) Delete a SubjectAreaDefinition instance
List<Category>	findCategory(String userId, String searchCriteria, Date asOfTime, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Find Category
Category	getCategoryByGuid(String userId, String guid) Get a category by guid.
List<Line>	getCategoryRelationships(String userId, String guid, Date asOfTime, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Get Category relationships
SubjectAreaDefinition	getSubjectAreaDefinitionByGuid(String userId, String guid) Get a subjectAreaDefinition by guid.
void	purgeCategory(String userId, String guid) Purge a Category instance
void	purgeSubjectAreaDefinition(String userId, String guid) Purge a SubjectAreaDefinition instance
Category	replaceCategory(String userId, String guid, Category suppliedCategory) Replace a Category.
SubjectAreaDefinition	replaceSubjectAreaDefinition(String userId, String guid, SubjectAreaDefinition suppliedSubjectAreaDefinition) Replace a SubjectAreaDefinition.
Category	restoreCategory(String userId, String guid) Restore a Category
SubjectAreaDefinition	restoreSubjectAreaDefinition(String userId, String guid) Restore a SubjectAreaDefinition
Category	updateCategory(String userId, String guid, Category suppliedCategory) Update a Category.
SubjectAreaDefinition	updateSubjectAreaDefinition(String userId, String guid, SubjectAreaDefinition suppliedSubjectAreaDefinition) Update a SubjectAreaDefinition.

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

SubjectAreaCategoryImpl

public SubjectAreaCategoryImpl(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

createCategory

public Category createCategory(String userId,
                               Category suppliedCategory)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               UnrecognizedGUIDException,
                               ClassificationException,
                               FunctionNotSupportedException,
                               UnexpectedResponseException,
                               PropertyServerException

Create a Category

Specified by:

createCategory in interface SubjectAreaCategory

Parameters:

userId - userId under which the request is performed

suppliedCategory - Category

Returns:

the created category.

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

UnexpectedResponseException - an unexpected response was returned from the server

getCategoryByGuid

public Category getCategoryByGuid(String userId,
                                  String guid)
                           throws MetadataServerUncontactableException,
                                  UnrecognizedGUIDException,
                                  UserNotAuthorizedException,
                                  InvalidParameterException,
                                  FunctionNotSupportedException,
                                  UnexpectedResponseException,
                                  PropertyServerException

Get a category by guid.

Specified by:

getCategoryByGuid in interface SubjectAreaCategory

Parameters:

userId - userId under which the request is performed

guid - guid of the category to get

Returns:

the requested category.

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

getCategoryRelationships

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

Get Category relationships

Specified by:

getCategoryRelationships in interface SubjectAreaCategory

Parameters:

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

guid - guid of the category 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 Category userId

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

findCategory

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

Find Category

Specified by:

findCategory in interface SubjectAreaCategory

Parameters:

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

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

asOfTime - the categories 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 Categories 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

replaceCategory

public Category replaceCategory(String userId,
                                String guid,
                                Category suppliedCategory)
                         throws UnexpectedResponseException,
                                UserNotAuthorizedException,
                                FunctionNotSupportedException,
                                InvalidParameterException,
                                MetadataServerUncontactableException,
                                PropertyServerException

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

Status is not updated using this call.

Specified by:

replaceCategory in interface SubjectAreaCategory

Parameters:

userId - userId under which the request is performed

guid - guid of the category to update

suppliedCategory - category to be updated

Returns:

replaced category

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

PropertyServerException - property server exception

Client library Exceptions

updateCategory

public Category updateCategory(String userId,
                               String guid,
                               Category suppliedCategory)
                        throws UnexpectedResponseException,
                               UserNotAuthorizedException,
                               FunctionNotSupportedException,
                               InvalidParameterException,
                               MetadataServerUncontactableException,
                               PropertyServerException

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

If the caller has chosen to incorporate the category name in their Category Categorys or Categories qualified name, renaming the category will cause those qualified names to mismatch the Category name. If the caller has chosen to incorporate the category qualifiedName in their Category Categorys or Categories qualified name, changing the qualified name of the category will cause those qualified names to mismatch the Category name. Status is not updated using this call.

Specified by:

updateCategory in interface SubjectAreaCategory

Parameters:

userId - userId under which the request is performed

guid - guid of the category to update

suppliedCategory - category to be updated

Returns:

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

PropertyServerException - property server exception

Client library Exceptions

deleteCategory

public Category deleteCategory(String userId,
                               String guid)
                        throws InvalidParameterException,
                               MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               FunctionNotSupportedException,
                               UnexpectedResponseException,
                               EntityNotDeletedException,
                               PropertyServerException

Delete a Category instance

A delete (also known as a soft delete) means that the category 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:

deleteCategory in interface SubjectAreaCategory

Parameters:

userId - userId under which the request is performed

guid - guid of the category to be deleted.

Returns:

the deleted category 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.

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

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

purgeCategory

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

Purge a Category instance

A purge means that the category will not exist after the operation.

Specified by:

purgeCategory in interface SubjectAreaCategory

Parameters:

userId - userId under which the request is performed

guid - guid of the category 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.

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

FunctionNotSupportedException - Function not supported. Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

PropertyServerException - property server exception

Client library Exceptions

restoreCategory

public Category restoreCategory(String userId,
                                String guid)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                MetadataServerUncontactableException,
                                UnrecognizedGUIDException,
                                FunctionNotSupportedException,
                                UnexpectedResponseException,
                                PropertyServerException

Restore a Category

Restore allows the deleted Category 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:

restoreCategory in interface SubjectAreaCategory

Parameters:

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

guid - guid of the category to restore

Returns:

the restored category

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

createSubjectAreaDefinition

public SubjectAreaDefinition createSubjectAreaDefinition(String userId,
                                                         SubjectAreaDefinition suppliedSubjectAreaDefinition)
                                                  throws MetadataServerUncontactableException,
                                                         InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         UnrecognizedGUIDException,
                                                         ClassificationException,
                                                         FunctionNotSupportedException,
                                                         UnexpectedResponseException,
                                                         PropertyServerException

Create a SubjectAreaDefinition

Specified by:

createSubjectAreaDefinition in interface SubjectAreaCategory

Parameters:

userId - userId under which the request is performed

suppliedSubjectAreaDefinition - SubjectAreaDefinition

Returns:

the created subjectAreaDefinition.

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

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

getSubjectAreaDefinitionByGuid

public SubjectAreaDefinition getSubjectAreaDefinitionByGuid(String userId,
                                                            String guid)
                                                     throws MetadataServerUncontactableException,
                                                            UnrecognizedGUIDException,
                                                            UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            FunctionNotSupportedException,
                                                            UnexpectedResponseException,
                                                            PropertyServerException

Get a subjectAreaDefinition by guid.

Specified by:

getSubjectAreaDefinitionByGuid in interface SubjectAreaCategory

Parameters:

userId - userId under which the request is performed

guid - guid of the subjectAreaDefinition to get

Returns:

the requested subjectAreaDefinition.

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

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

replaceSubjectAreaDefinition

public SubjectAreaDefinition replaceSubjectAreaDefinition(String userId,
                                                          String guid,
                                                          SubjectAreaDefinition suppliedSubjectAreaDefinition)
                                                   throws UnexpectedResponseException,
                                                          UserNotAuthorizedException,
                                                          InvalidParameterException,
                                                          MetadataServerUncontactableException,
                                                          PropertyServerException,
                                                          FunctionNotSupportedException

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

Status is not updated using this call.

Specified by:

replaceSubjectAreaDefinition in interface SubjectAreaCategory

Parameters:

userId - userId under which the request is performed

guid - guid of the subjectAreaDefinition to update

suppliedSubjectAreaDefinition - subjectAreaDefinition to be updated

Returns:

replaced subjectAreaDefinition

Throws:

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

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

PropertyServerException - property server exception

Client library Exceptions

FunctionNotSupportedException - Function not supported

updateSubjectAreaDefinition

public SubjectAreaDefinition updateSubjectAreaDefinition(String userId,
                                                         String guid,
                                                         SubjectAreaDefinition suppliedSubjectAreaDefinition)
                                                  throws UnexpectedResponseException,
                                                         UserNotAuthorizedException,
                                                         InvalidParameterException,
                                                         MetadataServerUncontactableException,
                                                         PropertyServerException,
                                                         FunctionNotSupportedException

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

If the caller has chosen to incorporate the subjectAreaDefinition name in their SubjectAreaDefinition SubjectAreaDefinitions or Categories qualified name, renaming the subjectAreaDefinition will cause those qualified names to mismatch the SubjectAreaDefinition name. If the caller has chosen to incorporate the subjectAreaDefinition qualifiedName in their SubjectAreaDefinition SubjectAreaDefinitions or Categories qualified name, changing the qualified name of the subjectAreaDefinition will cause those qualified names to mismatch the SubjectAreaDefinition name. Status is not updated using this call.

Specified by:

updateSubjectAreaDefinition in interface SubjectAreaCategory

Parameters:

userId - userId under which the request is performed

guid - guid of the subjectAreaDefinition to update

suppliedSubjectAreaDefinition - subjectAreaDefinition to be updated

Returns:

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

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

FunctionNotSupportedException - Function not supported

deleteSubjectAreaDefinition

public SubjectAreaDefinition deleteSubjectAreaDefinition(String userId,
                                                         String guid)
                                                  throws InvalidParameterException,
                                                         MetadataServerUncontactableException,
                                                         UserNotAuthorizedException,
                                                         FunctionNotSupportedException,
                                                         UnexpectedResponseException,
                                                         EntityNotDeletedException,
                                                         PropertyServerException

Delete a SubjectAreaDefinition instance

A delete (also known as a soft delete) means that the subjectAreaDefinition 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:

deleteSubjectAreaDefinition in interface SubjectAreaCategory

Parameters:

userId - userId under which the request is performed

guid - guid of the subjectAreaDefinition to be deleted.

Returns:

the deleted subjectAreaDefinition

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 subjectAreaDefinition was not deleted.

MetadataServerUncontactableException - unable to contact server

UnexpectedResponseException - an unexpected response was returned from the server

PropertyServerException - property server exception

Client library Exceptions

purgeSubjectAreaDefinition

public void purgeSubjectAreaDefinition(String userId,
                                       String guid)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       MetadataServerUncontactableException,
                                       EntityNotPurgedException,
                                       UnexpectedResponseException,
                                       PropertyServerException,
                                       FunctionNotSupportedException

Purge a SubjectAreaDefinition instance

A purge means that the subjectAreaDefinition will not exist after the operation.

Specified by:

purgeSubjectAreaDefinition in interface SubjectAreaCategory

Parameters:

userId - userId under which the request is performed

guid - guid of the subjectAreaDefinition to be deleted.

Throws:

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

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

FunctionNotSupportedException - Function not supported

restoreSubjectAreaDefinition

public SubjectAreaDefinition restoreSubjectAreaDefinition(String userId,
                                                          String guid)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          MetadataServerUncontactableException,
                                                          UnrecognizedGUIDException,
                                                          FunctionNotSupportedException,
                                                          UnexpectedResponseException,
                                                          PropertyServerException

Restore a SubjectAreaDefinition

Restore allows the deleted SubjectArea 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:

restoreSubjectAreaDefinition in interface SubjectAreaCategory

Parameters:

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

guid - guid of the subject area definition to restore

Returns:

the restored subject area definition

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