Package org.odpi.openmetadata.viewservices.glossaryauthor.fvt.client.category

Interface GlossaryAuthorViewCategory

All Known Implementing Classes:

GlossaryAuthorViewCategoryClient

public interface GlossaryAuthorViewCategory

Method Summary

Modifier and Type	Method	Description
Category	create(String userId, Category category)	Create a Category.
void	delete(String userId, String guid)	Delete a Category.
List<Category>	find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Extract children within a Category
List<Category>	findAll(String userId)	Find Category
List<Relationship>	getAllRelationships(String userId, String guid)	Get a Category's relationships
Category	getByGUID(String userId, String guid)	Get a Category.
List<Category>	getCategoryChildren(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Extract children within a Category
List<Relationship>	getRelationships(String userId, String guid, FindRequest findRequest)	Get a Category's relationships
List<Term>	getTerms(String userId, String categoryGuid, FindRequest findRequest)	Extract terms within a Category
Category	restore(String userId, String guid)	Restore a soft-deleted Category.
Category	update(String userId, String guid, Category category, boolean isReplace)	Update a Category.

Method Detail

create

Category create(String userId,
                Category category)
         throws PropertyServerException,
                UserNotAuthorizedException,
                InvalidParameterException

Create a Category.

The result is the Category object

Parameters:

userId - userId under which the request is performed

category - Glossary object to be created

Returns:

The Category

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid

getByGUID

Category getByGUID(String userId,
                   String guid)
            throws PropertyServerException,
                   UserNotAuthorizedException,
                   InvalidParameterException

Get a Category.

The result is the requested Category object

Parameters:

userId - userId under which the request is performed

guid - guid of Category object to be retrieved

Returns:

The requested Category

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid

update

Category update(String userId,
                String guid,
                Category category,
                boolean isReplace)
         throws PropertyServerException,
                InvalidParameterException,
                UserNotAuthorizedException

Update a Category.

The result is the updated Glossary object

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be updated

category - Glossary object with updated values

isReplace - If the object is to be replaced

Returns:

The updated Category

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid

delete

void delete(String userId,
            String guid)
     throws PropertyServerException

Delete a Category.

The result Void object

Parameters:

userId - userId under which the request is performed

guid - guid of Category object to be retrieved

Throws:

PropertyServerException - something went wrong with the REST call stack.

restore

Category restore(String userId,
                 String guid)
          throws PropertyServerException,
                 UserNotAuthorizedException,
                 InvalidParameterException

Restore a soft-deleted Category.

The result is the restored Category object

Parameters:

userId - userId under which the request is performed

guid - guid of Category object to be restored

Returns:

The restored Category

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid

getRelationships

List<Relationship> getRelationships(String userId,
                                    String guid,
                                    FindRequest findRequest)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Get a Category's relationships

The result is a list of Relationships

Parameters:

userId - userId under which the request is performed

guid - guid of Category object to be retrieved

findRequest - information object for find calls. This include pageSize to limit the number of elements returned.

Returns:

The list of Category relationships

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid

getAllRelationships

List<Relationship> getAllRelationships(String userId,
                                       String guid)
                                throws PropertyServerException,
                                       UserNotAuthorizedException,
                                       InvalidParameterException

Get a Category's relationships

The result is a list of Relationships

Parameters:

userId - userId under which the request is performed

guid - guid of Category object to be retrieved

Returns:

The list of Category relationships

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid

getTerms

List<Term> getTerms(String userId,
                    String categoryGuid,
                    FindRequest findRequest)
             throws PropertyServerException,
                    UserNotAuthorizedException,
                    InvalidParameterException

Extract terms within a Category

Parameters:

userId - calling user

categoryGuid - Category GUID

findRequest - information object for find calls. This include pageSize to limit the number of elements returned.

Returns:

list of terms

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid

getCategoryChildren

List<Category> getCategoryChildren(String userId,
                                   String parentGuid,
                                   FindRequest findRequest,
                                   boolean exactValue,
                                   boolean ignoreCase)
                            throws PropertyServerException,
                                   UserNotAuthorizedException,
                                   InvalidParameterException

Extract children within a Category

Parameters:

userId - calling user

parentGuid - Category GUID

findRequest - information object for find calls. This include pageSize to limit the number of elements returned.

exactValue - exactValue - when false values with trailing characters will match.

ignoreCase - ignore the case when matching.

Returns:

list of Categories

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid

findAll

List<Category> findAll(String userId)
                throws PropertyServerException,
                       UserNotAuthorizedException,
                       InvalidParameterException

Find Category

Parameters:

userId - calling user

Returns:

Categories belonging to Userid

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid

find

List<Category> find(String userId,
                    FindRequest findRequest,
                    boolean exactValue,
                    boolean ignoreCase)
             throws PropertyServerException,
                    UserNotAuthorizedException,
                    InvalidParameterException

Extract children within a Category

Parameters:

userId - calling user

findRequest - information object for find calls. This include pageSize to limit the number of elements returned.

exactValue - exactValue - when false values with trailing characters will match.

ignoreCase - ignore the case when matching.

Returns:

list of Categories

Throws:

PropertyServerException - something went wrong with the REST call stack.

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

InvalidParameterException - one of the parameters is null or invalid