org.odpi.openmetadata.accessservices.subjectarea

Interface SubjectAreaCategory

All Known Implementing Classes:

SubjectAreaCategoryImpl

public interface SubjectAreaCategory

The SubjectAreaDefinition Open Metadata Access Service (OMAS) API for categories.

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 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 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 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 A purge means that the category will not exist after the operation.
void	purgeSubjectAreaDefinition(String userId, String guid) Purge a SubjectAreaDefinition instance A purge means that the subjectAreaDefinition will not exist after the operation.
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 Restore allows the deleted Category to be made active again.
SubjectAreaDefinition	restoreSubjectAreaDefinition(String userId, String guid) Restore a SubjectAreaDefinition Restore allows the deleted Subject Area to be made active again.
Category	updateCategory(String userId, String guid, Category suppliedCategory) Update a Category.
SubjectAreaDefinition	updateSubjectAreaDefinition(String userId, String guid, SubjectAreaDefinition suppliedSubjectAreaDefinition) Update a SubjectAreaDefinition.

Method Detail

createCategory

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

Create a Category

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

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

getCategoryByGuid

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

Get a category by guid.

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

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

replaceCategory

Category replaceCategory(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.

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

updateCategory

Category updateCategory(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.

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.

FunctionNotSupportedException - Function not supported Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

deleteCategory

Category deleteCategory(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.

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.

FunctionNotSupportedException - Function not supported Client library Exceptions

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

purgeCategory

void purgeCategory(String userId,
                   String guid)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   MetadataServerUncontactableException,
                   FunctionNotSupportedException,
                   GUIDNotPurgedException,
                   UnrecognizedGUIDException,
                   UnexpectedResponseException

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

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.

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

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

restoreCategory

Category restoreCategory(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.

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

createSubjectAreaDefinition

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

Create a SubjectAreaDefinition

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

getSubjectAreaDefinitionByGuid

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

Get a subjectAreaDefinition by guid.

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

getCategoryRelationships

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

Get Category relationships

Parameters:

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

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

Find Category

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

replaceSubjectAreaDefinition

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

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

Status is not updated using this call.

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.

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

updateSubjectAreaDefinition

SubjectAreaDefinition updateSubjectAreaDefinition(String userId,
                                                  String guid,
                                                  SubjectAreaDefinition suppliedSubjectAreaDefinition)
                                           throws UnexpectedResponseException,
                                                  UserNotAuthorizedException,
                                                  FunctionNotSupportedException,
                                                  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.

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.

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

deleteSubjectAreaDefinition

SubjectAreaDefinition deleteSubjectAreaDefinition(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.

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

MetadataServerUncontactableException - Unable to contact the server

UnexpectedResponseException - an unexpected response was returned from the server

purgeSubjectAreaDefinition

void purgeSubjectAreaDefinition(String userId,
                                String guid)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                MetadataServerUncontactableException,
                                GUIDNotPurgedException,
                                UnrecognizedGUIDException,
                                FunctionNotSupportedException,
                                UnexpectedResponseException

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

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.

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

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

restoreSubjectAreaDefinition

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

Restore a SubjectAreaDefinition Restore allows the deleted Subject Area 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 subject area to restore

Returns:

the restored subject area

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