Class GraphOMRSMetadataCollection
- java.lang.Object
-
- org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollection
-
- org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollectionBase
-
- org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSDynamicTypeMetadataCollectionBase
-
- org.odpi.openmetadata.adapters.repositoryservices.graphrepository.repositoryconnector.GraphOMRSMetadataCollection
-
- All Implemented Interfaces:
AuditLoggingComponent
public class GraphOMRSMetadataCollection extends OMRSDynamicTypeMetadataCollectionBase
The GraphOMRSMetadataCollection provides a local open metadata repository that uses a graph store as its persistence layer.
-
-
Field Summary
-
Fields inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollection
auditLog, metadataCollectionId, metadataCollectionName, parentConnector, repositoryHelper, repositoryName, repositoryValidator
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EntityDetailaddEntity(String userId, String entityTypeGUID, InstanceProperties initialProperties, List<Classification> initialClassifications, InstanceStatus initialStatus)voidaddEntityProxy(String userId, EntityProxy entityProxy)EntityDetailaddExternalEntity(String userId, String entityTypeGUID, String externalSourceGUID, String externalSourceName, InstanceProperties initialProperties, List<Classification> initialClassifications, InstanceStatus initialStatus)RelationshipaddExternalRelationship(String userId, String relationshipTypeGUID, String externalSourceGUID, String externalSourceName, InstanceProperties initialProperties, String entityOneGUID, String entityTwoGUID, InstanceStatus initialStatus)RelationshipaddRelationship(String userId, String relationshipTypeGUID, InstanceProperties initialProperties, String entityOneGUID, String entityTwoGUID, InstanceStatus initialStatus)EntityDetailclassifyEntity(String userId, String entityGUID, String classificationName, String externalSourceGUID, String externalSourceName, ClassificationOrigin classificationOrigin, String classificationOriginGUID, InstanceProperties classificationProperties)EntityDetailclassifyEntity(String userId, String entityGUID, String classificationName, InstanceProperties classificationProperties)EntityDetaildeclassifyEntity(String userId, String entityGUID, String classificationName)EntityDetaildeleteEntity(String userId, String typeDefGUID, String typeDefName, String obsoleteEntityGUID)RelationshipdeleteRelationship(String userId, String typeDefGUID, String typeDefName, String obsoleteRelationshipGUID)List<EntityDetail>findEntities(String userId, String entityTypeGUID, List<String> entitySubtypeGUIDs, SearchProperties matchProperties, int fromEntityElement, List<InstanceStatus> limitResultsByStatus, SearchClassifications matchClassifications, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)List<EntityDetail>findEntitiesByClassification(String userId, String entityTypeGUID, String classificationName, InstanceProperties matchClassificationProperties, MatchCriteria matchCriteria, int fromEntityElement, List<InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)List<EntityDetail>findEntitiesByProperty(String userId, String entityTypeGUID, InstanceProperties matchProperties, MatchCriteria matchCriteria, int fromEntityElement, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)List<EntityDetail>findEntitiesByPropertyIteratively(List<String> validTypeNames, InstanceProperties matchProperties, MatchCriteria matchCriteria)List<EntityDetail>findEntitiesByPropertyValue(String userId, String entityTypeGUID, String searchCriteria, int fromEntityElement, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)List<EntityDetail>findEntitiesByPropertyValueForTypes(List<String> validTypeNames, String filterTypeName, Map<String,TypeDefAttribute> qualifiedPropertyNameToTypeDefinedAttribute, Map<String,List<String>> shortPropertyNameToQualifiedPropertyNames, String searchCriteria)List<EntityDetail>findEntitiesIteratively(List<String> validTypeNames, SearchProperties searchProperties, MatchCriteria matchCriteria)List<Relationship>findRelationships(String userId, String relationshipTypeGUID, List<String> relationshipSubtypeGUIDs, SearchProperties matchProperties, int fromRelationshipElement, List<InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)Return a list of relationships that match the requested conditions.List<Relationship>findRelationshipsByProperty(String userId, String relationshipTypeGUID, InstanceProperties matchProperties, MatchCriteria matchCriteria, int fromRelationshipElement, List<InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)List<Relationship>findRelationshipsByPropertyIteratively(List<String> validTypeNames, InstanceProperties matchProperties, MatchCriteria matchCriteria)List<Relationship>findRelationshipsByPropertyValue(String userId, String relationshipTypeGUID, String searchCriteria, int fromRelationshipElement, List<InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)List<Relationship>findRelationshipsByPropertyValueForTypes(List<String> validTypeNames, String filterTypeName, Map<String,TypeDefAttribute> qualifiedPropertyNameToTypeDefinedAttribute, Map<String,List<String>> shortPropertyNameToQualifiedPropertyNames, String searchCriteria)List<Relationship>findRelationshipsForTypes(List<String> validTypeNames, SearchProperties searchProperties, MatchCriteria matchCriteria)EntityDetailgetEntityDetail(String userId, String guid)InstanceGraphgetEntityNeighborhood(String userId, String entityGUID, List<String> entityTypeGUIDs, List<String> relationshipTypeGUIDs, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, int level)EntitySummarygetEntitySummary(String userId, String guid)List<Classification>getHomeClassifications(String userId, String entityGUID)InstanceGraphgetLinkingEntities(String userId, String startEntityGUID, String endEntityGUID, List<InstanceStatus> limitResultsByStatus, Date asOfTime)List<EntityDetail>getRelatedEntities(String userId, String startEntityGUID, List<String> entityTypeGUIDs, int fromEntityElement, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)RelationshipgetRelationship(String userId, String guid)List<Relationship>getRelationshipsForEntity(String userId, String entityGUID, String relationshipTypeGUID, int fromRelationshipElement, List<InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize)EntityDetailisEntityKnown(String userId, String guid)RelationshipisRelationshipKnown(String userId, String guid)voidpurgeClassificationReferenceCopy(String userId, EntityDetail entity, Classification classification)voidpurgeEntity(String userId, String typeDefGUID, String typeDefName, String deletedEntityGUID)voidpurgeEntityReferenceCopy(String userId, String entityGUID, String typeDefGUID, String typeDefName, String homeMetadataCollectionId)voidpurgeRelationship(String userId, String typeDefGUID, String typeDefName, String deletedRelationshipGUID)voidpurgeRelationshipReferenceCopy(String userId, String relationshipGUID, String typeDefGUID, String typeDefName, String homeMetadataCollectionId)EntityDetailreHomeEntity(String userId, String entityGUID, String typeDefGUID, String typeDefName, String homeMetadataCollectionId, String newHomeMetadataCollectionId, String newHomeMetadataCollectionName)RelationshipreHomeRelationship(String userId, String relationshipGUID, String typeDefGUID, String typeDefName, String homeMetadataCollectionId, String newHomeMetadataCollectionId, String newHomeMetadataCollectionName)EntityDetailreIdentifyEntity(String userId, String typeDefGUID, String typeDefName, String entityGUID, String newEntityGUID)RelationshipreIdentifyRelationship(String userId, String typeDefGUID, String typeDefName, String relationshipGUID, String newRelationshipGUID)EntityDetailrestoreEntity(String userId, String deletedEntityGUID)RelationshiprestoreRelationship(String userId, String deletedRelationshipGUID)EntityDetailreTypeEntity(String userId, String entityGUID, TypeDefSummary currentTypeDefSummary, TypeDefSummary newTypeDefSummary)RelationshipreTypeRelationship(String userId, String relationshipGUID, TypeDefSummary currentTypeDefSummary, TypeDefSummary newTypeDefSummary)voidsaveClassificationReferenceCopy(String userId, EntityDetail entity, Classification classification)voidsaveEntityReferenceCopy(String userId, EntityDetail entity)voidsaveRelationshipReferenceCopy(String userId, Relationship relationship)EntityDetailupdateEntityClassification(String userId, String entityGUID, String classificationName, InstanceProperties properties)EntityDetailupdateEntityProperties(String userId, String entityGUID, InstanceProperties properties)EntityDetailupdateEntityStatus(String userId, String entityGUID, InstanceStatus newStatus)RelationshipupdateRelationshipProperties(String userId, String relationshipGUID, InstanceProperties properties)Update the properties of a specific relationship.RelationshipupdateRelationshipStatus(String userId, String relationshipGUID, InstanceStatus newStatus)voidvalidateTypeGUID(String sourceName, String guidParameterName, String guid, String methodName)booleanverifyTypeDef(String userId, TypeDef typeDef)-
Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSDynamicTypeMetadataCollectionBase
addAttributeTypeDef, addTypeDef, deleteAttributeTypeDef, deleteTypeDef, getHomeClassifications, reIdentifyAttributeTypeDef, reIdentifyTypeDef, updateTypeDef, verifyAttributeTypeDef
-
Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollectionBase
addEntityParameterValidation, addEntityParameterValidation, addEntityProxyParameterValidation, addExternalEntityParameterValidation, addExternalRelationshipParameterValidation, addRelationshipParameterValidation, addRelationshipParameterValidation, addTypeDefGallery, attributeTypeDefCategoryParameterValidation, attributeTypeDefParameterValidation, classifyEntityParameterValidation, classifyEntityParameterValidation, declassifyEntityParameterValidation, declassifyEntityParameterValidation, deleteEntityReferenceCopy, deleteRelationshipReferenceCopy, filterAttributeTypeDefsByCategory, filterAttributeTypeDefsByGUID, filterAttributeTypeDefsByName, filterTypeDefsByCategory, filterTypeDefsByGUID, filterTypeDefsByName, filterTypeDefsByProperty, filterTypeDefsBySearchCriteria, filterTypesByExternalID, filterTypesByWildCardName, findAttributeTypeDefsByCategory, findEntitiesByClassificationParameterValidation, findEntitiesByPropertyParameterValidation, findEntitiesByPropertyValueParameterValidation, findEntitiesParameterValidation, findRelationshipsByPropertyParameterValidation, findRelationshipsByPropertyValueParameterValidation, findRelationshipsParameterValidation, findTypeDefsByCategory, findTypeDefsByProperty, findTypesByExternalID, findTypesByName, getAllTypes, getAttributeTypeDefByGUID, getAttributeTypeDefByName, getEntityDetail, getEntityDetailHistory, getEntityNeighborhoodParameterValidation, getEntityProxy, getInstanceHistoryParameterValidation, getInstanceParameterValidation, getInstanceParameterValidation, getLinkingEntitiesParameterValidation, getMetadataCollectionId, getRelatedEntitiesParameterValidation, getRelationship, getRelationshipHistory, getRelationshipsForEntityParameterValidation, getTypeDefByGUID, getTypeDefByName, getTypeDefForInstance, manageAttributeTypeDefParameterValidation, manageInstanceParameterValidation, manageInstanceParameterValidation, manageInstanceParameterValidation, manageReferenceInstanceParameterValidation, manageTypeDefParameterValidation, newAttributeTypeDefParameterValidation, newTypeDefParameterValidation, purgeEntityReferenceCopy, purgeRelationshipReferenceCopy, referenceInstanceParameterValidation, refreshEntityReferenceCopy, refreshRelationshipReferenceCopy, reHomeInstanceParameterValidation, reIdentifyInstanceParameterValidation, removeInstanceParameterValidation, reportEntityNotKnown, reportEntityProxyOnly, reportRelationshipNotKnown, reportTypeDefAlreadyDefined, reportTypeDefConflict, reportTypeDefInUse, reportTypeDefNotSupported, reportUnknownTypeGUID, reportUnknownTypeName, reportUnsupportedAsOfTimeFunction, reportUnsupportedOptionalFunction, reTypeInstanceParameterValidation, searchForTypeDefs, typeDefCategoryParameterValidation, typeDefExternalIDParameterValidation, typeDefParameterValidation, typeDefPropertyParameterValidation, typeDefSearchParameterValidation, typeGUIDParameterValidation, typeNameParameterValidation, undoEntityUpdate, undoRelationshipUpdate, updateEntityClassificationParameterValidation, updateInstancePropertiesPropertyValidation, updateInstanceStatusParameterValidation, updateTypeDefParameterValidation
-
Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.OMRSMetadataCollection
basicRequestValidation, getMetadataCollectionId, reHomeEntity, reHomeRelationship, saveInstanceReferenceCopies, setAuditLog, validateRepositoryConnector
-
-
-
-
Method Detail
-
verifyTypeDef
public boolean verifyTypeDef(String userId, TypeDef typeDef) throws InvalidParameterException, RepositoryErrorException, TypeDefConflictException, InvalidTypeDefException, UserNotAuthorizedException
-
addEntity
public EntityDetail addEntity(String userId, String entityTypeGUID, InstanceProperties initialProperties, List<Classification> initialClassifications, InstanceStatus initialStatus) throws InvalidParameterException, RepositoryErrorException, TypeErrorException, PropertyErrorException, ClassificationErrorException, StatusNotSupportedException, UserNotAuthorizedException
-
addExternalEntity
public EntityDetail addExternalEntity(String userId, String entityTypeGUID, String externalSourceGUID, String externalSourceName, InstanceProperties initialProperties, List<Classification> initialClassifications, InstanceStatus initialStatus) throws InvalidParameterException, RepositoryErrorException, TypeErrorException, PropertyErrorException, ClassificationErrorException, StatusNotSupportedException, UserNotAuthorizedException
-
addEntityProxy
public void addEntityProxy(String userId, EntityProxy entityProxy) throws InvalidParameterException, RepositoryErrorException, UserNotAuthorizedException
- Overrides:
addEntityProxyin classOMRSMetadataCollectionBase- Throws:
InvalidParameterExceptionRepositoryErrorExceptionUserNotAuthorizedException
-
isEntityKnown
public EntityDetail isEntityKnown(String userId, String guid) throws InvalidParameterException, RepositoryErrorException, UserNotAuthorizedException
- Overrides:
isEntityKnownin classOMRSMetadataCollectionBase- Throws:
InvalidParameterExceptionRepositoryErrorExceptionUserNotAuthorizedException
-
isRelationshipKnown
public Relationship isRelationshipKnown(String userId, String guid) throws InvalidParameterException, RepositoryErrorException, UserNotAuthorizedException
- Overrides:
isRelationshipKnownin classOMRSMetadataCollectionBase- Throws:
InvalidParameterExceptionRepositoryErrorExceptionUserNotAuthorizedException
-
getEntitySummary
public EntitySummary getEntitySummary(String userId, String guid) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, UserNotAuthorizedException
-
getEntityDetail
public EntityDetail getEntityDetail(String userId, String guid) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, EntityProxyOnlyException, UserNotAuthorizedException
-
addRelationship
public Relationship addRelationship(String userId, String relationshipTypeGUID, InstanceProperties initialProperties, String entityOneGUID, String entityTwoGUID, InstanceStatus initialStatus) throws InvalidParameterException, RepositoryErrorException, TypeErrorException, PropertyErrorException, EntityNotKnownException, StatusNotSupportedException, UserNotAuthorizedException
-
addExternalRelationship
public Relationship addExternalRelationship(String userId, String relationshipTypeGUID, String externalSourceGUID, String externalSourceName, InstanceProperties initialProperties, String entityOneGUID, String entityTwoGUID, InstanceStatus initialStatus) throws InvalidParameterException, RepositoryErrorException, TypeErrorException, PropertyErrorException, EntityNotKnownException, StatusNotSupportedException, UserNotAuthorizedException
-
getRelationship
public Relationship getRelationship(String userId, String guid) throws InvalidParameterException, RepositoryErrorException, RelationshipNotKnownException, UserNotAuthorizedException
-
updateEntityStatus
public EntityDetail updateEntityStatus(String userId, String entityGUID, InstanceStatus newStatus) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, StatusNotSupportedException, UserNotAuthorizedException
-
updateEntityProperties
public EntityDetail updateEntityProperties(String userId, String entityGUID, InstanceProperties properties) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, PropertyErrorException, UserNotAuthorizedException
-
updateRelationshipStatus
public Relationship updateRelationshipStatus(String userId, String relationshipGUID, InstanceStatus newStatus) throws InvalidParameterException, RepositoryErrorException, RelationshipNotKnownException, StatusNotSupportedException, UserNotAuthorizedException
-
updateRelationshipProperties
public Relationship updateRelationshipProperties(String userId, String relationshipGUID, InstanceProperties properties) throws InvalidParameterException, RepositoryErrorException, RelationshipNotKnownException, PropertyErrorException, UserNotAuthorizedException
Update the properties of a specific relationship.- Overrides:
updateRelationshipPropertiesin classOMRSMetadataCollectionBase- Parameters:
userId- unique identifier for requesting user.relationshipGUID- String unique identifier (guid) for the relationship.properties- list of the properties to update.- Returns:
- Resulting relationship structure with the new properties set.
- Throws:
InvalidParameterException- one of the parameters is invalid or null.RepositoryErrorException- there is a problem communicating with the metadata repository where the metadata collection is stored.RelationshipNotKnownException- the requested relationship is not known in the metadata collection.PropertyErrorException- one or more of the requested properties are not defined, or have different characteristics in the TypeDef for this relationship's type.UserNotAuthorizedException- the userId is not permitted to perform this operation.
-
purgeEntity
public void purgeEntity(String userId, String typeDefGUID, String typeDefName, String deletedEntityGUID) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, EntityNotDeletedException, UserNotAuthorizedException
-
purgeRelationship
public void purgeRelationship(String userId, String typeDefGUID, String typeDefName, String deletedRelationshipGUID) throws InvalidParameterException, RepositoryErrorException, RelationshipNotKnownException, RelationshipNotDeletedException, UserNotAuthorizedException
-
getRelationshipsForEntity
public List<Relationship> getRelationshipsForEntity(String userId, String entityGUID, String relationshipTypeGUID, int fromRelationshipElement, List<InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize) throws InvalidParameterException, TypeErrorException, RepositoryErrorException, EntityNotKnownException, PropertyErrorException, PagingErrorException, UserNotAuthorizedException, FunctionNotSupportedException
-
findEntitiesByProperty
public List<EntityDetail> findEntitiesByProperty(String userId, String entityTypeGUID, InstanceProperties matchProperties, MatchCriteria matchCriteria, int fromEntityElement, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize) throws InvalidParameterException, TypeErrorException, RepositoryErrorException, PropertyErrorException, PagingErrorException, FunctionNotSupportedException, UserNotAuthorizedException
-
findEntitiesByPropertyIteratively
public List<EntityDetail> findEntitiesByPropertyIteratively(List<String> validTypeNames, InstanceProperties matchProperties, MatchCriteria matchCriteria) throws InvalidParameterException, RepositoryErrorException, TypeErrorException, PropertyErrorException
-
findEntitiesIteratively
public List<EntityDetail> findEntitiesIteratively(List<String> validTypeNames, SearchProperties searchProperties, MatchCriteria matchCriteria) throws InvalidParameterException, RepositoryErrorException, FunctionNotSupportedException
-
findRelationshipsForTypes
public List<Relationship> findRelationshipsForTypes(List<String> validTypeNames, SearchProperties searchProperties, MatchCriteria matchCriteria) throws InvalidParameterException, RepositoryErrorException, FunctionNotSupportedException
-
findRelationshipsByPropertyIteratively
public List<Relationship> findRelationshipsByPropertyIteratively(List<String> validTypeNames, InstanceProperties matchProperties, MatchCriteria matchCriteria) throws InvalidParameterException, RepositoryErrorException
-
findRelationshipsByProperty
public List<Relationship> findRelationshipsByProperty(String userId, String relationshipTypeGUID, InstanceProperties matchProperties, MatchCriteria matchCriteria, int fromRelationshipElement, List<InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize) throws InvalidParameterException, TypeErrorException, RepositoryErrorException, PropertyErrorException, PagingErrorException, FunctionNotSupportedException, UserNotAuthorizedException
-
validateTypeGUID
public void validateTypeGUID(String sourceName, String guidParameterName, String guid, String methodName) throws TypeErrorException
- Throws:
TypeErrorException
-
findEntitiesByPropertyValue
public List<EntityDetail> findEntitiesByPropertyValue(String userId, String entityTypeGUID, String searchCriteria, int fromEntityElement, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize) throws InvalidParameterException, TypeErrorException, RepositoryErrorException, PropertyErrorException, PagingErrorException, FunctionNotSupportedException, UserNotAuthorizedException
-
findRelationshipsByPropertyValue
public List<Relationship> findRelationshipsByPropertyValue(String userId, String relationshipTypeGUID, String searchCriteria, int fromRelationshipElement, List<InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize) throws InvalidParameterException, TypeErrorException, RepositoryErrorException, PropertyErrorException, PagingErrorException, FunctionNotSupportedException, UserNotAuthorizedException
-
findEntitiesByPropertyValueForTypes
public List<EntityDetail> findEntitiesByPropertyValueForTypes(List<String> validTypeNames, String filterTypeName, Map<String,TypeDefAttribute> qualifiedPropertyNameToTypeDefinedAttribute, Map<String,List<String>> shortPropertyNameToQualifiedPropertyNames, String searchCriteria) throws InvalidParameterException, RepositoryErrorException
-
findRelationshipsByPropertyValueForTypes
public List<Relationship> findRelationshipsByPropertyValueForTypes(List<String> validTypeNames, String filterTypeName, Map<String,TypeDefAttribute> qualifiedPropertyNameToTypeDefinedAttribute, Map<String,List<String>> shortPropertyNameToQualifiedPropertyNames, String searchCriteria) throws InvalidParameterException, TypeErrorException, RepositoryErrorException, PropertyErrorException, PagingErrorException, FunctionNotSupportedException, UserNotAuthorizedException
-
findEntities
public List<EntityDetail> findEntities(String userId, String entityTypeGUID, List<String> entitySubtypeGUIDs, SearchProperties matchProperties, int fromEntityElement, List<InstanceStatus> limitResultsByStatus, SearchClassifications matchClassifications, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize) throws InvalidParameterException, RepositoryErrorException, TypeErrorException, PropertyErrorException, PagingErrorException, FunctionNotSupportedException
-
findRelationships
public List<Relationship> findRelationships(String userId, String relationshipTypeGUID, List<String> relationshipSubtypeGUIDs, SearchProperties matchProperties, int fromRelationshipElement, List<InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize) throws InvalidParameterException, TypeErrorException, RepositoryErrorException, PropertyErrorException, PagingErrorException, FunctionNotSupportedException
Return a list of relationships that match the requested conditions. The results can be received as a series of pages.- Overrides:
findRelationshipsin classOMRSMetadataCollectionBase- Parameters:
userId- unique identifier for requesting user.relationshipTypeGUID- unique identifier (guid) for the relationship's type. Null means all types (but may be slow so not recommended).relationshipSubtypeGUIDs- optional list of the unique identifiers (guids) for subtypes of the relationshipTypeGUID to include in the search results. Null means all subtypes.matchProperties- Optional list of relationship property conditions to match.fromRelationshipElement- the starting element number of the entities to return. This is used when retrieving elements beyond the first page of results. Zero means start from the first element.limitResultsByStatus- By default, relationships in all non-DELETED statuses are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values except DELETED.asOfTime- Requests a historical query of the relationships for the entity. Null means return the present values.sequencingProperty- String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).sequencingOrder- Enum defining how the results should be ordered.pageSize- the maximum number of result relationships that can be returned on this request. Zero means unrestricted return results size.- Returns:
- a list of relationships. Null means no matching relationships.
- Throws:
InvalidParameterException- one of the parameters is invalid or null.TypeErrorException- the type guid passed on the request is not known by the metadata collection.RepositoryErrorException- there is a problem communicating with the metadata repository where the metadata collection is stored.PropertyErrorException- the properties specified are not valid for any of the requested types of relationships.PagingErrorException- the paging/sequencing parameters are set up incorrectly.FunctionNotSupportedException- the repository does not support one of the provided parameters.- See Also:
OMRSRepositoryHelper.getExactMatchRegex(String)
-
classifyEntity
public EntityDetail classifyEntity(String userId, String entityGUID, String classificationName, InstanceProperties classificationProperties) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, ClassificationErrorException, PropertyErrorException, UserNotAuthorizedException
-
classifyEntity
public EntityDetail classifyEntity(String userId, String entityGUID, String classificationName, String externalSourceGUID, String externalSourceName, ClassificationOrigin classificationOrigin, String classificationOriginGUID, InstanceProperties classificationProperties) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, ClassificationErrorException, PropertyErrorException, UserNotAuthorizedException, FunctionNotSupportedException
-
declassifyEntity
public EntityDetail declassifyEntity(String userId, String entityGUID, String classificationName) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, ClassificationErrorException, UserNotAuthorizedException
-
findEntitiesByClassification
public List<EntityDetail> findEntitiesByClassification(String userId, String entityTypeGUID, String classificationName, InstanceProperties matchClassificationProperties, MatchCriteria matchCriteria, int fromEntityElement, List<InstanceStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize) throws InvalidParameterException, TypeErrorException, RepositoryErrorException, ClassificationErrorException, FunctionNotSupportedException, PropertyErrorException, PagingErrorException, UserNotAuthorizedException
-
deleteEntity
public EntityDetail deleteEntity(String userId, String typeDefGUID, String typeDefName, String obsoleteEntityGUID) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, UserNotAuthorizedException
-
restoreEntity
public EntityDetail restoreEntity(String userId, String deletedEntityGUID) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, EntityNotDeletedException, UserNotAuthorizedException
-
deleteRelationship
public Relationship deleteRelationship(String userId, String typeDefGUID, String typeDefName, String obsoleteRelationshipGUID) throws InvalidParameterException, RepositoryErrorException, RelationshipNotKnownException, UserNotAuthorizedException
-
restoreRelationship
public Relationship restoreRelationship(String userId, String deletedRelationshipGUID) throws InvalidParameterException, RepositoryErrorException, RelationshipNotKnownException, RelationshipNotDeletedException, UserNotAuthorizedException
-
reIdentifyEntity
public EntityDetail reIdentifyEntity(String userId, String typeDefGUID, String typeDefName, String entityGUID, String newEntityGUID) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, UserNotAuthorizedException
-
reHomeEntity
public EntityDetail reHomeEntity(String userId, String entityGUID, String typeDefGUID, String typeDefName, String homeMetadataCollectionId, String newHomeMetadataCollectionId, String newHomeMetadataCollectionName) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, UserNotAuthorizedException
-
reTypeEntity
public EntityDetail reTypeEntity(String userId, String entityGUID, TypeDefSummary currentTypeDefSummary, TypeDefSummary newTypeDefSummary) throws InvalidParameterException, RepositoryErrorException, TypeErrorException, PropertyErrorException, ClassificationErrorException, EntityNotKnownException, UserNotAuthorizedException
-
reIdentifyRelationship
public Relationship reIdentifyRelationship(String userId, String typeDefGUID, String typeDefName, String relationshipGUID, String newRelationshipGUID) throws InvalidParameterException, RepositoryErrorException, RelationshipNotKnownException, UserNotAuthorizedException
-
reTypeRelationship
public Relationship reTypeRelationship(String userId, String relationshipGUID, TypeDefSummary currentTypeDefSummary, TypeDefSummary newTypeDefSummary) throws InvalidParameterException, RepositoryErrorException, TypeErrorException, PropertyErrorException, RelationshipNotKnownException, UserNotAuthorizedException
-
reHomeRelationship
public Relationship reHomeRelationship(String userId, String relationshipGUID, String typeDefGUID, String typeDefName, String homeMetadataCollectionId, String newHomeMetadataCollectionId, String newHomeMetadataCollectionName) throws InvalidParameterException, RepositoryErrorException, RelationshipNotKnownException, UserNotAuthorizedException
-
updateEntityClassification
public EntityDetail updateEntityClassification(String userId, String entityGUID, String classificationName, InstanceProperties properties) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, ClassificationErrorException, PropertyErrorException, UserNotAuthorizedException
-
saveEntityReferenceCopy
public void saveEntityReferenceCopy(String userId, EntityDetail entity) throws InvalidParameterException, RepositoryErrorException, TypeErrorException, PropertyErrorException, HomeEntityException, EntityConflictException, InvalidEntityException, UserNotAuthorizedException
-
getHomeClassifications
public List<Classification> getHomeClassifications(String userId, String entityGUID) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, UserNotAuthorizedException, FunctionNotSupportedException
-
purgeEntityReferenceCopy
public void purgeEntityReferenceCopy(String userId, String entityGUID, String typeDefGUID, String typeDefName, String homeMetadataCollectionId) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, HomeEntityException, UserNotAuthorizedException
-
saveClassificationReferenceCopy
public void saveClassificationReferenceCopy(String userId, EntityDetail entity, Classification classification) throws InvalidParameterException, RepositoryErrorException, TypeErrorException, EntityConflictException, InvalidEntityException, PropertyErrorException, UserNotAuthorizedException, FunctionNotSupportedException
-
purgeClassificationReferenceCopy
public void purgeClassificationReferenceCopy(String userId, EntityDetail entity, Classification classification) throws InvalidParameterException, TypeErrorException, PropertyErrorException, EntityConflictException, InvalidEntityException, RepositoryErrorException, UserNotAuthorizedException, FunctionNotSupportedException
-
saveRelationshipReferenceCopy
public void saveRelationshipReferenceCopy(String userId, Relationship relationship) throws InvalidParameterException, RepositoryErrorException, TypeErrorException, EntityNotKnownException, PropertyErrorException, HomeRelationshipException, RelationshipConflictException, InvalidRelationshipException, UserNotAuthorizedException
- Overrides:
saveRelationshipReferenceCopyin classOMRSMetadataCollectionBase- Throws:
InvalidParameterExceptionRepositoryErrorExceptionTypeErrorExceptionEntityNotKnownExceptionPropertyErrorExceptionHomeRelationshipExceptionRelationshipConflictExceptionInvalidRelationshipExceptionUserNotAuthorizedException
-
purgeRelationshipReferenceCopy
public void purgeRelationshipReferenceCopy(String userId, String relationshipGUID, String typeDefGUID, String typeDefName, String homeMetadataCollectionId) throws InvalidParameterException, RepositoryErrorException, RelationshipNotKnownException, HomeRelationshipException, UserNotAuthorizedException
-
getEntityNeighborhood
public InstanceGraph getEntityNeighborhood(String userId, String entityGUID, List<String> entityTypeGUIDs, List<String> relationshipTypeGUIDs, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, int level) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, TypeErrorException, PropertyErrorException, FunctionNotSupportedException, UserNotAuthorizedException
-
getRelatedEntities
public List<EntityDetail> getRelatedEntities(String userId, String startEntityGUID, List<String> entityTypeGUIDs, int fromEntityElement, List<InstanceStatus> limitResultsByStatus, List<String> limitResultsByClassification, Date asOfTime, String sequencingProperty, SequencingOrder sequencingOrder, int pageSize) throws InvalidParameterException, TypeErrorException, RepositoryErrorException, EntityNotKnownException, PropertyErrorException, PagingErrorException, FunctionNotSupportedException, UserNotAuthorizedException
-
getLinkingEntities
public InstanceGraph getLinkingEntities(String userId, String startEntityGUID, String endEntityGUID, List<InstanceStatus> limitResultsByStatus, Date asOfTime) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, PropertyErrorException, FunctionNotSupportedException, UserNotAuthorizedException
-
-