org.odpi.openmetadata.accessservices.subjectarea.client

Class SubjectAreaCategoryImpl

java.lang.Object

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 SubjectAreaImpl OMAS. This interface provides glossary category authoring interfaces for subject area experts.

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaBaseImpl

omasServerURL, serverName

Constructor Summary

Constructors

Constructor and Description
SubjectAreaCategoryImpl(String omasServerURL, String serverName) Default Constructor used once a connector is created.

Method Summary

Modifier and Type	Method and Description
Category	createCategory(String serverName, String userId, Category suppliedCategory) Create a Category
SubjectAreaDefinition	createSubjectAreaDefinition(String serverName, String userId, SubjectAreaDefinition suppliedSubjectAreaDefinition) Create a SubjectAreaDefinition
Category	deleteCategory(String serverName, String userId, String guid) 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.
SubjectAreaDefinition	deleteSubjectAreaDefinition(String serverName, String userId, String guid) 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.
List<Category>	findCategory(String serverName, String userId, String searchCriteria, Date asOfTime, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Find Category
Category	getCategoryByGuid(String serverName, String userId, String guid) Get a category by guid.
List<Line>	getCategoryRelationships(String serverName, String userId, String guid, Date asOfTime, int offset, int pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Get Category relationships
SubjectAreaDefinition	getSubjectAreaDefinitionByGuid(String serverName, String userId, String guid) Get a subjectAreaDefinition by guid.
void	purgeCategory(String serverName, String userId, String guid) Purge a Category instance A purge means that the category will not exist after the operation.
void	purgeSubjectAreaDefinition(String serverName, String userId, String guid) Purge a SubjectAreaDefinition instance A purge means that the subjectAreaDefinition will not exist after the operation.
Category	replaceCategory(String serverName, String userId, String guid, Category suppliedCategory) Replace a Category.
SubjectAreaDefinition	replaceSubjectAreaDefinition(String serverName, String userId, String guid, SubjectAreaDefinition suppliedSubjectAreaDefinition) Replace a SubjectAreaDefinition.
Category	restoreCategory(String serverName, String userId, String guid) Restore a Category Restore allows the deleted Category to be made active again.
SubjectAreaDefinition	restoreSubjectAreaDefinition(String serverName, String userId, String guid) Restore a SubjectAreaDefinition Restore allows the deleted SubjectArea to be made active again.
Category	updateCategory(String serverName, String userId, String guid, Category suppliedCategory) Update a Category.
SubjectAreaDefinition	updateSubjectAreaDefinition(String serverName, String userId, String guid, SubjectAreaDefinition suppliedSubjectAreaDefinition) Update a SubjectAreaDefinition.

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.client.SubjectAreaBaseImpl

encodeQueryProperty, getRelationships

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaCategoryImpl

public SubjectAreaCategoryImpl(String omasServerURL,
                               String serverName)

Default Constructor used once a connector is created.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

omasServerURL - unique id for the connector instance

Method Detail

createCategory

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

Create a Category

Specified by:

createCategory in interface SubjectAreaCategory

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getCategoryByGuid

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

Get a category by guid.

Specified by:

getCategoryByGuid in interface SubjectAreaCategory

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getCategoryRelationships

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

Get Category relationships

Specified by:

getCategoryRelationships in interface SubjectAreaCategory

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

guid - guid of the category to get

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

findCategory

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

Find Category

Specified by:

findCategory in interface SubjectAreaCategory

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

replaceCategory

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

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:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

updateCategory

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

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:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

deleteCategory

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

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:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

purgeCategory

public void purgeCategory(String serverName,
                          String userId,
                          String guid)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          MetadataServerUncontactableException,
                          GUIDNotPurgedException,
                          FunctionNotSupportedException

Purge a Category instance A purge means that the category will not exist after the operation.

Specified by:

purgeCategory in interface SubjectAreaCategory

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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.

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

FunctionNotSupportedException - Function not supported. Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

restoreCategory

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

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:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

createSubjectAreaDefinition

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

Create a SubjectAreaDefinition

Specified by:

createSubjectAreaDefinition in interface SubjectAreaCategory

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

getSubjectAreaDefinitionByGuid

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

Get a subjectAreaDefinition by guid.

Specified by:

getSubjectAreaDefinitionByGuid in interface SubjectAreaCategory

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

replaceSubjectAreaDefinition

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

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:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

updateSubjectAreaDefinition

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

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:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

deleteSubjectAreaDefinition

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

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:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

purgeSubjectAreaDefinition

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

Purge a SubjectAreaDefinition instance A purge means that the subjectAreaDefinition will not exist after the operation.

Specified by:

purgeSubjectAreaDefinition in interface SubjectAreaCategory

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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.

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

restoreSubjectAreaDefinition

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

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:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

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

guid - guid of the subject area definition to restore

Returns:

the restored subvject 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