org.odpi.openmetadata.accessservices.subjectarea

Interface SubjectAreaCategory

All Known Implementing Classes:

SubjectAreaCategoryImpl

public interface SubjectAreaCategory

The SubjectArea 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
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.
Category	getCategoryByGuid(String userid, String guid) Get a category by guid.
void	purgeCategory(String userid, String guid) Purge a Category instance A purge means that the category will not exist after the operation.
Category	replaceCategory(String userid, String guid, Category suppliedCategory) Replace a Category.
Category	updateCategory(String userid, String guid, Category suppliedCategory) Update a Category.

Method Detail

createCategory

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

Create a Category

Parameters:

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

suppliedCategory - category to create

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 - unique identifier for requesting user, 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,
                         UnrecognizedNameException,
                         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 - unique identifier for requesting user, 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

UnrecognizedNameException

updateCategory

Category updateCategory(String userid,
                        String guid,
                        Category suppliedCategory)
                 throws UnexpectedResponseException,
                        UserNotAuthorizedException,
                        UnrecognizedNameException,
                        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 - unique identifier for requesting user, 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

UnrecognizedNameException

deleteCategory

Category deleteCategory(String userid,
                        String guid)
                 throws InvalidParameterException,
                        MetadataServerUncontactableException,
                        UserNotAuthorizedException,
                        UnrecognizedGUIDException,
                        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 - unique identifier for requesting user, under which the request is performed

guid - guid of the category to be deleted.

Returns:

the deleted category

Throws:

UnrecognizedGUIDException - the supplied guid was not recognised

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.

MetadataServerUncontactableException - unable to contact server

UnexpectedResponseException

purgeCategory

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

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

Parameters:

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

guid - guid of the category to be deleted.

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.

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

MetadataServerUncontactableException - unable to contact server

UnexpectedResponseException