Package org.odpi.openmetadata.frameworks.governanceaction.client

Interface ValidMetadataValuesInterface

All Known Implementing Classes:

OpenMetadataClient, OpenMetadataClientBase, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreHandler

public interface ValidMetadataValuesInterface

ValidMetadataValuesInterface maintains valid value sets for the properties found in open metadata elements. Valid values can be set up for a property name within a specific type - or for all types that use that property name. The named property may be a string type, and array of string or a map of names to string values.

Method Summary

Modifier and Type	Method	Description
void	clearValidMetadataMapName(String userId, String typeName, String propertyName, String preferredValue)	Remove a valid map name value for a property.
void	clearValidMetadataMapValue(String userId, String typeName, String propertyName, String mapName, String preferredValue)	Remove a valid map name value for a property.
void	clearValidMetadataValue(String userId, String typeName, String propertyName, String preferredValue)	Remove a valid value for a property.
List<ValidMetadataValue>	getConsistentMetadataValues(String userId, String typeName, String propertyName, String mapName, String preferredValue, int startFrom, int pageSize)	Retrieve all the consistent valid values for the requested property.
Map<String,List<Map<String,String>>>	getSpecification(String userId, String elementGUID)	Retrieve the reference data for this element.
ValidMetadataValue	getValidMetadataMapName(String userId, String typeName, String propertyName, String preferredValue)	Retrieve details of a specific valid name for a map property.
ValidMetadataValue	getValidMetadataMapValue(String userId, String typeName, String propertyName, String mapName, String preferredValue)	Retrieve details of a specific valid value for a map name.
ValidMetadataValue	getValidMetadataValue(String userId, String typeName, String propertyName, String preferredValue)	Retrieve details of a specific valid value for a property.
List<ValidMetadataValueDetail>	getValidMetadataValues(String userId, String typeName, String propertyName, int startFrom, int pageSize)	Retrieve all the valid values for the requested property.
void	setConsistentMetadataValues(String userId, String typeName1, String propertyName1, String mapName1, String preferredValue1, String typeName2, String propertyName2, String mapName2, String preferredValue2)	Set up consistent metadata values relationship between the two property values.
void	setUpValidMetadataMapName(String userId, String typeName, String propertyName, ValidMetadataValue validMetadataValue)	Create or update the valid value for a name that can be stored in a particular open metadata property name.
void	setUpValidMetadataMapValue(String userId, String typeName, String propertyName, String mapName, ValidMetadataValue validMetadataValue)	Create or update the valid value for a name that can be stored in a particular open metadata property name.
void	setUpValidMetadataValue(String userId, String typeName, String propertyName, ValidMetadataValue validMetadataValue)	Create or update the valid value for a particular open metadata property.
boolean	validateMetadataMapName(String userId, String typeName, String propertyName, String actualValue)	Validate whether the name found in an open metadata map property is valid.
boolean	validateMetadataMapValue(String userId, String typeName, String propertyName, String mapName, String actualValue)	Validate whether the name found in an open metadata map property is valid.
boolean	validateMetadataValue(String userId, String typeName, String propertyName, String actualValue)	Validate whether the value found in an open metadata property is valid.

Method Details

setUpValidMetadataValue

void setUpValidMetadataValue(String userId,
 String typeName,
 String propertyName,
 ValidMetadataValue validMetadataValue)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create or update the valid value for a particular open metadata property. This property may be of type string or an array of strings. The valid value is stored in the preferredValue property of validMetadataValue. If the property is of type string, this property can be stored as the property value. If the property is an array of strings, an element in the array can be of this value. If the typeName is null, this valid value applies to properties of this name from any open metadata type. If a valid value is already set up for this property (with overlapping effective dates) then the valid value is updated.

Parameters:

userId - caller's userId

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

validMetadataValue - preferred value to use in the open metadata types plus additional descriptive values.

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

setUpValidMetadataMapName

void setUpValidMetadataMapName(String userId,
 String typeName,
 String propertyName,
 ValidMetadataValue validMetadataValue)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create or update the valid value for a name that can be stored in a particular open metadata property name. This property is of type map from name to string. The valid value is stored in the preferredValue property of validMetadataValue. If the typeName is null, this valid value applies to properties of this name from any open metadata type. If a valid value is already set up for this property (with overlapping effective dates) then the valid value is updated.

Parameters:

userId - caller's userId

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

validMetadataValue - preferred value to use in the open metadata types plus additional descriptive values.

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

setUpValidMetadataMapValue

void setUpValidMetadataMapValue(String userId,
 String typeName,
 String propertyName,
 String mapName,
 ValidMetadataValue validMetadataValue)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create or update the valid value for a name that can be stored in a particular open metadata property name. This property is of type map from name to string. The valid value is stored in the preferredValue property of validMetadataValue. If the typeName is null, this valid value applies to properties of this name from any open metadata type. If a valid value is already set up for this property (with overlapping effective dates) then the valid value is updated.

Parameters:

userId - caller's userId

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

mapName - name in the map that this valid value applies. If null then the value can be used for any name in the map.

validMetadataValue - preferred value to use in the open metadata types plus additional descriptive values.

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

clearValidMetadataValue

void clearValidMetadataValue(String userId,
 String typeName,
 String propertyName,
 String preferredValue)
                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a valid value for a property. The match is done on preferred name.

