Class OMRSMetadataCollectionBase

  • All Implemented Interfaces:
    AuditLoggingComponent
    Direct Known Subclasses:
    LocalOMRSMetadataCollection, OMRSDynamicTypeMetadataCollectionBase, OMRSFixedTypeMetadataCollectionBase

    public abstract class OMRSMetadataCollectionBase
    extends OMRSMetadataCollection

    OMRSMetadataInstanceStore is the common interface for working with the contents of a metadata repository. Within a metadata collection are the type definitions (TypeDefs) and metadata instances (Entities and Relationships). OMRSMetadataCollectionBase provides empty implementation of the abstract methods of OMRSMetadataInstanceStore. The methods on OMRSMetadataInstanceStore are in the following major groups:

    • Methods to retrieve information about the metadata repository - Used to retrieve or confirm the identity of the metadata repository
    • Methods for working with typedefs - Typedefs are used to define the type model for open metadata. The open metadata support had a comprehensive set of typedefs implemented, and these can be augmented by different vendors or applications. The typedefs can be queried, created, updated and deleted though the metadata collection.
    • Methods for querying Entities and Relationships - The metadata repository stores instances of the typedefs as metadata instances. Principally these are entities (nodes in the graph) and relationships (links between nodes). Both the entities and relationships can have properties. The entity may also have structured properties called structs and classifications attached. This second group of methods supports a range of queries to retrieve these instances.
    • Methods for maintaining the instances - The fourth group of methods supports the maintenance of the metadata instances. Each instance as a status (see InstanceStatus) that allows an instance to be proposed, drafted and approved before it becomes active. The instances can also be soft-deleted and restored or purged from the metadata collection.
    • Methods for repairing the metadata collections of the cohort - The fifth group of methods are for editing the control information of entities and relationships to manage changes in the cohort. These methods are advanced methods and are rarely used.
    • Methods for local maintenance of a metadata collection The final group of methods are for removing reference copies of the metadata instances. These updates are not broadcast to the rest of the Cohort as events.
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addAttributeTypeDef​(java.lang.String userId, AttributeTypeDef newAttributeTypeDef)
      Create a definition of a new AttributeTypeDef.
      EntityDetail addEntity​(java.lang.String userId, java.lang.String entityTypeGUID, InstanceProperties initialProperties, java.util.List<Classification> initialClassifications, InstanceStatus initialStatus)
      Create a new entity and put it in the requested state.
      protected TypeDef addEntityParameterValidation​(java.lang.String userId, java.lang.String entityTypeGUID, InstanceProperties initialProperties, java.util.List<Classification> initialClassifications, InstanceStatus initialStatus)
      Deprecated.
      protected TypeDef addEntityParameterValidation​(java.lang.String userId, java.lang.String entityTypeGUID, InstanceProperties initialProperties, java.util.List<Classification> initialClassifications, InstanceStatus initialStatus, java.lang.String methodName)
      Validate that the parameters passed to addEntity are valid.
      void addEntityProxy​(java.lang.String userId, EntityProxy entityProxy)
      Create an entity proxy in the metadata collection.
      protected void addEntityProxyParameterValidation​(java.lang.String userId, EntityProxy entityProxy)
      Validate the parameters for addEntityProxy.
      EntityDetail addExternalEntity​(java.lang.String userId, java.lang.String entityTypeGUID, java.lang.String externalSourceGUID, java.lang.String externalSourceName, InstanceProperties initialProperties, java.util.List<Classification> initialClassifications, InstanceStatus initialStatus)
      Save a new entity that is sourced from an external technology.
      protected TypeDef addExternalEntityParameterValidation​(java.lang.String userId, java.lang.String entityTypeGUID, java.lang.String externalSourceGUID, InstanceProperties initialProperties, java.util.List<Classification> initialClassifications, InstanceStatus initialStatus, java.lang.String methodName)
      Validate parameters needed to save a new entity that is sourced from an external technology.
      Relationship addExternalRelationship​(java.lang.String userId, java.lang.String relationshipTypeGUID, java.lang.String externalSourceGUID, java.lang.String externalSourceName, InstanceProperties initialProperties, java.lang.String entityOneGUID, java.lang.String entityTwoGUID, InstanceStatus initialStatus)
      Save a new relationship that is sourced from an external technology.
      protected TypeDef addExternalRelationshipParameterValidation​(java.lang.String userId, java.lang.String relationshipTypeGUID, java.lang.String externalSourceGUID, InstanceProperties initialProperties, java.lang.String entityOneGUID, java.lang.String entityTwoGUID, InstanceStatus initialStatus, java.lang.String methodName)
      Validate the parameters needed to save a new relationship that is sourced from an external technology.
      Relationship addRelationship​(java.lang.String userId, java.lang.String relationshipTypeGUID, InstanceProperties initialProperties, java.lang.String entityOneGUID, java.lang.String entityTwoGUID, InstanceStatus initialStatus)
      Add a new relationship between two entities to the metadata collection.
      protected TypeDef addRelationshipParameterValidation​(java.lang.String userId, java.lang.String relationshipTypeGUID, InstanceProperties initialProperties, java.lang.String entityOneGUID, java.lang.String entityTwoGUID, InstanceStatus initialStatus)
      Deprecated.
      protected TypeDef addRelationshipParameterValidation​(java.lang.String userId, java.lang.String relationshipTypeGUID, InstanceProperties initialProperties, java.lang.String entityOneGUID, java.lang.String entityTwoGUID, InstanceStatus initialStatus, java.lang.String methodName)
      Validate the parameters for adding a new relationship between two entities to the metadata collection.
      void addTypeDef​(java.lang.String userId, TypeDef newTypeDef)
      Create a definition of a new TypeDef.
      void addTypeDefGallery​(java.lang.String userId, TypeDefGallery newTypes)
      Create a collection of related types.
      protected void attributeTypeDefCategoryParameterValidation​(java.lang.String userId, AttributeTypeDefCategory category, java.lang.String categoryParameterName, java.lang.String methodName)
      Validate the properties of a request that accesses types by category.
      protected void attributeTypeDefParameterValidation​(java.lang.String userId, AttributeTypeDef attributeTypeDef, java.lang.String typeDefParameterName, java.lang.String methodName)
      Validate that a supplied attributeTypeDef is valid.
      EntityDetail classifyEntity​(java.lang.String userId, java.lang.String entityGUID, java.lang.String classificationName, java.lang.String externalSourceGUID, java.lang.String externalSourceName, ClassificationOrigin classificationOrigin, java.lang.String classificationOriginGUID, InstanceProperties classificationProperties)
      Add the requested classification to a specific entity.
      EntityDetail classifyEntity​(java.lang.String userId, java.lang.String entityGUID, java.lang.String classificationName, InstanceProperties classificationProperties)
      Add the requested classification to a specific entity.
      protected TypeDef classifyEntityParameterValidation​(java.lang.String userId, java.lang.String entityGUID, java.lang.String classificationName, InstanceProperties classificationProperties)
      Deprecated.
      protected TypeDef classifyEntityParameterValidation​(java.lang.String userId, java.lang.String entityGUID, java.lang.String classificationName, InstanceProperties classificationProperties, java.lang.String methodName)
      Validate the parameters passed to classifyEntity.
      protected TypeDef classifyEntityParameterValidation​(java.lang.String userId, EntityProxy entityProxy, java.lang.String classificationName, InstanceProperties classificationProperties, java.lang.String methodName)
      Validate the parameters passed to classifyEntity.
      EntityDetail declassifyEntity​(java.lang.String userId, java.lang.String entityGUID, java.lang.String classificationName)
      Remove a specific classification from an entity.
      protected void declassifyEntityParameterValidation​(java.lang.String userId, java.lang.String entityGUID, java.lang.String classificationName)
      Deprecated.
      protected void declassifyEntityParameterValidation​(java.lang.String userId, java.lang.String entityGUID, java.lang.String classificationName, java.lang.String methodName)
      Validate the parameters passed to declassifyEntity.
      protected void declassifyEntityParameterValidation​(java.lang.String userId, EntityProxy entityProxy, java.lang.String classificationName, java.lang.String methodName)
      Validate the parameters passed to declassifyEntity.
      void deleteAttributeTypeDef​(java.lang.String userId, java.lang.String obsoleteTypeDefGUID, java.lang.String obsoleteTypeDefName)
      Delete an AttributeTypeDef.
      EntityDetail deleteEntity​(java.lang.String userId, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String obsoleteEntityGUID)
      Delete an entity.
      void deleteEntityReferenceCopy​(java.lang.String userId, EntityDetail entity)
      Remove a reference copy of the entity from the local repository.
      Relationship deleteRelationship​(java.lang.String userId, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String obsoleteRelationshipGUID)
      Delete a specific relationship.
      void deleteRelationshipReferenceCopy​(java.lang.String userId, Relationship relationship)
      Remove the reference copy of the relationship from the local repository.
      void deleteTypeDef​(java.lang.String userId, java.lang.String obsoleteTypeDefGUID, java.lang.String obsoleteTypeDefName)
      Delete the TypeDef.
      protected java.util.List<AttributeTypeDef> filterAttributeTypeDefsByCategory​(java.util.List<AttributeTypeDef> allTypes, AttributeTypeDefCategory category)
      Returns all the types for a specific category.
      AttributeTypeDef filterAttributeTypeDefsByGUID​(java.util.List<AttributeTypeDef> allTypes, java.lang.String guid)
      Return the AttributeTypeDef that matches the guid.
      AttributeTypeDef filterAttributeTypeDefsByName​(java.util.List<AttributeTypeDef> allTypes, java.lang.String name)
      Return the TypeDef that matches the name.
      protected java.util.List<TypeDef> filterTypeDefsByCategory​(java.util.List<TypeDef> allTypes, TypeDefCategory category)
      Returns all the types for a specific category.
      TypeDef filterTypeDefsByGUID​(java.util.List<TypeDef> allTypes, java.lang.String guid)
      Return the TypeDef that matches the guid.
      TypeDef filterTypeDefsByName​(java.util.List<TypeDef> allTypes, java.lang.String name)
      Return the TypeDef that matches the name.
      protected java.util.List<TypeDef> filterTypeDefsByProperty​(java.util.List<TypeDef> allTypes, TypeDefProperties matchCriteria)
      Return the TypeDefs that have the properties matching the supplied match criteria.
      java.util.List<TypeDef> filterTypeDefsBySearchCriteria​(java.util.List<TypeDef> allTypes, java.lang.String searchCriteria)
      Return the TypeDefs that match the search criteria.
      java.util.List<TypeDef> filterTypesByExternalID​(java.util.List<TypeDef> allTypes, java.lang.String standard, java.lang.String organization, java.lang.String identifier)
      Match the supplied external standard identifiers against the active types for this repository.
      TypeDefGallery filterTypesByWildCardName​(java.util.List<TypeDef> allTypeDefs, java.util.List<AttributeTypeDef> allAttributeTypeDefs, java.lang.String typeDefName)
      Return the types identified by the name supplied by the caller.
      java.util.List<AttributeTypeDef> findAttributeTypeDefsByCategory​(java.lang.String userId, AttributeTypeDefCategory category)
      Returns all the AttributeTypeDefs for a specific category.
      java.util.List<EntityDetail> findEntities​(java.lang.String userId, java.lang.String entityTypeGUID, java.util.List<java.lang.String> entitySubtypeGUIDs, SearchProperties matchProperties, int fromEntityElement, java.util.List<InstanceStatus> limitResultsByStatus, SearchClassifications matchClassifications, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Return a list of entities that match the supplied criteria.
      java.util.List<EntityDetail> findEntitiesByClassification​(java.lang.String userId, java.lang.String entityTypeGUID, java.lang.String classificationName, InstanceProperties matchClassificationProperties, MatchCriteria matchCriteria, int fromEntityElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Return a list of entities that have the requested type of classifications attached.
      protected void findEntitiesByClassificationParameterValidation​(java.lang.String userId, java.lang.String entityTypeGUID, java.lang.String classificationName, InstanceProperties matchClassificationProperties, MatchCriteria matchCriteria, int fromEntityElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Validate the parameters for findEntitiesByClassification.
      java.util.List<EntityDetail> findEntitiesByProperty​(java.lang.String userId, java.lang.String entityTypeGUID, InstanceProperties matchProperties, MatchCriteria matchCriteria, int fromEntityElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.List<java.lang.String> limitResultsByClassification, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Return a list of entities that match the supplied properties according to the match criteria.
      protected void findEntitiesByPropertyParameterValidation​(java.lang.String userId, java.lang.String entityTypeGUID, InstanceProperties matchProperties, MatchCriteria matchCriteria, int fromEntityElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.List<java.lang.String> limitResultsByClassification, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Validate the parameters for findEntitiesByProperty.
      java.util.List<EntityDetail> findEntitiesByPropertyValue​(java.lang.String userId, java.lang.String entityTypeGUID, java.lang.String searchCriteria, int fromEntityElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.List<java.lang.String> limitResultsByClassification, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Return a list of entities whose string based property values match the search criteria.
      protected void findEntitiesByPropertyValueParameterValidation​(java.lang.String userId, java.lang.String entityTypeGUID, java.lang.String searchCriteria, int fromEntityElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.List<java.lang.String> limitResultsByClassification, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Validate parameters passed to findEntitiesByPropertyValue.
      protected void findEntitiesParameterValidation​(java.lang.String userId, java.lang.String entityTypeGUID, java.util.List<java.lang.String> entitySubtypeGUIDs, SearchProperties matchProperties, int fromEntityElement, java.util.List<InstanceStatus> limitResultsByStatus, SearchClassifications matchClassifications, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Validate the parameters for findEntities.
      java.util.List<Relationship> findRelationships​(java.lang.String userId, java.lang.String relationshipTypeGUID, java.util.List<java.lang.String> relationshipSubtypeGUIDs, SearchProperties matchProperties, int fromRelationshipElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Return a list of relationships that match the requested conditions.
      java.util.List<Relationship> findRelationshipsByProperty​(java.lang.String userId, java.lang.String relationshipTypeGUID, InstanceProperties matchProperties, MatchCriteria matchCriteria, int fromRelationshipElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Return a list of relationships that match the requested properties by the matching criteria.
      protected void findRelationshipsByPropertyParameterValidation​(java.lang.String userId, java.lang.String relationshipTypeGUID, InstanceProperties matchProperties, MatchCriteria matchCriteria, int fromRelationshipElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Validate the parameters passed to findRelationshipsByProperty.
      java.util.List<Relationship> findRelationshipsByPropertyValue​(java.lang.String userId, java.lang.String relationshipTypeGUID, java.lang.String searchCriteria, int fromRelationshipElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Return a list of relationships whose string based property values match the search criteria.
      protected void findRelationshipsByPropertyValueParameterValidation​(java.lang.String userId, java.lang.String relationshipTypeGUID, java.lang.String searchCriteria, int fromRelationshipElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Validate the parameters passed to findRelationshipsByPropertyName.
      protected void findRelationshipsParameterValidation​(java.lang.String userId, java.lang.String relationshipTypeGUID, java.util.List<java.lang.String> relationshipSubtypeGUIDs, SearchProperties matchProperties, int fromRelationshipElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Validate the parameters passed to findRelationships.
      java.util.List<TypeDef> findTypeDefsByCategory​(java.lang.String userId, TypeDefCategory category)
      Returns all the TypeDefs for a specific category.
      java.util.List<TypeDef> findTypeDefsByProperty​(java.lang.String userId, TypeDefProperties matchCriteria)
      Return the TypeDefs that have the properties matching the supplied match criteria.
      java.util.List<TypeDef> findTypesByExternalID​(java.lang.String userId, java.lang.String standard, java.lang.String organization, java.lang.String identifier)
      Return the types that are linked to the elements from the specified standard.
      TypeDefGallery findTypesByName​(java.lang.String userId, java.lang.String name)
      Returns a list of type definitions that have the specified name.
      TypeDefGallery getAllTypes​(java.lang.String userId)
      Returns the list of different types of metadata organized into two groups.
      AttributeTypeDef getAttributeTypeDefByGUID​(java.lang.String userId, java.lang.String guid)
      Return the AttributeTypeDef identified by the GUID.
      AttributeTypeDef getAttributeTypeDefByName​(java.lang.String userId, java.lang.String name)
      Return the AttributeTypeDef identified by the unique name.
      EntityDetail getEntityDetail​(java.lang.String userId, java.lang.String guid)
      Return the header, classifications and properties of a specific entity.
      EntityDetail getEntityDetail​(java.lang.String userId, java.lang.String guid, java.util.Date asOfTime)
      Return a historical version of an entity.
      java.util.List<EntityDetail> getEntityDetailHistory​(java.lang.String userId, java.lang.String guid, java.util.Date fromTime, java.util.Date toTime, int startFromElement, int pageSize, HistorySequencingOrder sequencingOrder)
      Return all historical versions of an entity within the bounds of the provided timestamps.
      InstanceGraph getEntityNeighborhood​(java.lang.String userId, java.lang.String entityGUID, java.util.List<java.lang.String> entityTypeGUIDs, java.util.List<java.lang.String> relationshipTypeGUIDs, java.util.List<InstanceStatus> limitResultsByStatus, java.util.List<java.lang.String> limitResultsByClassification, java.util.Date asOfTime, int level)
      Return the entities and relationships that radiate out from the supplied entity GUID.
      protected void getEntityNeighborhoodParameterValidation​(java.lang.String userId, java.lang.String entityGUID, java.util.List<java.lang.String> entityTypeGUIDs, java.util.List<java.lang.String> relationshipTypeGUIDs, java.util.List<InstanceStatus> limitResultsByStatus, java.util.List<java.lang.String> limitResultsByClassification, java.util.Date asOfTime, int level)
      Return the entities and relationships that radiate out from the supplied entity GUID.
      protected EntityProxy getEntityProxy​(java.lang.String userId, java.lang.String entityGUID, java.lang.String methodName)
      Retrieve an entity proxy
      EntitySummary getEntitySummary​(java.lang.String userId, java.lang.String guid)
      Return the header and classifications for a specific entity.
      java.util.List<Classification> getHomeClassifications​(java.lang.String userId, java.lang.String entityGUID)
      Retrieve any locally homed classifications assigned to the requested entity.
      java.util.List<Classification> getHomeClassifications​(java.lang.String userId, java.lang.String entityGUID, java.util.Date asOfTime)
      Retrieve any locally homed classifications assigned to the requested entity.
      protected void getInstanceHistoryParameterValidation​(java.lang.String userId, java.lang.String guid, java.util.Date fromTime, java.util.Date toTime, java.lang.String methodName)
      Validate the parameters for a retrieve multiple historical versions of an instance.
      protected void getInstanceParameterValidation​(java.lang.String userId, java.lang.String guid, java.lang.String methodName)
      Validate the parameters for a retrieve of an instance.
      protected void getInstanceParameterValidation​(java.lang.String userId, java.lang.String guid, java.util.Date asOfTime, java.lang.String methodName)
      Validate the parameters for a retrieve of a historical version of an instance.
      InstanceGraph getLinkingEntities​(java.lang.String userId, java.lang.String startEntityGUID, java.lang.String endEntityGUID, java.util.List<InstanceStatus> limitResultsByStatus, java.util.Date asOfTime)
      Return all the relationships and intermediate entities that connect the startEntity with the endEntity.
      protected void getLinkingEntitiesParameterValidation​(java.lang.String userId, java.lang.String startEntityGUID, java.lang.String endEntityGUID, java.util.List<InstanceStatus> limitResultsByStatus, java.util.Date asOfTime)
      Validate the parameters passed to getLinkingEntities.
      java.lang.String getMetadataCollectionId​(java.lang.String userId)
      Returns the identifier of the metadata repository.
      java.util.List<EntityDetail> getRelatedEntities​(java.lang.String userId, java.lang.String startEntityGUID, java.util.List<java.lang.String> entityTypeGUIDs, int fromEntityElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.List<java.lang.String> limitResultsByClassification, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Return the list of entities that are of the types listed in entityTypeGUIDs and are connected, either directly or indirectly to the entity identified by startEntityGUID.
      protected void getRelatedEntitiesParameterValidation​(java.lang.String userId, java.lang.String startEntityGUID, java.util.List<java.lang.String> entityTypeGUIDs, int fromEntityElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.List<java.lang.String> limitResultsByClassification, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Validate the parameters passed to the getRelatedEntities.
      Relationship getRelationship​(java.lang.String userId, java.lang.String guid)
      Return a requested relationship.
      Relationship getRelationship​(java.lang.String userId, java.lang.String guid, java.util.Date asOfTime)
      Return a historical version of a relationship.
      java.util.List<Relationship> getRelationshipHistory​(java.lang.String userId, java.lang.String guid, java.util.Date fromTime, java.util.Date toTime, int startFromElement, int pageSize, HistorySequencingOrder sequencingOrder)
      Return all historical versions of a relationship within the bounds of the provided timestamps.
      java.util.List<Relationship> getRelationshipsForEntity​(java.lang.String userId, java.lang.String entityGUID, java.lang.String relationshipTypeGUID, int fromRelationshipElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Return the relationships for a specific entity.
      protected void getRelationshipsForEntityParameterValidation​(java.lang.String userId, java.lang.String entityGUID, java.lang.String relationshipTypeGUID, int fromRelationshipElement, java.util.List<InstanceStatus> limitResultsByStatus, java.util.Date asOfTime, java.lang.String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)
      Validate the parameters for getRelationshipsForEntity.
      TypeDef getTypeDefByGUID​(java.lang.String userId, java.lang.String guid)
      Return the TypeDef identified by the GUID.
      TypeDef getTypeDefByName​(java.lang.String userId, java.lang.String name)
      Return the TypeDef identified by the unique name.
      protected TypeDef getTypeDefForInstance​(InstanceHeader header, java.lang.String methodName)
      Extract the typeDef for an instance
      EntityDetail isEntityKnown​(java.lang.String userId, java.lang.String guid)
      Returns the entity if the entity is stored in the metadata collection, otherwise null.
      Relationship isRelationshipKnown​(java.lang.String userId, java.lang.String guid)
      Returns a relationship indicating if the relationship is stored in the metadata collection.
      protected AttributeTypeDef manageAttributeTypeDefParameterValidation​(java.lang.String userId, java.lang.String guidParameterName, java.lang.String nameParameterName, java.lang.String attributeTypeDefGUID, java.lang.String attributeTypeDefName, java.lang.String methodName)
      Validate the type information for a management change to an attributeTypeDef.
      protected void manageInstanceParameterValidation​(java.lang.String userId, java.lang.String instanceGUID, java.lang.String methodName)
      Deprecated.
      protected void manageInstanceParameterValidation​(java.lang.String userId, java.lang.String instanceGUID, java.lang.String instanceGUIDParameterName, java.lang.String methodName)
      Validate the parameters for calls that manage an existing instance.
      protected void manageInstanceParameterValidation​(java.lang.String userId, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String instanceGUID, java.lang.String instanceGUIDParameterName, java.lang.String methodName)
      Validate the parameters passed to delete() or purge() instance method.
      protected void manageReferenceInstanceParameterValidation​(java.lang.String userId, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String instanceGUID, java.lang.String instanceGUIDParameterName, java.lang.String homeMetadataCollectionId, java.lang.String homeParameterName, java.lang.String methodName)
      Validate the parameters passed to a reference instance method.
      protected TypeDef manageTypeDefParameterValidation​(java.lang.String userId, java.lang.String guidParameterName, java.lang.String nameParameterName, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String methodName)
      Validate the type information for a management change to a type.
      protected void newAttributeTypeDefParameterValidation​(java.lang.String userId, AttributeTypeDef attributeTypeDef, java.lang.String typeDefParameterName, java.lang.String methodName)
      Validate that a supplied attributeTypeDef is valid and unknown.
      protected void newTypeDefParameterValidation​(java.lang.String userId, TypeDef typeDef, java.lang.String typeDefParameterName, java.lang.String methodName)
      Validate that a supplied typeDef is valid and unknown.
      void purgeClassificationReferenceCopy​(java.lang.String userId, EntityDetail entity, Classification classification)
      Remove the reference copy of the classification from the local repository.
      void purgeEntity​(java.lang.String userId, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String deletedEntityGUID)
      Permanently removes a deleted entity from the metadata collection.
      void purgeEntityReferenceCopy​(java.lang.String userId, java.lang.String entityGUID, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String homeMetadataCollectionId)
      Remove a reference copy of the entity from the local repository.
      void purgeEntityReferenceCopy​(java.lang.String userId, EntityDetail entity)
      Remove a reference copy of the entity from the local repository.
      void purgeRelationship​(java.lang.String userId, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String deletedRelationshipGUID)
      Permanently delete the relationship from the repository.
      void purgeRelationshipReferenceCopy​(java.lang.String userId, java.lang.String relationshipGUID, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String homeMetadataCollectionId)
      Remove the reference copy of the relationship from the local repository.
      void purgeRelationshipReferenceCopy​(java.lang.String userId, Relationship relationship)
      Remove the reference copy of the relationship from the local repository.
      protected void referenceInstanceParameterValidation​(java.lang.String userId, InstanceHeader instanceHeader, java.lang.String instanceParameterName, java.lang.String methodName)
      Validate the header instance passed to delete() or purge() instance method.
      void refreshEntityReferenceCopy​(java.lang.String userId, java.lang.String entityGUID, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String homeMetadataCollectionId)
      The local repository has requested that the repository that hosts the home metadata collection for the specified entity sends out the details of this entity so the local repository can create a reference copy.
      void refreshRelationshipReferenceCopy​(java.lang.String userId, java.lang.String relationshipGUID, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String homeMetadataCollectionId)
      The local server has requested that the repository that hosts the home metadata collection for the specified relationship sends out the details of this relationship so the local repository can create a reference copy.
      EntityDetail reHomeEntity​(java.lang.String userId, java.lang.String entityGUID, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String homeMetadataCollectionId, java.lang.String newHomeMetadataCollectionId, java.lang.String newHomeMetadataCollectionName)
      Change the home of an existing entity.
      protected void reHomeInstanceParameterValidation​(java.lang.String userId, java.lang.String instanceGUID, java.lang.String instanceParameterName, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String homeMetadataCollectionId, java.lang.String newHomeMetadataCollectionId, java.lang.String methodName)
      Validate that the parameters passed to a reHome request are valid.
      Relationship reHomeRelationship​(java.lang.String userId, java.lang.String relationshipGUID, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String homeMetadataCollectionId, java.lang.String newHomeMetadataCollectionId, java.lang.String newHomeMetadataCollectionName)
      Change the home of an existing relationship.
      AttributeTypeDef reIdentifyAttributeTypeDef​(java.lang.String userId, java.lang.String originalAttributeTypeDefGUID, java.lang.String originalAttributeTypeDefName, java.lang.String newAttributeTypeDefGUID, java.lang.String newAttributeTypeDefName)
      Change the guid or name of an existing TypeDef to a new value.
      EntityDetail reIdentifyEntity​(java.lang.String userId, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String entityGUID, java.lang.String newEntityGUID)
      Change the guid of an existing entity to a new value.
      protected void reIdentifyInstanceParameterValidation​(java.lang.String userId, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String instanceGUID, java.lang.String instanceParameterName, java.lang.String newInstanceGUID, java.lang.String newInstanceParameterName, java.lang.String methodName)  
      Relationship reIdentifyRelationship​(java.lang.String userId, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String relationshipGUID, java.lang.String newRelationshipGUID)
      Change the guid of an existing relationship.
      TypeDef reIdentifyTypeDef​(java.lang.String userId, java.lang.String originalTypeDefGUID, java.lang.String originalTypeDefName, java.lang.String newTypeDefGUID, java.lang.String newTypeDefName)
      Change the guid or name of an existing TypeDef to a new value.
      protected void removeInstanceParameterValidation​(java.lang.String userId, java.lang.String typeDefGUID, java.lang.String typeDefName, java.lang.String instanceGUID, java.lang.String methodName)
      Deprecated.
      protected void reportEntityNotKnown​(java.lang.String entityGUID, java.lang.String methodName)
      Throw exception to indicate that an entity unique identifier is not recognized.
      protected void reportEntityProxyOnly​(java.lang.String guid, java.lang.String guidParameterName, java.lang.String methodName)
      Throw an exception for the situation where there is only a proxy and the caller wants an entity details.
      protected void reportRelationshipNotKnown​(java.lang.String relationshipGUID, java.lang.String methodName)
      Throw exception to indicate that a relationship unique identifier is not recognized.
      protected void reportTypeDefAlreadyDefined​(java.lang.String typeGUID, java.lang.String typeName, java.lang.String methodName)
      Report that the type can not be created because it is already defined.
      protected void reportTypeDefConflict​(java.lang.String typeGUID, java.lang.String typeName, java.lang.String methodName)
      Report a type conflict error.
      protected void reportTypeDefInUse​(java.lang.String typeGUID, java.lang.String typeName, java.lang.String methodName)
      Report that a type can not be deleted.
      protected void reportTypeDefNotSupported​(java.lang.String typeName, java.lang.String methodName)
      Throw exception to indicate that a relationship unique identifier is not recognized.
      protected void reportUnknownTypeGUID​(java.lang.String guid, java.lang.String guidParameterName, java.lang.String methodName)
      Throw exception to indicate that a type unique identifier is not recognized.
      protected void reportUnknownTypeName​(java.lang.String name, java.lang.String methodName)
      Throw exception to indicate that a type unique identifier is not recognized.
      protected void reportUnsupportedAsOfTimeFunction​(java.lang.String methodName, java.util.Date asOfTime)
      Return an exception to indicate that the method is unsupported but this is ok because it is optional.
      EntityDetail restoreEntity​(java.lang.String userId, java.lang.String deletedEntityGUID)
      Restore the requested entity to the state it was before it was deleted.
      Relationship restoreRelationship​(java.lang.String userId, java.lang.String deletedRelationshipGUID)
      Restore a deleted relationship into the metadata collection.
      EntityDetail reTypeEntity​(java.lang.String userId, java.lang.String entityGUID, TypeDefSummary currentTypeDefSummary, TypeDefSummary newTypeDefSummary)
      Change an existing entity's type.
      protected void reTypeInstanceParameterValidation​(java.lang.String userId, java.lang.String instanceGUID, java.lang.String instanceParameterName, TypeDefCategory expectedTypeDefCategory, TypeDefSummary currentTypeDefSummary, TypeDefSummary newTypeDefSummary, java.lang.String methodName)
      Validate the parameters needed to reType an instance.
      Relationship reTypeRelationship​(java.lang.String userId, java.lang.String relationshipGUID, TypeDefSummary currentTypeDefSummary, TypeDefSummary newTypeDefSummary)
      Change the existing relationship's type.
      void saveClassificationReferenceCopy​(java.lang.String userId, EntityDetail entity, Classification classification)
      Save the classification as a reference copy.
      void saveClassificationReferenceCopy​(java.lang.String userId, EntityProxy entity, Classification classification)
      Save the classification as a reference copy.
      void saveEntityReferenceCopy​(java.lang.String userId, EntityDetail entity)
      Save the entity as a reference copy.
      void saveRelationshipReferenceCopy​(java.lang.String userId, Relationship relationship)
      Save the relationship as a reference copy.
      java.util.List<TypeDef> searchForTypeDefs​(java.lang.String userId, java.lang.String searchCriteria)
      Return the TypeDefs that match the search criteria.
      protected void typeDefCategoryParameterValidation​(java.lang.String userId, TypeDefCategory category, java.lang.String categoryParameterName, java.lang.String methodName)
      Validate the properties of a request that accesses types by category.
      protected void typeDefExternalIDParameterValidation​(java.lang.String userId, java.lang.String standard, java.lang.String organization, java.lang.String identifier, java.lang.String methodName)
      Validate the properties used to locate types.
      protected void typeDefParameterValidation​(java.lang.String userId, TypeDef typeDef, java.lang.String typeDefParameterName, java.lang.String methodName)
      Validate that a supplied typeDef is valid.
      protected void typeDefPropertyParameterValidation​(java.lang.String userId, TypeDefProperties matchCriteria, java.lang.String matchCriteriaParameterName, java.lang.String methodName)
      Validate the properties used to locate types.
      protected void typeDefSearchParameterValidation​(java.lang.String userId, java.lang.String searchCriteria, java.lang.String searchCriteriaParameterName, java.lang.String methodName)
      Validate the properties used to locate types.
      protected void typeGUIDParameterValidation​(java.lang.String userId, java.lang.String guid, java.lang.String guidParameterName, java.lang.String methodName)
      Validate the properties of a request that accesses types by guid.
      protected void typeNameParameterValidation​(java.lang.String userId, java.lang.String name, java.lang.String nameParameterName, java.lang.String methodName)
      Validate the properties of a request that accesses types by name.
      EntityDetail undoEntityUpdate​(java.lang.String userId, java.lang.String entityGUID)
      Undo the last update to an entity and return the previous content.
      Relationship undoRelationshipUpdate​(java.lang.String userId, java.lang.String relationshipGUID)
      Undo the latest change to a relationship (either a change of properties or status).
      EntityDetail updateEntityClassification​(java.lang.String userId, java.lang.String entityGUID, java.lang.String classificationName, InstanceProperties properties)
      Update one or more properties in one of an entity's classifications.
      protected TypeDef updateEntityClassificationParameterValidation​(java.lang.String userId, java.lang.String entityGUID, java.lang.String classificationName, InstanceProperties properties)
      Deprecated.
      protected TypeDef updateEntityClassificationParameterValidation​(java.lang.String userId, EntityProxy entityProxy, java.lang.String classificationName, InstanceProperties properties)
      Deprecated.
      EntityDetail updateEntityProperties​(java.lang.String userId, java.lang.String entityGUID, InstanceProperties properties)
      Update selected properties in an entity.
      EntityDetail updateEntityStatus​(java.lang.String userId, java.lang.String entityGUID, InstanceStatus newStatus)
      Update the status for a specific entity.
      protected void updateInstancePropertiesPropertyValidation​(java.lang.String userId, java.lang.String instanceGUID, InstanceProperties properties, java.lang.String methodName)
      Validate the parameters for update the properties of an instance.
      protected void updateInstanceStatusParameterValidation​(java.lang.String userId, java.lang.String entityGUID, InstanceStatus newStatus, java.lang.String methodName)
      Validate parameters for updateEntityStatus.
      Relationship updateRelationshipProperties​(java.lang.String userId, java.lang.String relationshipGUID, InstanceProperties properties)
      Update the properties of a specific relationship.
      Relationship updateRelationshipStatus​(java.lang.String userId, java.lang.String relationshipGUID, InstanceStatus newStatus)
      Update the status of a specific relationship.
      TypeDef updateTypeDef​(java.lang.String userId, TypeDefPatch typeDefPatch)
      Update one or more properties of the TypeDef.
      protected TypeDef updateTypeDefParameterValidation​(java.lang.String userId, TypeDefPatch typeDefPatch, java.lang.String methodName)
      Validate that a patch to a type definition is valid.
      boolean verifyAttributeTypeDef​(java.lang.String userId, AttributeTypeDef attributeTypeDef)
      Verify that a definition of an AttributeTypeDef is either new or matches the definition already stored.
      boolean verifyTypeDef​(java.lang.String userId, TypeDef typeDef)
      Verify that a definition of a TypeDef is either new or matches the definition already stored.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait