org.odpi.openmetadata.accessservices.assetowner.api

Interface AssetOnboardingValidValues

public interface AssetOnboardingValidValues

AssetOnboardingValidValues provides the API operations to create and maintain lists of valid value definitions grouped into a valid value set. Both valid value definitions and valid value sets have the same attributes and so inherit from ValidValue where all of the attributes are defined. A set is just grouping of valid values. Valid value definitions and set can be nested many times in other valid value sets.

Method Summary

Modifier and Type	Method and Description
void	attachValidValueToSet(String userId, String setGUID, String validValueGUID) Create a link between a valid value set or definition and a set.
String	createValidValueDefinition(String userId, String setGUID, String qualifiedName, String displayName, String description, String usage, String scope, String preferredValue, Map<String,String> additionalProperties, Map<String,Object> extendedProperties) Create a new valid value definition.
String	createValidValueSet(String userId, String qualifiedName, String displayName, String description, String usage, String scope, Map<String,String> additionalProperties, Map<String,Object> extendedProperties) Create a new valid value set.
void	deleteValidValue(String userId, String validValueGUID, String qualifiedName) Remove the valid value form the repository.
void	detachValidValueFromSet(String userId, String setGUID, String validValueGUID) Remove the link between a valid value and a set it is a member of.
List<ValidValueElement>	findValidValues(String userId, String searchString, int startFrom, int pageSize) Locate valid values that match the search string.
List<ValidValueElement>	getSetsForValidValue(String userId, String validValueGUID, int startFrom, int pageSize) Page through the list of valid value sets that a valid value definition/set belongs to.
ValidValueElement	getValidValueByGUID(String userId, String validValueGUID) Retrieve a specific valid value from the repository.
List<ValidValueElement>	getValidValueByName(String userId, String validValueName, int startFrom, int pageSize) Retrieve a specific valid value from the repository.
List<ValidValueElement>	getValidValueSetMembers(String userId, String validValueSetGUID, int startFrom, int pageSize) Page through the members of a valid value set.
void	updateValidValue(String userId, String validValueGUID, String qualifiedName, String displayName, String description, String usage, String scope, String preferredValue, boolean isDeprecated, Map<String,String> additionalProperties, Map<String,Object> extendedProperties) Update the properties of the valid value.

Method Detail

createValidValueSet

String createValidValueSet(String userId,
                           String qualifiedName,
                           String displayName,
                           String description,
                           String usage,
                           String scope,
                           Map<String,String> additionalProperties,
                           Map<String,Object> extendedProperties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Create a new valid value set. This just creates the Set itself. Members are added either as they are created, or they can be attached to a set after they are created.

Parameters:

userId - calling user.

qualifiedName - unique name.

displayName - displayable descriptive name.

description - further information.

usage - how/when should this set be used.

scope - what is the scope of this set's values.

additionalProperties - additional properties for this set.

extendedProperties - properties that need to be populated into a subtype.

Returns:

unique identifier for the new set

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

createValidValueDefinition

String createValidValueDefinition(String userId,
                                  String setGUID,
                                  String qualifiedName,
                                  String displayName,
                                  String description,
                                  String usage,
                                  String scope,
                                  String preferredValue,
                                  Map<String,String> additionalProperties,
                                  Map<String,Object> extendedProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Create a new valid value definition.

Parameters:

userId - calling user.

setGUID - unique identifier of the set to attach this to.

qualifiedName - unique name.

displayName - displayable descriptive name.

description - further information.

usage - how/when should this value be used.

scope - what is the scope of the values.

preferredValue - the value that should be used in an implementation if possible.

additionalProperties - additional properties for this definition.

extendedProperties - properties that need to be populated into a subtype.

Returns:

unique identifier for the new definition

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

updateValidValue

void updateValidValue(String userId,
                      String validValueGUID,
                      String qualifiedName,
                      String displayName,
                      String description,
                      String usage,
                      String scope,
                      String preferredValue,
                      boolean isDeprecated,
                      Map<String,String> additionalProperties,
                      Map<String,Object> extendedProperties)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Update the properties of the valid value. All properties are updated. If only changing some if the properties, retrieve the current values from the repository and pass existing values back on this call if they are not to change.

Parameters:

userId - calling user.

validValueGUID - unique identifier of the valid value.

qualifiedName - unique name.

displayName - displayable descriptive name.

description - further information.

usage - how/when should this value be used.

scope - what is the scope of the values.

preferredValue - the value that should be used in an implementation if possible.

isDeprecated - is this value deprecated?

additionalProperties - additional properties for this valid value.

extendedProperties - properties that need to be populated into a subtype.

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

deleteValidValue

void deleteValidValue(String userId,
                      String validValueGUID,
                      String qualifiedName)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Remove the valid value form the repository. All links to it are deleted too.

Parameters:

userId - calling user

validValueGUID - unique identifier of the value to delete

qualifiedName - unique name of the value to delete. This is used to verify that the correct valid value is being deleted.

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

attachValidValueToSet

void attachValidValueToSet(String userId,
                           String setGUID,
                           String validValueGUID)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Create a link between a valid value set or definition and a set. This means the valid value is a member of the set.

Parameters:

userId - calling user.

setGUID - unique identifier of the set.

validValueGUID - unique identifier of the valid value to add to the set.

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

detachValidValueFromSet

void detachValidValueFromSet(String userId,
                             String setGUID,
                             String validValueGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Remove the link between a valid value and a set it is a member of.

Parameters:

userId - calling user

setGUID - owning set

validValueGUID - unique identifier of the member to be removed.

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

getValidValueByGUID

ValidValueElement getValidValueByGUID(String userId,
                                      String validValueGUID)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Retrieve a specific valid value from the repository.

Parameters:

userId - calling user

validValueGUID - unique identifier of the valid value.

Returns:

Valid value bean

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

getValidValueByName

List<ValidValueElement> getValidValueByName(String userId,
                                            String validValueName,
                                            int startFrom,
                                            int pageSize)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Retrieve a specific valid value from the repository. Duplicates may be returned if multiple valid values have been assigned the same qualified name.

Parameters:

userId - calling user

validValueName - qualified name of the valid value.

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

Returns:

Valid value beans

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

findValidValues

List<ValidValueElement> findValidValues(String userId,
                                        String searchString,
                                        int startFrom,
                                        int pageSize)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Locate valid values that match the search string. It considers the names, description, scope, usage and preferred value.

Parameters:

userId - calling user

searchString - string value to look for - may contain RegEx characters.

startFrom - paging starting point

pageSize - maximum number of return values.

Returns:

list of valid value beans

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

getValidValueSetMembers

List<ValidValueElement> getValidValueSetMembers(String userId,
                                                String validValueSetGUID,
                                                int startFrom,
                                                int pageSize)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Page through the members of a valid value set.

Parameters:

userId - calling user.

validValueSetGUID - unique identifier of the valid value set.

startFrom - paging starting point

pageSize - maximum number of return values.

Returns:

list of valid value beans

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

getSetsForValidValue

List<ValidValueElement> getSetsForValidValue(String userId,
                                             String validValueGUID,
                                             int startFrom,
                                             int pageSize)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Page through the list of valid value sets that a valid value definition/set belongs to.

Parameters:

userId - calling user.

validValueGUID - unique identifier of valid value to query

startFrom - paging starting point

pageSize - maximum number of return values.

Returns:

list of valid value beans

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.