Parameters:

userId - caller's userId

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

preferredValue - specific valid value to remove

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

clearValidMetadataMapName

void clearValidMetadataMapName(String userId,
 String typeName,
 String propertyName,
 String preferredValue)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a valid map name value for a property. The match is done on preferred name.

Parameters:

userId - caller's userId

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

preferredValue - specific valid value to remove

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

clearValidMetadataMapValue

void clearValidMetadataMapValue(String userId,
 String typeName,
 String propertyName,
 String mapName,
 String preferredValue)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a valid map name value for a property. The match is done on preferred name.

Parameters:

userId - caller's userId

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

mapName - name in the map that this valid value applies. If null then the value can be used for any name in the map.

preferredValue - specific valid value to remove

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

validateMetadataValue

boolean validateMetadataValue(String userId,
 String typeName,
 String propertyName,
 String actualValue)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Validate whether the value found in an open metadata property is valid.

Parameters:

userId - caller's userId

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

actualValue - value stored in the property - if this is null, true is only returned if null is set up as a valid value.

Returns:

boolean flag - true if the value is one of the defined valid values or there are no valid values set up for the property (and so any value is value).

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

validateMetadataMapName

boolean validateMetadataMapName(String userId,
 String typeName,
 String propertyName,
 String actualValue)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Validate whether the name found in an open metadata map property is valid.

Parameters:

userId - caller's userId

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

actualValue - value stored in the property - if this is null, true is only returned if null is set up as a valid value.

Returns:

boolean flag - true if the value is one of the defined valid values or there are no valid values set up for the property (and so any value is value).

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

validateMetadataMapValue

boolean validateMetadataMapValue(String userId,
 String typeName,
 String propertyName,
 String mapName,
 String actualValue)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Validate whether the name found in an open metadata map property is valid.

Parameters:

userId - caller's userId

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

mapName - name in the map that this valid value applies. If null then the value can be used for any name in the map.

actualValue - value stored in the property - if this is null, true is only returned if null is set up as a valid value.

Returns:

boolean flag - true if the value is one of the defined valid values or there are no valid values set up for the property (and so any value is value).

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

getValidMetadataValue

ValidMetadataValue getValidMetadataValue(String userId,
 String typeName,
 String propertyName,
 String preferredValue)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve details of a specific valid value for a property.

Parameters:

userId - caller's userId

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

preferredValue - valid value to match

Returns:

specific valid value definition or none if there is no definition stored

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

getValidMetadataMapName

ValidMetadataValue getValidMetadataMapName(String userId,
 String typeName,
 String propertyName,
 String preferredValue)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve details of a specific valid name for a map property.

Parameters:

userId - caller's userId

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

preferredValue - valid value to match

Returns:

specific valid value definition or none if there is no definition stored

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

getValidMetadataMapValue

ValidMetadataValue getValidMetadataMapValue(String userId,
 String typeName,
 String propertyName,
 String mapName,
 String preferredValue)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve details of a specific valid value for a map name.

Parameters:

userId - caller's userId

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

mapName - name in the map that this valid value applies. If null then the value can be used for any name in the map.

preferredValue - valid value to match

Returns:

specific valid value definition or none if there is no definition stored

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

getValidMetadataValues

List<ValidMetadataValueDetail> getValidMetadataValues(String userId,
 String typeName,
 String propertyName,
 int startFrom,
 int pageSize)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve all the valid values for the requested property.

Parameters:

userId - caller's userId

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of valid values defined for the property

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

getConsistentMetadataValues

List<ValidMetadataValue> getConsistentMetadataValues(String userId,
 String typeName,
 String propertyName,
 String mapName,
 String preferredValue,
 int startFrom,
 int pageSize)
                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve all the consistent valid values for the requested property.

Parameters:

userId - caller's userId

typeName - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName - name of property that this valid value applies

mapName - optional name of map key that this valid value applies

preferredValue - the value to match against

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of valid values defined for the property

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

setConsistentMetadataValues

void setConsistentMetadataValues(String userId,
 String typeName1,
 String propertyName1,
 String mapName1,
 String preferredValue1,
 String typeName2,
 String propertyName2,
 String mapName2,
 String preferredValue2)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Set up consistent metadata values relationship between the two property values.

Parameters:

userId - caller's userId

typeName1 - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName1 - name of property that this valid value applies

mapName1 - optional name of map key that this valid value applies

preferredValue1 - the value to match against

typeName2 - type name if this is valid value is specific for a type, or null if this valid value if for the property name for all types

propertyName2 - name of property that this valid value applies

mapName2 - optional name of map key that this valid value applies

preferredValue2 - the value to match against

Throws:

InvalidParameterException - the property name is null or not known.

UserNotAuthorizedException - the service is not able to create/access the element

PropertyServerException - there is a problem accessing the metadata store

getSpecification

Map<String,List<Map<String,String>>> getSpecification(String userId,
 String elementGUID)
                                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Retrieve the reference data for this element.

Parameters:

userId - calling user

elementGUID - element to query

Returns:

map of reference data

Throws:

InvalidParameterException - bad parameter

PropertyServerException - repository error

UserNotAuthorizedException - authorization issue