Interface OMRSRepositoryValidator


  • public interface OMRSRepositoryValidator
    OMRSRepositoryValidator provides methods to validate TypeDefs and Instances returned from an open metadata repository. It is typically used by OMRS repository connectors and repository event mappers.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int countMatchingHeaderPropertyValues​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties matchProperties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader instanceHeader, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties)
      Count the number of matching property values that an instance has.
      int countMatchingPropertyValues​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties matchProperties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties)
      Count the number of matching property values that an instance has.
      java.math.BigDecimal getNumericRepresentation​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstancePropertyValue value)
      Retrieve a numeric representation of the provided value, or null if it cannot be converted to a number.
      java.lang.String getStringFromPropertyValue​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstancePropertyValue instancePropertyValue)
      Return the string form of a property value.
      java.lang.String getStringValuesFromInstancePropertiesAsArray​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties)
      Return the string form of the instance properties.
      java.lang.String getStringValuesFromInstancePropertiesAsMap​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties)
      Return the string form of the instance properties.
      java.lang.String getStringValuesFromInstancePropertiesAsStruct​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties)
      Return the string form of the instance properties.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef getValidAttributeTypeDefFromIds​(java.lang.String sourceName, java.lang.String guidParameterName, java.lang.String nameParameterName, java.lang.String guid, java.lang.String name, java.lang.String methodName)
      Validate that an AttributeTypeDef's identifiers are not null and are recognized and return the type.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef getValidTypeDefFromIds​(java.lang.String sourceName, java.lang.String guidParameterName, java.lang.String nameParameterName, java.lang.String guid, java.lang.String name, java.lang.String methodName)
      Validate that a TypeDef's identifiers are not null and return the type.
      boolean isActiveType​(java.lang.String sourceName, java.lang.String typeGUID, java.lang.String typeName)
      Return boolean indicating whether the TypeDef/AttributeTypeDef is in use in the repository.
      boolean isActiveTypeId​(java.lang.String sourceName, java.lang.String typeGUID)
      Return boolean indicating whether the TypeDef/AttributeTypeDef is in use in the repository.
      boolean isATypeOf​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader instance, java.lang.String typeName, java.lang.String localMethodName)
      Returns a boolean indicating that the instance is of the supplied type.
      boolean isKnownType​(java.lang.String sourceName, java.lang.String typeGUID, java.lang.String typeName)
      Return boolean indicating whether the TypeDef/AttributeTypeDef is in use in the repository.
      boolean isKnownTypeId​(java.lang.String sourceName, java.lang.String typeGUID)
      Return boolean indicating whether the TypeDef/AttributeTypeDef is in use in the repository.
      boolean isOpenType​(java.lang.String sourceName, java.lang.String typeGUID, java.lang.String typeName)
      Return boolean indicating whether the TypeDef is one of the open metadata types.
      boolean isOpenTypeId​(java.lang.String sourceName, java.lang.String typeGUID)
      Return boolean indicating whether the TypeDef is one of the open metadata types.
      void validateActiveType​(java.lang.String sourceName, java.lang.String typeParameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary typeDefSummary, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefCategory category, java.lang.String methodName)
      Validate that the supplied type is a valid active type.
      void validateAsOfTime​(java.lang.String sourceName, java.lang.String parameterName, java.util.Date asOfTime, java.lang.String methodName)
      Validate that the asOfTime parameter is not for the future.
      void validateAsOfTimeNotNull​(java.lang.String sourceName, java.lang.String parameterName, java.util.Date asOfTime, java.lang.String methodName)
      Validate that the asOfTime parameter is not null or for the future.
      void validateAtMostOneEntityResult​(java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail> findResults, java.lang.String typeName, java.lang.String serviceName, java.lang.String methodName)
      Validate that either zero or one entities were returned from a find request.
      void validateAtMostOneRelationshipResult​(java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship> findResults, java.lang.String typeName, java.lang.String serviceName, java.lang.String methodName)
      Validate that either zero or one relationships were returned from a find request.
      void validateAttributeTypeDef​(java.lang.String sourceName, java.lang.String parameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef attributeTypeDef, java.lang.String methodName)
      Validate the content of a new AttributeTypeDef.
      void validateAttributeTypeDefCategory​(java.lang.String sourceName, java.lang.String nameParameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDefCategory category, java.lang.String methodName)
      Validate that a AttributeTypeDef's category is not null.
      void validateAttributeTypeDefIds​(java.lang.String sourceName, java.lang.String guidParameterName, java.lang.String nameParameterName, java.lang.String guid, java.lang.String name, java.lang.String methodName)
      Validate that an AttributeTypeDef's identifiers are not null.
      void validateClassification​(java.lang.String sourceName, java.lang.String classificationParameterName, java.lang.String classificationName, java.lang.String entityTypeName, java.lang.String methodName)
      Validate that a classification is valid for the entity.
      void validateClassificationList​(java.lang.String sourceName, java.lang.String parameterName, java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification> classifications, java.lang.String entityTypeName, java.lang.String methodName)
      Validate that a classification is valid for the entity.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef validateClassificationName​(java.lang.String sourceName, java.lang.String parameterName, java.lang.String classificationName, java.lang.String methodName)
      Validate that a classification name is not null.
      void validateClassificationProperties​(java.lang.String sourceName, java.lang.String classificationName, java.lang.String propertiesParameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties classificationProperties, java.lang.String methodName)
      Validate that a classification is valid for the entity.
      void validateDateRange​(java.lang.String sourceName, java.lang.String parameterName, java.util.Date fromTime, java.util.Date toTime, java.lang.String methodName)
      Validate that the time parameters are not inverted ('from' later than 'to').
      void validateEnterpriseAttributeTypeDefs​(java.lang.String sourceName, java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef> attributeTypeDefs, java.lang.String methodName)
      Return a boolean flag indicating whether the list of TypeDefs passed are compatible with the all known typedefs.
      void validateEnterpriseTypeDefs​(java.lang.String sourceName, java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef> typeDefs, java.lang.String methodName)
      Return a boolean flag indicating whether the list of TypeDefs passed are compatible with the all known typedefs.
      void validateEntityCanBeRehomed​(java.lang.String sourceName, java.lang.String metadataCollectionId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance, java.lang.String methodName)
      Verify that an entity instance can be rehomed by the metadataCollection.
      void validateEntityCanBeUpdated​(java.lang.String sourceName, java.lang.String metadataCollectionId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance, java.lang.String methodName)
      Verify that an entity instance can be updated by the metadataCollection.
      void validateEntityFromStore​(java.lang.String sourceName, java.lang.String guid, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail entity, java.lang.String methodName)
      Verify that an entity has been successfully retrieved from the repository and has valid contents.
      void validateEntityFromStore​(java.lang.String sourceName, java.lang.String guid, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary entity, java.lang.String methodName)
      Verify that an entity has been successfully retrieved from the repository and has valid contents.
      void validateEntityIsDeleted​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance, java.lang.String methodName)
      Verify the status of an entity to check it has been deleted.
      void validateEntityIsNotDeleted​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance, java.lang.String methodName)
      Verify the status of an entity to check it has not been deleted.
      void validateEntityProxy​(java.lang.String sourceName, java.lang.String localMetadataCollectionId, java.lang.String proxyParameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entityProxy, java.lang.String methodName)
      Validates an entity proxy.
      void validateExternalId​(java.lang.String sourceName, java.lang.String standard, java.lang.String organization, java.lang.String identifier, java.lang.String methodName)
      Validate that the type's name is not null.
      void validateGUID​(java.lang.String sourceName, java.lang.String guidParameterName, java.lang.String guid, java.lang.String methodName)
      Validate that an entity's identifier is not null.
      void validateHomeMetadataGUID​(java.lang.String sourceName, java.lang.String guidParameterName, java.lang.String guid, java.lang.String methodName)
      Validate that a home metadata collection identifier is not null.
      void validateHomeMetadataGUID​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification classification, java.lang.String methodName)
      Validate that a home metadata collection identifier in an classification is not null.
      void validateHomeMetadataGUID​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance, java.lang.String methodName)
      Validate that a home metadata collection identifier in an instance is not null.
      void validateInstanceStatus​(java.lang.String sourceName, java.lang.String instanceStatusParameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus instanceStatus, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef, java.lang.String methodName)
      Validates an instance status where null is permissible.
      void validateInstanceStatusForDelete​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance, java.lang.String methodName)
      Verify that an instance is not already deleted since the repository is processing a delete request and it does not want to look stupid.
      void validateInstanceType​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance)
      Verify that the instance retrieved from the repository has a valid instance type.
      void validateInstanceType​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance, java.lang.String typeGUIDParameterName, java.lang.String typeNameParameterName, java.lang.String expectedTypeGUID, java.lang.String expectedTypeName)
      Verify that the instance retrieved from the repository has a valid instance type that matches the expected type.
      void validateInstanceTypeGUID​(java.lang.String sourceName, java.lang.String guidParameterName, java.lang.String guid, java.lang.String methodName)
      Validate that if a type's identifier is passed then it is valid.
      void validateKnownTypeDef​(java.lang.String sourceName, java.lang.String parameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef, java.lang.String methodName)
      Validate the content of a new TypeDef is known.
      void validateMatchCriteria​(java.lang.String sourceName, java.lang.String matchCriteriaParameterName, java.lang.String matchPropertiesParameterName, MatchCriteria matchCriteria, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties matchProperties, java.lang.String methodName)
      Validate that a metadata instance match criteria and set of properties are either both null or both not null.
      void validateMatchCriteria​(java.lang.String sourceName, java.lang.String parameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefProperties matchCriteria, java.lang.String methodName)
      Validate that a TypeDef match criteria set of properties is not null.
      void validateNewPropertiesForType​(java.lang.String sourceName, java.lang.String parameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Validate that the properties for a metadata instance match its TypeDef
      void validateNewStatus​(java.lang.String sourceName, java.lang.String instanceStatusParameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus instanceStatus, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef, java.lang.String methodName)
      Validates an instance status where null is not allowed.
      void validateOptionalTypeGUID​(java.lang.String sourceName, java.lang.String guidParameterName, java.lang.String guid, java.lang.String methodName)
      Validate that type's identifier is not null.
      void validateOptionalTypeGUIDs​(java.lang.String sourceName, java.lang.String guidParameterName, java.lang.String guid, java.lang.String subtypeParameterName, java.util.List<java.lang.String> subtypeGuids, java.lang.String methodName)
      Validate that the types and subtypes (if specified) fit each other.
      void validatePageSize​(java.lang.String sourceName, java.lang.String parameterName, int pageSize, java.lang.String methodName)
      Validate that a page size parameter is not negative.
      void validatePropertiesForType​(java.lang.String sourceName, java.lang.String parameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Validate that the properties for a metadata instance match its TypeDef.
      void validatePropertiesForType​(java.lang.String sourceName, java.lang.String parameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary typeDefSummary, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String methodName)
      Validate that the properties for a metadata instance match its TypeDef
      void validateReferenceInstanceHeader​(java.lang.String sourceName, java.lang.String localMetadataCollectionId, java.lang.String instanceParameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance, java.lang.String methodName)
      Validates that an instance has the correct header for it to be a reference copy.
      void validateRelationshipCanBeRehomed​(java.lang.String sourceName, java.lang.String metadataCollectionId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance, java.lang.String methodName)
      Verify that a relationship instance can be rehomed by the metadataCollection.
      void validateRelationshipCanBeUpdated​(java.lang.String sourceName, java.lang.String metadataCollectionId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance, java.lang.String methodName)
      Verify that a relationship instance can be updated by the metadataCollection.
      void validateRelationshipEnds​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entityOneProxy, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entityTwoProxy, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef, java.lang.String methodName)
      Validate that the types of the two ends of a relationship match the relationship's TypeDef.
      void validateRelationshipFromStore​(java.lang.String sourceName, java.lang.String guid, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship relationship, java.lang.String methodName)
      Verify that a relationship has been successfully retrieved from the repository and has valid contents.
      void validateRelationshipIsDeleted​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance, java.lang.String methodName)
      Verify the status of a relationship to check it has been deleted.
      void validateRelationshipIsNotDeleted​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance, java.lang.String methodName)
      Verify the status of a relationship to check it has not been deleted.
      void validateSearchClassifications​(java.lang.String sourceName, java.lang.String parameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search.SearchClassifications matchClassifications, java.lang.String methodName)
      Validate the classification-based search conditions.
      void validateSearchCriteria​(java.lang.String sourceName, java.lang.String parameterName, java.lang.String searchCriteria, java.lang.String methodName)
      Validate that a search criteria is not null.
      void validateSearchProperties​(java.lang.String sourceName, java.lang.String parameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search.SearchProperties matchProperties, java.lang.String methodName)
      Validate the property-based search conditions.
      void validateTypeDef​(java.lang.String sourceName, java.lang.String parameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef, java.lang.String methodName)
      Validate the content of a new TypeDef is valid.
      void validateTypeDefCategory​(java.lang.String sourceName, java.lang.String nameParameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefCategory category, java.lang.String methodName)
      Validate that a TypeDef's category is not null.
      void validateTypeDefForInstance​(java.lang.String sourceName, java.lang.String parameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef, java.lang.String methodName)
      Validate the content of a TypeDef associated with a metadata instance.
      void validateTypeDefGallery​(java.lang.String sourceName, java.lang.String parameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefGallery gallery, java.lang.String methodName)
      Validate that type's name is not null.
      void validateTypeDefIds​(java.lang.String sourceName, java.lang.String guidParameterName, java.lang.String nameParameterName, java.lang.String guid, java.lang.String name, java.lang.String methodName)
      Validate that a TypeDef's identifiers are not null.
      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef validateTypeDefPatch​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefPatch patch, java.lang.String methodName)
      Verify that a TypeDefPatch is not null.
      void validateTypeForInstanceDelete​(java.lang.String sourceName, java.lang.String typeDefGUID, java.lang.String typeDefName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance, java.lang.String methodName)
      Validate that the supplied TypeDef GUID and name matches the type associated with a metadata instance.
      void validateTypeGUID​(java.lang.String sourceName, java.lang.String guidParameterName, java.lang.String guid, java.lang.String methodName)
      Validate that type's identifier is not null.
      void validateTypeName​(java.lang.String sourceName, java.lang.String nameParameterName, java.lang.String name, java.lang.String methodName)
      Validate that type's name is not null.
      void validateUnknownAttributeTypeDef​(java.lang.String sourceName, java.lang.String parameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef attributeTypeDef, java.lang.String methodName)
      Validate the content of a new TypeDef is known.
      void validateUnknownTypeDef​(java.lang.String sourceName, java.lang.String parameterName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef, java.lang.String methodName)
      Validate the content of a new TypeDef is known.
      void validateUserId​(java.lang.String sourceName, java.lang.String userId, java.lang.String methodName)
      Validate that the supplied user Id is not null.
      boolean validAttributeTypeDef​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef attributeTypeDef)
      Return boolean indicating whether the supplied AttributeTypeDef is valid or not.
      boolean validAttributeTypeDefId​(java.lang.String sourceName, java.lang.String attributeTypeDefGUID, java.lang.String attributeTypeDefName, java.lang.String attributeTypeDefVersion, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDefCategory category)
      Return boolean indicating whether the TypeDef identifiers are from a single known type or not.
      boolean validAttributeTypeDefId​(java.lang.String sourceName, java.lang.String attributeTypeDefGUID, java.lang.String attributeTypeDefName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDefCategory category)
      Return boolean indicating whether the AttributeTypeDef identifiers are from a single known type or not.
      boolean validEntity​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail entity)
      Test that the supplied entity is valid.
      boolean validEntity​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entity)
      Test that the supplied entity is valid.
      boolean validEntity​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary entity)
      Test that the supplied entity is valid.
      boolean validInstanceId​(java.lang.String sourceName, java.lang.String typeDefGUID, java.lang.String typeDefName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefCategory category, java.lang.String instanceGUID)
      Verify that the identifiers for an instance are correct.
      boolean validRelationship​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship relationship)
      Test that the supplied relationship is valid.
      boolean validTypeDef​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef)
      Return boolean indicating whether the supplied TypeDef is valid or not.
      boolean validTypeDefId​(java.lang.String sourceName, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String typeDefVersion, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefCategory category)
      Return boolean indicating whether the TypeDef identifiers are from a single known type or not.
      boolean validTypeDefId​(java.lang.String sourceName, java.lang.String typeDefGUID, java.lang.String typeDefName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefCategory category)
      Return boolean indicating whether the TypeDef identifiers are from a single known type or not.
      boolean validTypeDefSummary​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary typeDefSummary)
      Return boolean indicating whether the supplied TypeDefSummary is valid or not.
      boolean validTypeId​(java.lang.String sourceName, java.lang.String typeGUID, java.lang.String typeName)
      Return boolean indicating whether the TypeDef identifiers are from a single known type or not.
      boolean verifyEntityIsClassified​(java.util.List<java.lang.String> requiredClassifications, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary entity)
      Return a boolean indicating whether the supplied entity is classified with one or more of the supplied classifications.
      boolean verifyInstanceHasRightStatus​(java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> validStatuses, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance)
      Verify that the supplied instance is in one of the supplied statuses.
      boolean verifyInstancePropertiesMatchPropertyValue​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String searchPropertyValue, java.lang.String methodName)
      Search for property values matching the supplied property value
      boolean verifyInstancePropertiesMatchSearchCriteria​(java.lang.String sourceName, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties, java.lang.String searchCriteria, java.lang.String methodName)
      Search for property values matching the search criteria (a regular expression)
      boolean verifyInstanceType​(java.lang.String sourceName, java.lang.String instanceTypeGUID, java.util.List<java.lang.String> subtypeGUIDs, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance)
      Verify whether the instance passed to this method is of the type indicated by the type guid and restricted by the list of subtype guids.
      boolean verifyInstanceType​(java.lang.String sourceName, java.lang.String instanceTypeGUID, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance)
      Verify whether the instance passed to this method is of the type indicated by the type guid.
      boolean verifyMatchingClassifications​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search.SearchClassifications matchClassifications, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary entity)
      Determine if the instance properties match the classification-based conditions.
      boolean verifyMatchingInstancePropertyValues​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties matchProperties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader instanceHeader, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties, MatchCriteria matchCriteria)
      Determine if the instance properties match the match criteria.
      boolean verifyMatchingInstancePropertyValues​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search.SearchProperties matchProperties, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader instanceHeader, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties)
      Determine if the instance properties match the property-based conditions.
    • Method Detail

      • validateEnterpriseTypeDefs

        void validateEnterpriseTypeDefs​(java.lang.String sourceName,
                                        java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef> typeDefs,
                                        java.lang.String methodName)
                                 throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Return a boolean flag indicating whether the list of TypeDefs passed are compatible with the all known typedefs. A valid TypeDef is one that matches name, GUID and version to the full list of TypeDefs. If a new TypeDef is present, it is added to the enterprise list.
        Parameters:
        sourceName - source of the request (used for logging)
        typeDefs - list of TypeDefs.
        methodName - calling method
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - a conflicting or invalid TypeDef has been returned
      • validateEnterpriseAttributeTypeDefs

        void validateEnterpriseAttributeTypeDefs​(java.lang.String sourceName,
                                                 java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef> attributeTypeDefs,
                                                 java.lang.String methodName)
                                          throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Return a boolean flag indicating whether the list of TypeDefs passed are compatible with the all known typedefs. A valid TypeDef is one that matches name, GUID and version to the full list of TypeDefs. If a new TypeDef is present, it is added to the enterprise list.
        Parameters:
        sourceName - source of the request (used for logging)
        attributeTypeDefs - list of AttributeTypeDefs.
        methodName - calling method
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - a conflicting or invalid AttributeTypeDef has been returned
      • isActiveType

        boolean isActiveType​(java.lang.String sourceName,
                             java.lang.String typeGUID,
                             java.lang.String typeName)
        Return boolean indicating whether the TypeDef/AttributeTypeDef is in use in the repository.
        Parameters:
        sourceName - source of the request (used for logging)
        typeGUID - unique identifier of the type
        typeName - unique name of the type
        Returns:
        boolean flag
      • isActiveTypeId

        boolean isActiveTypeId​(java.lang.String sourceName,
                               java.lang.String typeGUID)
        Return boolean indicating whether the TypeDef/AttributeTypeDef is in use in the repository.
        Parameters:
        sourceName - source of the request (used for logging)
        typeGUID - unique identifier of the type
        Returns:
        boolean flag
      • isOpenType

        boolean isOpenType​(java.lang.String sourceName,
                           java.lang.String typeGUID,
                           java.lang.String typeName)
        Return boolean indicating whether the TypeDef is one of the open metadata types.
        Parameters:
        sourceName - source of the request (used for logging)
        typeGUID - unique identifier of the type
        typeName - unique name of the type
        Returns:
        boolean flag
      • isOpenTypeId

        boolean isOpenTypeId​(java.lang.String sourceName,
                             java.lang.String typeGUID)
        Return boolean indicating whether the TypeDef is one of the open metadata types.
        Parameters:
        sourceName - source of the request (used for logging)
        typeGUID - unique identifier of the type
        Returns:
        boolean flag
      • isKnownType

        boolean isKnownType​(java.lang.String sourceName,
                            java.lang.String typeGUID,
                            java.lang.String typeName)
        Return boolean indicating whether the TypeDef/AttributeTypeDef is in use in the repository.
        Parameters:
        sourceName - source of the request (used for logging)
        typeGUID - unique identifier of the type
        typeName - unique name of the type
        Returns:
        boolean flag
      • isKnownTypeId

        boolean isKnownTypeId​(java.lang.String sourceName,
                              java.lang.String typeGUID)
        Return boolean indicating whether the TypeDef/AttributeTypeDef is in use in the repository.
        Parameters:
        sourceName - source of the request (used for logging)
        typeGUID - unique identifier of the type
        Returns:
        boolean flag
      • validTypeId

        boolean validTypeId​(java.lang.String sourceName,
                            java.lang.String typeGUID,
                            java.lang.String typeName)
        Return boolean indicating whether the TypeDef identifiers are from a single known type or not.
        Parameters:
        sourceName - source of the request (used for logging)
        typeGUID - unique identifier of the TypeDef
        typeName - unique name of the TypeDef
        Returns:
        boolean result
      • validTypeDefId

        boolean validTypeDefId​(java.lang.String sourceName,
                               java.lang.String typeDefGUID,
                               java.lang.String typeDefName,
                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefCategory category)
        Return boolean indicating whether the TypeDef identifiers are from a single known type or not.
        Parameters:
        sourceName - source of the request (used for logging)
        typeDefGUID - unique identifier of the TypeDef
        typeDefName - unique name of the TypeDef
        category - category for the TypeDef
        Returns:
        boolean result
      • validAttributeTypeDefId

        boolean validAttributeTypeDefId​(java.lang.String sourceName,
                                        java.lang.String attributeTypeDefGUID,
                                        java.lang.String attributeTypeDefName,
                                        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDefCategory category)
        Return boolean indicating whether the AttributeTypeDef identifiers are from a single known type or not.
        Parameters:
        sourceName - source of the request (used for logging)
        attributeTypeDefGUID - unique identifier of the AttributeTypeDef
        attributeTypeDefName - unique name of the AttributeTypeDef
        category - category for the AttributeTypeDef
        Returns:
        boolean result
      • validTypeDefId

        boolean validTypeDefId​(java.lang.String sourceName,
                               java.lang.String typeDefGUID,
                               java.lang.String typeDefName,
                               java.lang.String typeDefVersion,
                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefCategory category)
        Return boolean indicating whether the TypeDef identifiers are from a single known type or not.
        Parameters:
        sourceName - source of the request (used for logging)
        typeDefGUID - unique identifier of the TypeDef
        typeDefName - unique name of the TypeDef
        typeDefVersion - version of the type
        category - category for the TypeDef
        Returns:
        boolean result
      • validAttributeTypeDefId

        boolean validAttributeTypeDefId​(java.lang.String sourceName,
                                        java.lang.String attributeTypeDefGUID,
                                        java.lang.String attributeTypeDefName,
                                        java.lang.String attributeTypeDefVersion,
                                        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDefCategory category)
        Return boolean indicating whether the TypeDef identifiers are from a single known type or not.
        Parameters:
        sourceName - source of the request (used for logging)
        attributeTypeDefGUID - unique identifier of the TypeDef
        attributeTypeDefName - unique name of the TypeDef
        attributeTypeDefVersion - version of the type
        category - category for the TypeDef
        Returns:
        boolean result
      • validTypeDef

        boolean validTypeDef​(java.lang.String sourceName,
                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef)
        Return boolean indicating whether the supplied TypeDef is valid or not.
        Parameters:
        sourceName - source of the TypeDef (used for logging)
        typeDef - TypeDef to test
        Returns:
        boolean result
      • validAttributeTypeDef

        boolean validAttributeTypeDef​(java.lang.String sourceName,
                                      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef attributeTypeDef)
        Return boolean indicating whether the supplied AttributeTypeDef is valid or not.
        Parameters:
        sourceName - source of the request (used for logging)
        attributeTypeDef - TypeDef to test
        Returns:
        boolean result
      • validTypeDefSummary

        boolean validTypeDefSummary​(java.lang.String sourceName,
                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary typeDefSummary)
        Return boolean indicating whether the supplied TypeDefSummary is valid or not.
        Parameters:
        sourceName - source of the request (used for logging)
        typeDefSummary - TypeDefSummary to test.
        Returns:
        boolean result.
      • validEntity

        boolean validEntity​(java.lang.String sourceName,
                            org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary entity)
        Test that the supplied entity is valid.
        Parameters:
        sourceName - source of the request (used for logging)
        entity - entity to test
        Returns:
        boolean result
      • validEntity

        boolean validEntity​(java.lang.String sourceName,
                            org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entity)
        Test that the supplied entity is valid.
        Parameters:
        sourceName - source of the request (used for logging)
        entity - entity to test
        Returns:
        boolean result
      • validEntity

        boolean validEntity​(java.lang.String sourceName,
                            org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail entity)
        Test that the supplied entity is valid.
        Parameters:
        sourceName - source of the request (used for logging)
        entity - entity to test
        Returns:
        boolean result
      • validRelationship

        boolean validRelationship​(java.lang.String sourceName,
                                  org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship relationship)
        Test that the supplied relationship is valid.
        Parameters:
        sourceName - source of the request (used for logging)
        relationship - relationship to test
        Returns:
        boolean result
      • validInstanceId

        boolean validInstanceId​(java.lang.String sourceName,
                                java.lang.String typeDefGUID,
                                java.lang.String typeDefName,
                                org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefCategory category,
                                java.lang.String instanceGUID)
        Verify that the identifiers for an instance are correct.
        Parameters:
        sourceName - source of the request (used for logging)
        typeDefGUID - unique identifier for the type.
        typeDefName - unique name for the type.
        category - expected category of the instance.
        instanceGUID - unique identifier for the instance.
        Returns:
        boolean indicating whether the identifiers are ok.
      • validateUserId

        void validateUserId​(java.lang.String sourceName,
                            java.lang.String userId,
                            java.lang.String methodName)
                     throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that the supplied user Id is not null.
        Parameters:
        sourceName - name of source of request.
        userId - userId passed on call to this metadata collection.
        methodName - name of method requesting the validation.
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - the userId is invalid
      • validateTypeDefIds

        void validateTypeDefIds​(java.lang.String sourceName,
                                java.lang.String guidParameterName,
                                java.lang.String nameParameterName,
                                java.lang.String guid,
                                java.lang.String name,
                                java.lang.String methodName)
                         throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that a TypeDef's identifiers are not null.
        Parameters:
        sourceName - source of the request (used for logging)
        guidParameterName - name of the parameter that passed the guid.
        nameParameterName - name of the parameter that passed the name.
        guid - unique identifier for a type or an instance passed on the request
        name - name of TypeDef.
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no guid provided
      • getValidTypeDefFromIds

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef getValidTypeDefFromIds​(java.lang.String sourceName,
                                                                                                                                              java.lang.String guidParameterName,
                                                                                                                                              java.lang.String nameParameterName,
                                                                                                                                              java.lang.String guid,
                                                                                                                                              java.lang.String name,
                                                                                                                                              java.lang.String methodName)
                                                                                                                                       throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that a TypeDef's identifiers are not null and return the type.
        Parameters:
        sourceName - source of the request (used for logging)
        guidParameterName - name of the parameter that passed the guid.
        nameParameterName - name of the parameter that passed the name.
        guid - unique identifier for a type or an instance passed on the request
        name - name of TypeDef.
        methodName - method receiving the call
        Returns:
        retrieved type
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no guid provided
      • validateAttributeTypeDefIds

        void validateAttributeTypeDefIds​(java.lang.String sourceName,
                                         java.lang.String guidParameterName,
                                         java.lang.String nameParameterName,
                                         java.lang.String guid,
                                         java.lang.String name,
                                         java.lang.String methodName)
                                  throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that an AttributeTypeDef's identifiers are not null.
        Parameters:
        sourceName - source of the request (used for logging)
        guidParameterName - name of the parameter that passed the guid.
        nameParameterName - name of the parameter that passed the name.
        guid - unique identifier for a type or an instance passed on the request
        name - name of TypeDef.
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no guid, or name provided
      • getValidAttributeTypeDefFromIds

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef getValidAttributeTypeDefFromIds​(java.lang.String sourceName,
                                                                                                                                                                java.lang.String guidParameterName,
                                                                                                                                                                java.lang.String nameParameterName,
                                                                                                                                                                java.lang.String guid,
                                                                                                                                                                java.lang.String name,
                                                                                                                                                                java.lang.String methodName)
                                                                                                                                                         throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that an AttributeTypeDef's identifiers are not null and are recognized and return the type.
        Parameters:
        sourceName - source of the request (used for logging)
        guidParameterName - name of the parameter that passed the guid.
        nameParameterName - name of the parameter that passed the name.
        guid - unique identifier for a type or an instance passed on the request
        name - name of TypeDef.
        methodName - method receiving the call
        Returns:
        retrieved type
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no guid, or name provided
      • validateTypeGUID

        void validateTypeGUID​(java.lang.String sourceName,
                              java.lang.String guidParameterName,
                              java.lang.String guid,
                              java.lang.String methodName)
                       throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                              org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException
        Validate that type's identifier is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        guidParameterName - name of the parameter that passed the guid.
        guid - unique identifier for a type or an instance passed on the request
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no guid provided
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException - guid is not for a recognized type
      • validateOptionalTypeGUID

        void validateOptionalTypeGUID​(java.lang.String sourceName,
                                      java.lang.String guidParameterName,
                                      java.lang.String guid,
                                      java.lang.String methodName)
                               throws org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException
        Validate that type's identifier is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        guidParameterName - name of the parameter that passed the guid.
        guid - unique identifier for a type or an instance passed on the request
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException - unknown type guid
      • validateOptionalTypeGUIDs

        void validateOptionalTypeGUIDs​(java.lang.String sourceName,
                                       java.lang.String guidParameterName,
                                       java.lang.String guid,
                                       java.lang.String subtypeParameterName,
                                       java.util.List<java.lang.String> subtypeGuids,
                                       java.lang.String methodName)
                                throws org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException
        Validate that the types and subtypes (if specified) fit each other.
        Parameters:
        sourceName - source of the request (used for logging)
        guidParameterName - name of the parameter that passed the guid
        guid - unique identifier for a type passed on the request
        subtypeParameterName - name of the parameter that passed a list of subtype guids
        subtypeGuids - list of unique identifiers for the subtypes passed on the request
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException - unknown type guid, or subtype guids that are not subtypes of the provided guid
      • validateTypeDefPatch

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef validateTypeDefPatch​(java.lang.String sourceName,
                                                                                                                                            org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefPatch patch,
                                                                                                                                            java.lang.String methodName)
                                                                                                                                     throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                                                                                                                            org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefNotKnownException,
                                                                                                                                            org.odpi.openmetadata.repositoryservices.ffdc.exception.PatchErrorException
        Verify that a TypeDefPatch is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        patch - patch to test
        methodName - calling method
        Returns:
        current value of the type
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - the patch is null
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefNotKnownException - the type is not known
        org.odpi.openmetadata.repositoryservices.ffdc.exception.PatchErrorException - the patch is invalid
      • validateInstanceTypeGUID

        void validateInstanceTypeGUID​(java.lang.String sourceName,
                                      java.lang.String guidParameterName,
                                      java.lang.String guid,
                                      java.lang.String methodName)
                               throws org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException
        Validate that if a type's identifier is passed then it is valid.
        Parameters:
        sourceName - source of the request (used for logging)
        guidParameterName - name of the parameter that passed the guid.
        guid - unique identifier for a type or an instance passed on the request
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException - invalid type provided
      • validateTypeName

        void validateTypeName​(java.lang.String sourceName,
                              java.lang.String nameParameterName,
                              java.lang.String name,
                              java.lang.String methodName)
                       throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that type's name is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        nameParameterName - name of the parameter that passed the name.
        name - unique identifier for a type or an instance passed on the request
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no name provided
      • validateTypeDefCategory

        void validateTypeDefCategory​(java.lang.String sourceName,
                                     java.lang.String nameParameterName,
                                     org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefCategory category,
                                     java.lang.String methodName)
                              throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that a TypeDef's category is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        nameParameterName - name of the parameter that passed the name.
        category - category of TypeDef
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no name provided
      • validateAttributeTypeDefCategory

        void validateAttributeTypeDefCategory​(java.lang.String sourceName,
                                              java.lang.String nameParameterName,
                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDefCategory category,
                                              java.lang.String methodName)
                                       throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that a AttributeTypeDef's category is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        nameParameterName - name of the parameter that passed the name.
        category - category of TypeDef
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no name provided
      • validateTypeDef

        void validateTypeDef​(java.lang.String sourceName,
                             java.lang.String parameterName,
                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef,
                             java.lang.String methodName)
                      throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                             org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidTypeDefException
        Validate the content of a new TypeDef is valid.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the typeDef.
        typeDef - unique identifier for a type or an instance passed on the request
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no typeDef provided
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidTypeDefException - invalid typeDef provided
      • validateActiveType

        void validateActiveType​(java.lang.String sourceName,
                                java.lang.String typeParameterName,
                                org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary typeDefSummary,
                                org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefCategory category,
                                java.lang.String methodName)
                         throws org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException,
                                org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that the supplied type is a valid active type.
        Parameters:
        sourceName - source of the request (used for logging)
        typeParameterName - the name of the parameter that passed the type
        typeDefSummary - the type to test
        category - the expected category of the type
        methodName - the name of the method that supplied the type
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - the type is null or contains invalid values
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException - the type is not active
      • validateKnownTypeDef

        void validateKnownTypeDef​(java.lang.String sourceName,
                                  java.lang.String parameterName,
                                  org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef,
                                  java.lang.String methodName)
                           throws org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefNotKnownException
        Validate the content of a new TypeDef is known.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the typeDef.
        typeDef - unique identifier for a type or an instance passed on the request
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefNotKnownException - no recognized typeDef provided
      • validateUnknownTypeDef

        void validateUnknownTypeDef​(java.lang.String sourceName,
                                    java.lang.String parameterName,
                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef,
                                    java.lang.String methodName)
                             throws org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefKnownException,
                                    org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefConflictException
        Validate the content of a new TypeDef is known.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the typeDef.
        typeDef - unique identifier for a type or an instance passed on the request
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefKnownException - the TypeDef is already defined
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefConflictException - the TypeDef is already defined but differently
      • validateUnknownAttributeTypeDef

        void validateUnknownAttributeTypeDef​(java.lang.String sourceName,
                                             java.lang.String parameterName,
                                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef attributeTypeDef,
                                             java.lang.String methodName)
                                      throws org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefKnownException,
                                             org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefConflictException
        Validate the content of a new TypeDef is known.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the typeDef.
        attributeTypeDef - unique identifier for an attribute type or an instance passed on the request
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefKnownException - the TypeDef is already defined
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeDefConflictException - the TypeDef is already defined but differently
      • validateTypeDefForInstance

        void validateTypeDefForInstance​(java.lang.String sourceName,
                                        java.lang.String parameterName,
                                        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef,
                                        java.lang.String methodName)
                                 throws org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException,
                                        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Validate the content of a TypeDef associated with a metadata instance.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the typeDef.
        typeDef - unique identifier for a type or an instance passed on the request
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException - no typeDef provided
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - the TypeDef from the repository is in error.
      • validateTypeForInstanceDelete

        void validateTypeForInstanceDelete​(java.lang.String sourceName,
                                           java.lang.String typeDefGUID,
                                           java.lang.String typeDefName,
                                           org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance,
                                           java.lang.String methodName)
                                    throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                           org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Validate that the supplied TypeDef GUID and name matches the type associated with a metadata instance.
        Parameters:
        sourceName - source of the request (used for logging)
        typeDefGUID - the supplied typeDef GUID.
        typeDefName - the supplied typeDef name.
        instance - instance retrieved from the store with the supplied instance guid
        methodName - method making this call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - incompatibility detected between the TypeDef and the instance's type
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - the instance from the repository is in error.
      • validateAttributeTypeDef

        void validateAttributeTypeDef​(java.lang.String sourceName,
                                      java.lang.String parameterName,
                                      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.AttributeTypeDef attributeTypeDef,
                                      java.lang.String methodName)
                               throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                      org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidTypeDefException
        Validate the content of a new AttributeTypeDef.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the attributeTypeDef.
        attributeTypeDef - unique identifier for a type or an instance passed on the request
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no attributeTypeDef provided
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidTypeDefException - bad attributeTypeDef provided
      • validateTypeDefGallery

        void validateTypeDefGallery​(java.lang.String sourceName,
                                    java.lang.String parameterName,
                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefGallery gallery,
                                    java.lang.String methodName)
                             throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that type's name is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the name.
        gallery - typeDef gallery
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no name provided
      • validateExternalId

        void validateExternalId​(java.lang.String sourceName,
                                java.lang.String standard,
                                java.lang.String organization,
                                java.lang.String identifier,
                                java.lang.String methodName)
                         throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that the type's name is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        standard - name of the standard null means any.
        organization - name of the organization null means any.
        identifier - identifier of the element in the standard null means any.
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no name provided
      • validateGUID

        void validateGUID​(java.lang.String sourceName,
                          java.lang.String guidParameterName,
                          java.lang.String guid,
                          java.lang.String methodName)
                   throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that an entity's identifier is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        guidParameterName - name of the parameter that passed the guid.
        guid - unique identifier for a type or an instance passed on the request
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no guid provided
      • validateHomeMetadataGUID

        void validateHomeMetadataGUID​(java.lang.String sourceName,
                                      java.lang.String guidParameterName,
                                      java.lang.String guid,
                                      java.lang.String methodName)
                               throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that a home metadata collection identifier is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        guidParameterName - name of the parameter that passed the guid.
        guid - unique identifier for a type or an instance passed on the request
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no guid provided
      • validateHomeMetadataGUID

        void validateHomeMetadataGUID​(java.lang.String sourceName,
                                      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance,
                                      java.lang.String methodName)
                               throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Validate that a home metadata collection identifier in an instance is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        instance - instance to test.
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - no guid provided
      • validateHomeMetadataGUID

        void validateHomeMetadataGUID​(java.lang.String sourceName,
                                      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification classification,
                                      java.lang.String methodName)
                               throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Validate that a home metadata collection identifier in an classification is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        classification - classification to test.
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - no guid provided
      • validateAsOfTime

        void validateAsOfTime​(java.lang.String sourceName,
                              java.lang.String parameterName,
                              java.util.Date asOfTime,
                              java.lang.String methodName)
                       throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that the asOfTime parameter is not for the future.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the guid.
        asOfTime - unique name for a classification type
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - asOfTime is for the future
      • validateAsOfTimeNotNull

        void validateAsOfTimeNotNull​(java.lang.String sourceName,
                                     java.lang.String parameterName,
                                     java.util.Date asOfTime,
                                     java.lang.String methodName)
                              throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that the asOfTime parameter is not null or for the future.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the guid.
        asOfTime - unique name for a classification type
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - asOfTime is for the future
      • validateDateRange

        void validateDateRange​(java.lang.String sourceName,
                               java.lang.String parameterName,
                               java.util.Date fromTime,
                               java.util.Date toTime,
                               java.lang.String methodName)
                        throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that the time parameters are not inverted ('from' later than 'to').
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the guid.
        fromTime - the earliest point in time from which to retrieve historical versions of the instance (inclusive)
        toTime - the latest point in time from which to retrieve historical versions of the instance (exclusive)
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - 'fromTime' is later than 'toTime'
      • validatePageSize

        void validatePageSize​(java.lang.String sourceName,
                              java.lang.String parameterName,
                              int pageSize,
                              java.lang.String methodName)
                       throws org.odpi.openmetadata.repositoryservices.ffdc.exception.PagingErrorException
        Validate that a page size parameter is not negative.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the guid.
        pageSize - number of elements to return on a request
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.PagingErrorException - pageSize is negative
      • validateClassificationName

        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef validateClassificationName​(java.lang.String sourceName,
                                                                                                                                                  java.lang.String parameterName,
                                                                                                                                                  java.lang.String classificationName,
                                                                                                                                                  java.lang.String methodName)
                                                                                                                                           throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that a classification name is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the guid.
        classificationName - unique name for a classification type
        methodName - method receiving the call
        Returns:
        type definition for the classification
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - classification name is null or invalid
      • validateClassificationProperties

        void validateClassificationProperties​(java.lang.String sourceName,
                                              java.lang.String classificationName,
                                              java.lang.String propertiesParameterName,
                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties classificationProperties,
                                              java.lang.String methodName)
                                       throws org.odpi.openmetadata.repositoryservices.ffdc.exception.PropertyErrorException
        Validate that a classification is valid for the entity.
        Parameters:
        sourceName - source of the request (used for logging)
        classificationName - unique name for a classification type
        propertiesParameterName - name of the parameter that passed the properties.
        classificationProperties - properties to test
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.PropertyErrorException - classification name is null
      • validateClassification

        void validateClassification​(java.lang.String sourceName,
                                    java.lang.String classificationParameterName,
                                    java.lang.String classificationName,
                                    java.lang.String entityTypeName,
                                    java.lang.String methodName)
                             throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                    org.odpi.openmetadata.repositoryservices.ffdc.exception.ClassificationErrorException
        Validate that a classification is valid for the entity.
        Parameters:
        sourceName - source of the request (used for logging)
        classificationParameterName - name of the parameter that passed the guid.
        classificationName - unique name for a classification type
        entityTypeName - name of entity type
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - classification name is null
        org.odpi.openmetadata.repositoryservices.ffdc.exception.ClassificationErrorException - the classification is invalid for this entity
      • validateClassificationList

        void validateClassificationList​(java.lang.String sourceName,
                                        java.lang.String parameterName,
                                        java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification> classifications,
                                        java.lang.String entityTypeName,
                                        java.lang.String methodName)
                                 throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                        org.odpi.openmetadata.repositoryservices.ffdc.exception.ClassificationErrorException,
                                        org.odpi.openmetadata.repositoryservices.ffdc.exception.PropertyErrorException,
                                        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException
        Validate that a classification is valid for the entity.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the guid.
        classifications - list of classifications
        entityTypeName - name of entity type
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - classification name is null
        org.odpi.openmetadata.repositoryservices.ffdc.exception.ClassificationErrorException - the classification is invalid for this entity
        org.odpi.openmetadata.repositoryservices.ffdc.exception.PropertyErrorException - the classification's properties are invalid for its type
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException - the classification's type is invalid
      • validateMatchCriteria

        void validateMatchCriteria​(java.lang.String sourceName,
                                   java.lang.String parameterName,
                                   org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefProperties matchCriteria,
                                   java.lang.String methodName)
                            throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that a TypeDef match criteria set of properties is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the match criteria.
        matchCriteria - match criteria properties
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no guid provided
      • validateMatchCriteria

        void validateMatchCriteria​(java.lang.String sourceName,
                                   java.lang.String matchCriteriaParameterName,
                                   java.lang.String matchPropertiesParameterName,
                                   MatchCriteria matchCriteria,
                                   org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties matchProperties,
                                   java.lang.String methodName)
                            throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that a metadata instance match criteria and set of properties are either both null or both not null.
        Parameters:
        sourceName - source of the request (used for logging)
        matchCriteriaParameterName - name of the parameter that passed the match criteria.
        matchPropertiesParameterName - name of the parameter that passed the match criteria.
        matchCriteria - match criteria enum
        matchProperties - match properties
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no guid provided
      • validateSearchCriteria

        void validateSearchCriteria​(java.lang.String sourceName,
                                    java.lang.String parameterName,
                                    java.lang.String searchCriteria,
                                    java.lang.String methodName)
                             throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that a search criteria is not null.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the search criteria.
        searchCriteria - match criteria properties
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - no guid provided
      • validateSearchProperties

        void validateSearchProperties​(java.lang.String sourceName,
                                      java.lang.String parameterName,
                                      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search.SearchProperties matchProperties,
                                      java.lang.String methodName)
                               throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate the property-based search conditions.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the property-based conditions
        matchProperties - property-based conditions
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - property-based conditions are invalid
      • validateSearchClassifications

        void validateSearchClassifications​(java.lang.String sourceName,
                                           java.lang.String parameterName,
                                           org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search.SearchClassifications matchClassifications,
                                           java.lang.String methodName)
                                    throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate the classification-based search conditions.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the parameter that passed the classification-based conditions
        matchClassifications - classification-based conditions
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - classification-based conditions are invalid
      • validatePropertiesForType

        void validatePropertiesForType​(java.lang.String sourceName,
                                       java.lang.String parameterName,
                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef,
                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                       java.lang.String methodName)
                                throws org.odpi.openmetadata.repositoryservices.ffdc.exception.PropertyErrorException
        Validate that the properties for a metadata instance match its TypeDef.
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the properties parameter.
        typeDef - type information to validate against.
        properties - proposed properties for instance.
        methodName - method receiving the call.
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.PropertyErrorException - invalid property
      • validatePropertiesForType

        void validatePropertiesForType​(java.lang.String sourceName,
                                       java.lang.String parameterName,
                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDefSummary typeDefSummary,
                                       org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                       java.lang.String methodName)
                                throws org.odpi.openmetadata.repositoryservices.ffdc.exception.PropertyErrorException,
                                       org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException
        Validate that the properties for a metadata instance match its TypeDef
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the properties parameter.
        typeDefSummary - type information to validate against.
        properties - proposed properties
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException - no typeDef provided
        org.odpi.openmetadata.repositoryservices.ffdc.exception.PropertyErrorException - invalid property
      • validateNewPropertiesForType

        void validateNewPropertiesForType​(java.lang.String sourceName,
                                          java.lang.String parameterName,
                                          org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef,
                                          org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                          java.lang.String methodName)
                                   throws org.odpi.openmetadata.repositoryservices.ffdc.exception.PropertyErrorException
        Validate that the properties for a metadata instance match its TypeDef
        Parameters:
        sourceName - source of the request (used for logging)
        parameterName - name of the properties parameter.
        typeDef - type information to validate against.
        properties - proposed properties
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.PropertyErrorException - invalid property
      • verifyInstanceType

        boolean verifyInstanceType​(java.lang.String sourceName,
                                   java.lang.String instanceTypeGUID,
                                   org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance)
        Verify whether the instance passed to this method is of the type indicated by the type guid. A null type guid matches all instances (ie result is true). A null instance returns false.
        Parameters:
        sourceName - name of caller.
        instanceTypeGUID - unique identifier of the type (or null).
        instance - instance to test.
        Returns:
        boolean
      • verifyInstanceType

        boolean verifyInstanceType​(java.lang.String sourceName,
                                   java.lang.String instanceTypeGUID,
                                   java.util.List<java.lang.String> subtypeGUIDs,
                                   org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance)
        Verify whether the instance passed to this method is of the type indicated by the type guid and restricted by the list of subtype guids. A null type guid matches all instances (ie result is true). A null instance returns false.
        Parameters:
        sourceName - name of caller.
        instanceTypeGUID - unique identifier of the type (or null).
        subtypeGUIDs - list of unique identifiers of the subtypes to include (or null).
        instance - instance to test.
        Returns:
        boolean
      • validateEntityFromStore

        void validateEntityFromStore​(java.lang.String sourceName,
                                     java.lang.String guid,
                                     org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary entity,
                                     java.lang.String methodName)
                              throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
                                     org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException
        Verify that an entity has been successfully retrieved from the repository and has valid contents.
        Parameters:
        sourceName - source of the request (used for logging)
        guid - unique identifier used to retrieve the entity
        entity - the retrieved entity (or null)
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException - No entity found
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - logic error in the repository corrupted instance
      • validateEntityFromStore

        void validateEntityFromStore​(java.lang.String sourceName,
                                     java.lang.String guid,
                                     org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail entity,
                                     java.lang.String methodName)
                              throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
                                     org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException
        Verify that an entity has been successfully retrieved from the repository and has valid contents.
        Parameters:
        sourceName - source of the request (used for logging)
        guid - unique identifier used to retrieve the entity
        entity - the retrieved entity (or null)
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException - No entity found
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - logic error in the repository corrupted instance
      • validateRelationshipFromStore

        void validateRelationshipFromStore​(java.lang.String sourceName,
                                           java.lang.String guid,
                                           org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship relationship,
                                           java.lang.String methodName)
                                    throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
                                           org.odpi.openmetadata.repositoryservices.ffdc.exception.RelationshipNotKnownException
        Verify that a relationship has been successfully retrieved from the repository and has valid contents.
        Parameters:
        sourceName - source of the request (used for logging)
        guid - unique identifier used to retrieve the entity
        relationship - the retrieved relationship (or null)
        methodName - method receiving the call
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RelationshipNotKnownException - No relationship found
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - logic error in the repository corrupted instance
      • validateInstanceType

        void validateInstanceType​(java.lang.String sourceName,
                                  org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance)
                           throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Verify that the instance retrieved from the repository has a valid instance type.
        Parameters:
        sourceName - source of the request (used for logging)
        instance - the retrieved instance
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - logic error in the repository corrupted instance
      • validateInstanceType

        void validateInstanceType​(java.lang.String sourceName,
                                  org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance,
                                  java.lang.String typeGUIDParameterName,
                                  java.lang.String typeNameParameterName,
                                  java.lang.String expectedTypeGUID,
                                  java.lang.String expectedTypeName)
                           throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException,
                                  org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException,
                                  org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Verify that the instance retrieved from the repository has a valid instance type that matches the expected type.
        Parameters:
        sourceName - source of the request (used for logging)
        instance - the retrieved instance
        typeGUIDParameterName - name of parameter for TypeDefGUID
        typeNameParameterName - name of parameter for TypeDefName
        expectedTypeGUID - expected GUID of InstanceType
        expectedTypeName - expected name of InstanceType
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - logic error in the repository corrupted instance
        org.odpi.openmetadata.repositoryservices.ffdc.exception.TypeErrorException - problem with type
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - invalid parameter
      • verifyInstanceHasRightStatus

        boolean verifyInstanceHasRightStatus​(java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus> validStatuses,
                                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance)
        Verify that the supplied instance is in one of the supplied statuses. Note that if the supplied statuses are null, then only statuses that are not DELETE are considered valid.
        Parameters:
        validStatuses - list of statuses the instance should be in any one of them
        instance - instance to test
        Returns:
        boolean result
      • validateInstanceStatus

        void validateInstanceStatus​(java.lang.String sourceName,
                                    java.lang.String instanceStatusParameterName,
                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus instanceStatus,
                                    org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef,
                                    java.lang.String methodName)
                             throws org.odpi.openmetadata.repositoryservices.ffdc.exception.StatusNotSupportedException
        Validates an instance status where null is permissible.
        Parameters:
        sourceName - source of the request (used for logging)
        instanceStatusParameterName - name of the initial status parameter
        instanceStatus - initial status value
        typeDef - type of the instance
        methodName - method called
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.StatusNotSupportedException - the initial status is invalid for this type
      • validateNewStatus

        void validateNewStatus​(java.lang.String sourceName,
                               java.lang.String instanceStatusParameterName,
                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceStatus instanceStatus,
                               org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef,
                               java.lang.String methodName)
                        throws org.odpi.openmetadata.repositoryservices.ffdc.exception.StatusNotSupportedException,
                               org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validates an instance status where null is not allowed.
        Parameters:
        sourceName - source of the request (used for logging)
        instanceStatusParameterName - name of the initial status parameter
        instanceStatus - initial status value
        typeDef - type of the instance
        methodName - method called
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.StatusNotSupportedException - the initial status is invalid for this type
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - invalid parameter
      • validateInstanceStatusForDelete

        void validateInstanceStatusForDelete​(java.lang.String sourceName,
                                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance,
                                             java.lang.String methodName)
                                      throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Verify that an instance is not already deleted since the repository is processing a delete request and it does not want to look stupid.
        Parameters:
        sourceName - source of the request (used for logging)
        instance - instance about to be deleted
        methodName - name of method called
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - the instance is already deleted
      • validateEntityIsNotDeleted

        void validateEntityIsNotDeleted​(java.lang.String sourceName,
                                        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance,
                                        java.lang.String methodName)
                                 throws org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException
        Verify the status of an entity to check it has not been deleted. This method is used when retrieving metadata instances from a store that supports soft delete.
        Parameters:
        sourceName - source of the request (used for logging)
        instance - instance to validate
        methodName - name of calling method
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotKnownException - the entity is in deleted status
      • validateEntityIsDeleted

        void validateEntityIsDeleted​(java.lang.String sourceName,
                                     org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance,
                                     java.lang.String methodName)
                              throws org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotDeletedException
        Verify the status of an entity to check it has been deleted.
        Parameters:
        sourceName - source of the request (used for logging)
        instance - instance to validate
        methodName - name of calling method
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotDeletedException - the entity is not in deleted status
      • validateEntityCanBeUpdated

        void validateEntityCanBeUpdated​(java.lang.String sourceName,
                                        java.lang.String metadataCollectionId,
                                        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance,
                                        java.lang.String methodName)
                                 throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Verify that an entity instance can be updated by the metadataCollection. This method is used when the metadataCollection is called to update the status properties or classification of an entity instance.
        Parameters:
        sourceName - source of the request (used for logging)
        metadataCollectionId - unique identifier for the metadata collection
        instance - instance to validate
        methodName - name of calling method
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - the entity is in deleted status
      • validateEntityCanBeRehomed

        void validateEntityCanBeRehomed​(java.lang.String sourceName,
                                        java.lang.String metadataCollectionId,
                                        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance,
                                        java.lang.String methodName)
                                 throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Verify that an entity instance can be rehomed by the metadataCollection. This method is used when the metadataCollection is called to rehome an entity instance.
        Parameters:
        sourceName - source of the request (used for logging)
        metadataCollectionId - unique identifier for the metadata collection
        instance - instance to validate
        methodName - name of calling method
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - the entity is in deleted status
      • validateRelationshipIsNotDeleted

        void validateRelationshipIsNotDeleted​(java.lang.String sourceName,
                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance,
                                              java.lang.String methodName)
                                       throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RelationshipNotKnownException
        Verify the status of a relationship to check it has not been deleted. This method is used when retrieving metadata instances from a store that supports soft delete.
        Parameters:
        sourceName - source of the request (used for logging)
        instance - instance to test
        methodName - name of calling method
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RelationshipNotKnownException - the relationship is in deleted status
      • validateRelationshipIsDeleted

        void validateRelationshipIsDeleted​(java.lang.String sourceName,
                                           org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance,
                                           java.lang.String methodName)
                                    throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RelationshipNotDeletedException
        Verify the status of a relationship to check it has been deleted.
        Parameters:
        sourceName - source of the request (used for logging)
        instance - instance to test
        methodName - name of calling method
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RelationshipNotDeletedException - the relationship is not in deleted status
      • validateRelationshipCanBeUpdated

        void validateRelationshipCanBeUpdated​(java.lang.String sourceName,
                                              java.lang.String metadataCollectionId,
                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance,
                                              java.lang.String methodName)
                                       throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Verify that a relationship instance can be updated by the metadataCollection. This method is used when the metadataCollection is called to update the status or properties of a relationship instance.
        Parameters:
        sourceName - source of the request (used for logging)
        metadataCollectionId - unique identifier for the metadata collection
        instance - instance to validate
        methodName - name of calling method
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - the entity is in deleted status
      • validateRelationshipCanBeRehomed

        void validateRelationshipCanBeRehomed​(java.lang.String sourceName,
                                              java.lang.String metadataCollectionId,
                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance,
                                              java.lang.String methodName)
                                       throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Verify that a relationship instance can be rehomed by the metadataCollection. This method is used when the metadataCollection is called to rehome a relationship instance.
        Parameters:
        sourceName - source of the request (used for logging)
        metadataCollectionId - unique identifier for the metadata collection
        instance - instance to validate
        methodName - name of calling method
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - the entity is in deleted status
      • validateRelationshipEnds

        void validateRelationshipEnds​(java.lang.String sourceName,
                                      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entityOneProxy,
                                      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entityTwoProxy,
                                      org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.typedefs.TypeDef typeDef,
                                      java.lang.String methodName)
                               throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validate that the types of the two ends of a relationship match the relationship's TypeDef.
        Parameters:
        sourceName - source of the request (used for logging)
        entityOneProxy - content of end one
        entityTwoProxy - content of end two
        typeDef - typeDef for the relationship
        methodName - name of the method making the request
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - types do not align
      • verifyEntityIsClassified

        boolean verifyEntityIsClassified​(java.util.List<java.lang.String> requiredClassifications,
                                         org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary entity)
        Return a boolean indicating whether the supplied entity is classified with one or more of the supplied classifications.
        Parameters:
        requiredClassifications - list of required classification null means that there are no specific classification requirements and so results in a true response.
        entity - entity to test.
        Returns:
        boolean result
      • countMatchingPropertyValues

        int countMatchingPropertyValues​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties matchProperties,
                                        org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties)
                                 throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Count the number of matching property values that an instance has. They may come from an entity, classification or relationship.
        Parameters:
        matchProperties - the properties to match.
        instanceProperties - the properties from the instance.
        Returns:
        integer count of the matching properties.
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - invalid search criteria
      • countMatchingHeaderPropertyValues

        int countMatchingHeaderPropertyValues​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties matchProperties,
                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader instanceHeader,
                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties)
                                       throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Count the number of matching property values that an instance has. They may come from an entity, or relationship.
        Parameters:
        matchProperties - the properties to match.
        instanceHeader - the header properties from the instance.
        instanceProperties - the effectivity dates.
        Returns:
        integer count of the matching properties.
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - invalid search criteria
      • verifyMatchingInstancePropertyValues

        boolean verifyMatchingInstancePropertyValues​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties matchProperties,
                                                     org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader instanceHeader,
                                                     org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties,
                                                     MatchCriteria matchCriteria)
                                              throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Determine if the instance properties match the match criteria.
        Parameters:
        matchProperties - the properties to match.
        instanceHeader - the header of the instance.
        instanceProperties - the properties from the instance.
        matchCriteria - rule on how the match should occur.
        Returns:
        boolean flag indicating whether the two sets of properties match
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - invalid search criteria
      • getNumericRepresentation

        java.math.BigDecimal getNumericRepresentation​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstancePropertyValue value)
        Retrieve a numeric representation of the provided value, or null if it cannot be converted to a number.
        Parameters:
        value - to convert
        Returns:
        BigDecimal
      • verifyMatchingInstancePropertyValues

        boolean verifyMatchingInstancePropertyValues​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search.SearchProperties matchProperties,
                                                     org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader instanceHeader,
                                                     org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties)
                                              throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Determine if the instance properties match the property-based conditions.
        Parameters:
        matchProperties - the property-based conditions to match.
        instanceHeader - the header of the instance.
        instanceProperties - the properties from the instance.
        Returns:
        boolean flag indicating whether the two sets of properties match
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - invalid search criteria
      • verifyMatchingClassifications

        boolean verifyMatchingClassifications​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.search.SearchClassifications matchClassifications,
                                              org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntitySummary entity)
                                       throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Determine if the instance properties match the classification-based conditions.
        Parameters:
        matchClassifications - the classification-based conditions to match.
        entity - the entity instance.
        Returns:
        boolean flag indicating whether the classifications match
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - invalid search criteria
      • validateReferenceInstanceHeader

        void validateReferenceInstanceHeader​(java.lang.String sourceName,
                                             java.lang.String localMetadataCollectionId,
                                             java.lang.String instanceParameterName,
                                             org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceHeader instance,
                                             java.lang.String methodName)
                                      throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException,
                                             org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Validates that an instance has the correct header for it to be a reference copy.
        Parameters:
        sourceName - source of the request (used for logging)
        localMetadataCollectionId - the unique identifier for the local repository' metadata collection.
        instanceParameterName - the name of the parameter that provided the instance.
        instance - the instance to test
        methodName - the name of the method that supplied the instance.
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - problem with repository
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - the instance is null or linked to local metadata repository
      • validateEntityProxy

        void validateEntityProxy​(java.lang.String sourceName,
                                 java.lang.String localMetadataCollectionId,
                                 java.lang.String proxyParameterName,
                                 org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityProxy entityProxy,
                                 java.lang.String methodName)
                          throws org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException
        Validates an entity proxy. It must be a reference copy (ie owned by a different repository).
        Parameters:
        sourceName - source of the request (used for logging)
        localMetadataCollectionId - unique identifier for this repository's metadata collection
        proxyParameterName - name of the parameter used to provide the parameter
        entityProxy - proxy to add
        methodName - name of the method that adds the proxy
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.InvalidParameterException - the entity proxy is null or for an entity homed in this repository
      • verifyInstancePropertiesMatchSearchCriteria

        boolean verifyInstancePropertiesMatchSearchCriteria​(java.lang.String sourceName,
                                                            org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                            java.lang.String searchCriteria,
                                                            java.lang.String methodName)
                                                     throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Search for property values matching the search criteria (a regular expression)
        Parameters:
        sourceName - source of the request (used for logging)
        properties - list of properties associated with the in instance
        searchCriteria - regular expression for testing the property values
        methodName - name of the method requiring the search.
        Returns:
        boolean indicating whether the search criteria is located in any of the string parameter values.
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - the properties are not properly set up in the instance
      • verifyInstancePropertiesMatchPropertyValue

        boolean verifyInstancePropertiesMatchPropertyValue​(java.lang.String sourceName,
                                                           org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties properties,
                                                           java.lang.String searchPropertyValue,
                                                           java.lang.String methodName)
                                                    throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Search for property values matching the supplied property value
        Parameters:
        sourceName - source of the request (used for logging)
        properties - list of properties associated with the in instance
        searchPropertyValue - property value as a string
        methodName - name of the method requiring the search.
        Returns:
        boolean indicating whether the search criteria is located in any of the string parameter values.
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - the properties are not properly set up in the instance
      • getStringFromPropertyValue

        java.lang.String getStringFromPropertyValue​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstancePropertyValue instancePropertyValue)
        Return the string form of a property value. Can be used as propertyValue on find property value calls.
        Parameters:
        instancePropertyValue - value to extract the string from
        Returns:
        extracted string value.
      • getStringValuesFromInstancePropertiesAsArray

        java.lang.String getStringValuesFromInstancePropertiesAsArray​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties)
        Return the string form of the instance properties. Can be used as propertyValue on find property value calls.
        Parameters:
        instanceProperties - value to extract the string from
        Returns:
        extracted string value.
      • getStringValuesFromInstancePropertiesAsMap

        java.lang.String getStringValuesFromInstancePropertiesAsMap​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties)
        Return the string form of the instance properties. Can be used as propertyValue on find property value calls.
        Parameters:
        instanceProperties - value to extract the string from
        Returns:
        extracted string value.
      • getStringValuesFromInstancePropertiesAsStruct

        java.lang.String getStringValuesFromInstancePropertiesAsStruct​(org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceProperties instanceProperties)
        Return the string form of the instance properties. Can be used as propertyValue on find property value calls.
        Parameters:
        instanceProperties - value to extract the string from
        Returns:
        extracted string value.
      • isATypeOf

        boolean isATypeOf​(java.lang.String sourceName,
                          org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.InstanceAuditHeader instance,
                          java.lang.String typeName,
                          java.lang.String localMethodName)
        Returns a boolean indicating that the instance is of the supplied type. It tests the base type and all the super types.
        Parameters:
        sourceName - source of the request (used for logging)
        instance - instance to test
        typeName - name of the type
        localMethodName - local method that is calling isATypeOf
        Returns:
        true if typeName is instance type or a supertype of it, otherwise false
      • validateAtMostOneEntityResult

        void validateAtMostOneEntityResult​(java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail> findResults,
                                           java.lang.String typeName,
                                           java.lang.String serviceName,
                                           java.lang.String methodName)
                                    throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Validate that either zero or one entities were returned from a find request. This is typically when searching for entities of a specific type using one of its unique properties.
        Parameters:
        findResults - list of entities returned from the search.
        typeName - name of the type of entities requested.
        serviceName - service that requested the entities.
        methodName - calling method.
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - results are not as expected
      • validateAtMostOneRelationshipResult

        void validateAtMostOneRelationshipResult​(java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Relationship> findResults,
                                                 java.lang.String typeName,
                                                 java.lang.String serviceName,
                                                 java.lang.String methodName)
                                          throws org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException
        Validate that either zero or one relationships were returned from a find request. This is typically when searching for relationships of a specific type where the cardinality is set to AT_MOST_ONE in the RelationshipEndCardinality.
        Parameters:
        findResults - list of relationships returned from the search.
        typeName - name of the type of relationships requested.
        serviceName - service that requested the relationships.
        methodName - calling method.
        Throws:
        org.odpi.openmetadata.repositoryservices.ffdc.exception.RepositoryErrorException - results are not as expected