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

Interface GlossaryAuthorViewRelationships

All Known Implementing Classes:

GlossaryAuthorViewRelationshipsClient

public interface GlossaryAuthorViewRelationships

Method Summary

Modifier and Type	Method	Description
Relationship	create(String userId, Relationship relationship)	Create a Relationship.
void	delete(String userId, String guid)	Delete a Relationship.
List<Relationship>	find(String userId, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Extract children within a Relationship
List<Relationship>	findAll(String userId)	Find Category
Relationship	getByGUID(String userId, String guid)	Get a Relationship.
List<Category>	getCategories(String userId, String relationshipGuid, FindRequest findRequest)	Extract categories for a Relationship
List<Category>	getCategoryChildren(String userId, String parentGuid, FindRequest findRequest, boolean exactValue, boolean ignoreCase)	Extract children within a Category
OMAGServerConfig	getConfig(String userId)	Get config for server
ViewServiceConfig	getGlossaryAuthViewServiceConfig(String userId)	Get service config for a particular view Service
List<ViewServiceConfig>	getViewServiceConfigs(String userId)	Get list of view service config on the server
Relationship	restore(String userId, String guid)	Restore a soft-deleted Relationship.
Relationship	update(String userId, String guid, Relationship relationship, boolean isReplace)	Update a Relationship.

Method Detail

create

Relationship create(String userId,
                    Relationship relationship)
             throws PropertyServerException,
                    UserNotAuthorizedException,
                    InvalidParameterException

Create a Relationship.

The result is the Relationship object

Parameters:

userId - userId under which the request is performed

relationship - Relationship object to be created

Returns:

The Relationship

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

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

Get a Relationship.

The result is the requested Relationship object

Parameters:

userId - userId under which the request is performed

guid - guid of Relationship object to be retrieved

Returns:

The requested Relationship

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

Relationship update(String userId,
                    String guid,
                    Relationship relationship,
                    boolean isReplace)
             throws PropertyServerException,
                    InvalidParameterException,
                    UserNotAuthorizedException

Update a Relationship.

The result is the updated Glossary object

Parameters:

userId - userId under which the request is performed

guid - guid of Glossary object to be updated

relationship - Glossary object with updated values

isReplace - If the object is to be replaced

Returns:

The updated Relationship

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

The result Void object

Parameters:

userId - userId under which the request is performed

guid - guid of Relationship object to be retrieved

Throws:

PropertyServerException - something went wrong with the REST call stack.

restore

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

Restore a soft-deleted Relationship.

The result is the restored Relationship object

Parameters:

userId - userId under which the request is performed

guid - guid of Relationship object to be restored

Returns:

The restored Relationship

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<Relationship> 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<Relationship> find(String userId,
                        FindRequest findRequest,
                        boolean exactValue,
                        boolean ignoreCase)
                 throws PropertyServerException,
                        UserNotAuthorizedException,
                        InvalidParameterException

Extract children within a Relationship

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

getCategories

List<Category> getCategories(String userId,
                             String relationshipGuid,
                             FindRequest findRequest)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException

Extract categories for a Relationship

Parameters:

userId - calling user

relationshipGuid - RelationShip GUID

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

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

getConfig

OMAGServerConfig getConfig(String userId)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Get config for server

Parameters:

userId - calling user

Returns:

Config for view server

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

getViewServiceConfigs

List<ViewServiceConfig> getViewServiceConfigs(String userId)
                                       throws InvalidParameterException,
                                              PropertyServerException,
                                              UserNotAuthorizedException

Get list of view service config on the server

Parameters:

userId - calling user

Returns:

Config for view server

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

getGlossaryAuthViewServiceConfig

ViewServiceConfig getGlossaryAuthViewServiceConfig(String userId)
                                            throws InvalidParameterException,
                                                   PropertyServerException,
                                                   UserNotAuthorizedException

Get service config for a particular view Service

Parameters:

userId - calling user

Returns:

Config for view server

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