Package org.odpi.openmetadata.commonservices.gaf.api

Interface ValidMetadataValuesInterface

All Known Implementing Classes:

GovernanceEngineClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClient, OpenMetadataStoreClientBase

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.

Method Summary

Modifier and Type	Method	Description
void	clearValidMetadataValue(java.lang.String userId, java.lang.String typeName, java.lang.String propertyName, java.lang.String preferredValue)	Remove a valid value for a property.
ValidMetadataValue	getValidMetadataValue(java.lang.String userId, java.lang.String typeName, java.lang.String propertyName, java.lang.String preferredValue)	Retrieve details of a specific valid value for a property.
java.util.List<ValidMetadataValue>	getValidMetadataValues(java.lang.String userId, java.lang.String typeName, java.lang.String propertyName, int startFrom, int pageSize)	Retrieve all the valid values for the requested property.
void	setUpValidMetadataValue(java.lang.String userId, java.lang.String typeName, java.lang.String propertyName, ValidMetadataValue validMetadataValue)	Create or update the valid value for a particular open metadata property name.
boolean	validateMetadataValue(java.lang.String userId, java.lang.String typeName, java.lang.String propertyName, java.lang.String actualValue)	Validate whether the value found in an open metadata property is valid.

Method Detail

setUpValidMetadataValue

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

Create or update the valid value for a particular open metadata property name. If the typeName is null, this valid value applies to properties of this name from all types. The valid value is stored in the preferredValue property. 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

clearValidMetadataValue

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

Remove a 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 - 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(java.lang.String userId,
                              java.lang.String typeName,
                              java.lang.String propertyName,
                              java.lang.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

getValidMetadataValue

ValidMetadataValue getValidMetadataValue(java.lang.String userId,
                                         java.lang.String typeName,
                                         java.lang.String propertyName,
                                         java.lang.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

getValidMetadataValues

java.util.List<ValidMetadataValue> getValidMetadataValues(java.lang.String userId,
                                                          java.lang.String typeName,
                                                          java.lang.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