public class IGCOMRSMetadataCollection extends OMRSMetadataCollectionBase
| Modifier and Type | Field and Description |
|---|---|
static String |
DEFAULT_IGC_TYPE |
static String |
DEFAULT_IGC_TYPE_DISPLAY_NAME |
static String |
GENERATED_TYPE_POSTFIX |
static String |
GENERATED_TYPE_PREFIX |
static String |
MAPPING_PKG |
metadataCollectionId, metadataCollectionName, parentConnector, repositoryHelper, repositoryName, repositoryValidator| Constructor and Description |
|---|
IGCOMRSMetadataCollection(IGCOMRSRepositoryConnector parentConnector,
String repositoryName,
OMRSRepositoryHelper repositoryHelper,
OMRSRepositoryValidator repositoryValidator,
String metadataCollectionId) |
| Modifier and Type | Method and Description |
|---|---|
void |
addAttributeTypeDef(String userId,
AttributeTypeDef newAttributeTypeDef)
Create a definition of a new AttributeTypeDef.
|
Relationship |
addRelationship(String userId,
String relationshipTypeGUID,
InstanceProperties initialProperties,
String entityOneGUID,
String entityTwoGUID,
InstanceStatus initialStatus)
Add a new relationship between two entities to the metadata collection.
|
void |
addSearchConditionFromValue(IGCSearchConditionSet igcSearchConditionSet,
String omrsPropertyName,
List<String> igcProperties,
PropertyMappingSet propertyMappingSet,
InstancePropertyValue value)
Adds the provided value to the search criteria for IGC.
|
void |
addTypeDef(String userId,
TypeDef newTypeDef)
Create a definition of a new TypeDef.
|
void |
addTypeDefGallery(String userId,
TypeDefGallery newTypes)
Create a collection of related types.
|
EntityDetail |
classifyEntity(String userId,
String entityGUID,
String classificationName,
InstanceProperties classificationProperties)
Add the requested classification to a specific entity.
|
EntityDetail |
declassifyEntity(String userId,
String entityGUID,
String classificationName)
Remove a specific classification from an entity.
|
boolean |
deleteOMRSStubForAsset(String rid,
String assetType)
Delete the OMRS asset stub for the provided asset details (cannot require the asset itself since it has
already been removed).
|
List<AttributeTypeDef> |
findAttributeTypeDefsByCategory(String userId,
AttributeTypeDefCategory category)
Returns all of the AttributeTypeDefs for a specific category.
|
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)
Return a list of entities that have the requested type of classification attached.
|
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)
Return a list of entities that match the supplied properties according to the match criteria.
|
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)
Return a list of entities whose string based property values match the search criteria.
|
List<Relationship> |
findRelationshipsByProperty(String userId,
String relationshipTypeGUID,
InstanceProperties matchProperties,
MatchCriteria matchCriteria,
int fromRelationshipElement,
List<InstanceStatus> limitResultsByStatus,
Date asOfTime,
String sequencingProperty,
SequencingOrder sequencingOrder,
int pageSize)
Return a list of relationships that match the requested properties by the matching criteria.
|
List<Relationship> |
findRelationshipsByPropertyValue(String userId,
String relationshipTypeGUID,
String searchCriteria,
int fromRelationshipElement,
List<InstanceStatus> limitResultsByStatus,
Date asOfTime,
String sequencingProperty,
SequencingOrder sequencingOrder,
int pageSize)
Return a list of relationships whose string based property values match the search criteria.
|
List<TypeDef> |
findTypeDefsByCategory(String userId,
TypeDefCategory category)
Returns all of the TypeDefs for a specific category.
|
List<TypeDef> |
findTypeDefsByProperty(String userId,
TypeDefProperties matchCriteria)
Return the TypeDefs that have the properties matching the supplied match criteria.
|
List<TypeDef> |
findTypesByExternalID(String userId,
String standard,
String organization,
String identifier)
Return the types that are linked to the elements from the specified standard.
|
static String |
generateTypePrefix(String moniker)
Generates a unique type prefix for RIDs based on the provided moniker.
|
TypeDefGallery |
getAllTypes(String userId)
Returns the list of different types of metadata organized into two groups.
|
AttributeTypeDef |
getAttributeTypeDefByGUID(String userId,
String guid)
Return the AttributeTypeDef identified by the GUID.
|
AttributeTypeDef |
getAttributeTypeDefByName(String userId,
String name)
Return the AttributeTypeDef identified by the unique name.
|
EntityDetail |
getEntityDetail(String userId,
String guid)
Return the header, classifications and properties of a specific entity.
|
EntityDetail |
getEntityDetail(String userId,
String guid,
Reference asset)
Return the header, classifications and properties of a specific entity, using the provided IGC asset.
|
InstanceGraph |
getEntityNeighborhood(String userId,
String entityGUID,
List<String> entityTypeGUIDs,
List<String> relationshipTypeGUIDs,
List<InstanceStatus> limitResultsByStatus,
List<String> limitResultsByClassification,
Date asOfTime,
int level)
Return the entities and relationships that radiate out from the supplied entity GUID.
|
EntitySummary |
getEntitySummary(String userId,
String guid)
Return the header and classifications for a specific entity.
|
Reference |
getFullAssetDetails(String rid)
Retrieve all of the asset details, including all relationships, from the RID.
|
String |
getIgcAssetTypeForAssetName(String igcAssetName)
Retrieves the IGC asset type from the provided IGC asset display name (only for those assets that have
a mapping implemented).
|
Map<String,List<RelationshipMapping>> |
getIgcPropertiesToRelationshipMappings(String assetType,
String userId)
Retrieve a mapping from IGC property name to the OMRS relationship type it represents.
|
InstanceGraph |
getLinkingEntities(String userId,
String startEntityGUID,
String endEntityGUID,
List<InstanceStatus> limitResultsByStatus,
Date asOfTime)
Return all of the relationships and intermediate entities that connect the startEntity with the endEntity.
|
ReferenceableMapper |
getMapperForParameters(Reference igcObject,
String prefix,
String userId)
Retrieves the Mapper that can be used for the provided parameters (or null if none exists).
|
List<EntityMapping> |
getMappers(String igcAssetType,
String userId)
Retrieves the classes to use for mapping the provided IGC asset type to an OMRS entity.
|
OMRSStub |
getOMRSStubForAsset(Reference asset)
Retrieve an OMRS asset stub (shadow copy of last version of an asset) for the provided asset.
|
static String |
getPrefixFromGeneratedId(String guid)
Retrieves the generated prefix from a generated GUID (or null if the GUID is not generated).
|
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)
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.
|
Relationship |
getRelationship(String userId,
String guid)
Return a requested relationship.
|
List<Relationship> |
getRelationshipsForEntity(String userId,
String entityGUID,
String relationshipTypeGUID,
int fromRelationshipElement,
List<InstanceStatus> limitResultsByStatus,
Date asOfTime,
String sequencingProperty,
SequencingOrder sequencingOrder,
int pageSize)
Return the relationships for a specific entity.
|
static String |
getRidFromGeneratedId(String guid)
Retrieves the RID from a generated GUID (or the GUID if it is not generated).
|
static String |
getStubNameForAsset(String rid,
String assetType)
Construct the unique name for the OMRS stub based on the provided asset information.
|
static String |
getStubNameFromAsset(Reference asset)
Construct the unique name for the OMRS stub based on the provided asset.
|
Map<String,TypeDefAttribute> |
getTypeDefAttributesForType(String omrsTypeName)
Retrieves a mapping from attribute name to TypeDefAttribute for all OMRS attributes defined for the provided
OMRS TypeDef name.
|
TypeDef |
getTypeDefByGUID(String userId,
String guid)
Return the TypeDef identified by the GUID.
|
TypeDef |
getTypeDefByName(String userId,
String name)
Return the TypeDef identified by the unique name.
|
EntityDetail |
isEntityKnown(String userId,
String guid)
Returns the entity if the entity is stored in the metadata collection, otherwise null.
|
static boolean |
isGeneratedGUID(String guid)
Indicates whether the provided GUID was generated (true) or not (false).
|
Relationship |
isRelationshipKnown(String userId,
String guid)
Returns a boolean indicating if the relationship is stored in the metadata collection.
|
void |
purgeEntity(String userId,
String typeDefGUID,
String typeDefName,
String deletedEntityGUID)
Permanently removes a deleted entity from the metadata collection.
|
void |
purgeRelationship(String userId,
String typeDefGUID,
String typeDefName,
String deletedRelationshipGUID)
Permanently delete the relationship from the repository.
|
List<TypeDef> |
searchForTypeDefs(String userId,
String searchCriteria)
Return the TypeDefs that match the search criteria.
|
EntityDetail |
updateEntityClassification(String userId,
String entityGUID,
String classificationName,
InstanceProperties properties)
Update one or more properties in one of an entity's classifications.
|
EntityDetail |
updateEntityProperties(String userId,
String entityGUID,
InstanceProperties properties)
Update selected properties in an entity.
|
EntityDetail |
updateEntityStatus(String userId,
String entityGUID,
InstanceStatus newStatus)
Update the status for a specific entity.
|
Relationship |
updateRelationshipProperties(String userId,
String relationshipGUID,
InstanceProperties properties)
Update the properties of a specific relationship.
|
Relationship |
updateRelationshipStatus(String userId,
String relationshipGUID,
InstanceStatus newStatus)
Update the status of a specific relationship.
|
String |
upsertOMRSStubForAsset(Reference asset)
Update (or create if it does not already exist) the OMRS asset stub for the provided asset.
|
boolean |
verifyAttributeTypeDef(String userId,
AttributeTypeDef attributeTypeDef)
Verify that a definition of an AttributeTypeDef is either new or matches the definition already stored.
|
boolean |
verifyTypeDef(String userId,
TypeDef typeDef)
Verify that a definition of a TypeDef is either new or matches the definition already stored.
|
addEntity, addEntityParameterValidation, addEntityProxy, addEntityProxyParameterValidation, addRelationshipParameterValidation, classifyEntityParameterValidation, declassifyEntityParameterValidation, deleteAttributeTypeDef, deleteEntity, deleteRelationship, deleteTypeDef, findEntitiesByClassificationParameterValidation, findEntitiesByPropertyParameterValidation, findEntitiesByPropertyValueParameterValidation, findRelationshipsByPropertyParameterValidation, findRelationshipsByPropertyValueParameterValidation, findTypesByName, getEntityDetail, getEntityNeighborhoodParameterValidation, getInstanceParameterValidation, getInstanceParameterValidation, getLinkingEntitiesParameterValidation, getMetadataCollectionId, getRelatedEntitiesParameterValidation, getRelationship, getRelationshipsForEntityParameterValidation, manageInstanceParameterValidation, purgeEntityReferenceCopy, purgeRelationshipReferenceCopy, refreshEntityReferenceCopy, refreshRelationshipReferenceCopy, reHomeEntity, reHomeRelationship, reIdentifyAttributeTypeDef, reIdentifyEntity, reIdentifyRelationship, reIdentifyTypeDef, removeInstanceParameterValidation, restoreEntity, restoreRelationship, reTypeEntity, reTypeRelationship, saveEntityReferenceCopy, saveRelationshipReferenceCopy, undoEntityUpdate, undoRelationshipUpdate, updateEntityClassificationParameterValidation, updateInstancePropertiesPropertyValidation, updateInstanceStatusParameterValidation, updateTypeDefreHomeEntity, reHomeRelationship, saveInstanceReferenceCopies, validateRepositoryConnectorpublic static final String MAPPING_PKG
public static final String DEFAULT_IGC_TYPE
public static final String DEFAULT_IGC_TYPE_DISPLAY_NAME
public static final String GENERATED_TYPE_PREFIX
public static final String GENERATED_TYPE_POSTFIX
public IGCOMRSMetadataCollection(IGCOMRSRepositoryConnector parentConnector, String repositoryName, OMRSRepositoryHelper repositoryHelper, OMRSRepositoryValidator repositoryValidator, String metadataCollectionId)
parentConnector - connector that this metadata collection supports.
The connector has the information to call the metadata repository.repositoryName - name of this repository.repositoryHelper - helper that provides methods to repository connectors and repository event mappers
to build valid type definitions (TypeDefs), entities and relationships.repositoryValidator - validator class for checking open metadata repository objects and parametersmetadataCollectionId - unique identifier for the repositorypublic TypeDefGallery getAllTypes(String userId) throws RepositoryErrorException, UserNotAuthorizedException
getAllTypes in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.RepositoryErrorException - there is a problem communicating with the metadata repository.UserNotAuthorizedException - the userId is not permitted to perform this operation.public List<TypeDef> findTypeDefsByCategory(String userId, TypeDefCategory category) throws InvalidParameterException, RepositoryErrorException, UserNotAuthorizedException
findTypeDefsByCategory in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.category - enum value for the category of TypeDef to return.InvalidParameterException - the TypeDefCategory is null.RepositoryErrorException - there is a problem communicating with the metadata repository.UserNotAuthorizedException - the userId is not permitted to perform this operation.public List<AttributeTypeDef> findAttributeTypeDefsByCategory(String userId, AttributeTypeDefCategory category) throws InvalidParameterException, RepositoryErrorException, UserNotAuthorizedException
findAttributeTypeDefsByCategory in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.category - enum value for the category of an AttributeTypeDef to return.InvalidParameterException - the TypeDefCategory is null.RepositoryErrorException - there is a problem communicating with the metadata repository.UserNotAuthorizedException - the userId is not permitted to perform this operation.public List<TypeDef> findTypeDefsByProperty(String userId, TypeDefProperties matchCriteria) throws InvalidParameterException, RepositoryErrorException, UserNotAuthorizedException
findTypeDefsByProperty in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.matchCriteria - TypeDefProperties containing a list of property names.InvalidParameterException - the matchCriteria is null.RepositoryErrorException - there is a problem communicating with the metadata repository.UserNotAuthorizedException - the userId is not permitted to perform this operation.public List<TypeDef> findTypesByExternalID(String userId, String standard, String organization, String identifier) throws InvalidParameterException, RepositoryErrorException, UserNotAuthorizedException
findTypesByExternalID in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.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.InvalidParameterException - all attributes of the external id are null.RepositoryErrorException - there is a problem communicating with the metadata repository.UserNotAuthorizedException - the userId is not permitted to perform this operation.public List<TypeDef> searchForTypeDefs(String userId, String searchCriteria) throws InvalidParameterException, RepositoryErrorException, UserNotAuthorizedException
searchForTypeDefs in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.searchCriteria - String search criteria.InvalidParameterException - the searchCriteria is null.RepositoryErrorException - there is a problem communicating with the metadata repository.UserNotAuthorizedException - the userId is not permitted to perform this operation.public TypeDef getTypeDefByGUID(String userId, String guid) throws InvalidParameterException, RepositoryErrorException, TypeDefNotKnownException, UserNotAuthorizedException
getTypeDefByGUID in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.guid - String unique id of the TypeDef.InvalidParameterException - the guid is null.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.TypeDefNotKnownException - The requested TypeDef is not known in the metadata collection.UserNotAuthorizedException - the userId is not permitted to perform this operation.public AttributeTypeDef getAttributeTypeDefByGUID(String userId, String guid) throws InvalidParameterException, RepositoryErrorException, TypeDefNotKnownException, UserNotAuthorizedException
getAttributeTypeDefByGUID in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.guid - String unique id of the TypeDefInvalidParameterException - the guid is null.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.TypeDefNotKnownException - The requested TypeDef is not known in the metadata collection.UserNotAuthorizedException - the userId is not permitted to perform this operation.public TypeDef getTypeDefByName(String userId, String name) throws InvalidParameterException, RepositoryErrorException, TypeDefNotKnownException, UserNotAuthorizedException
getTypeDefByName in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.name - String name of the TypeDef.InvalidParameterException - the name is null.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.TypeDefNotKnownException - the requested TypeDef is not found in the metadata collection.UserNotAuthorizedException - the userId is not permitted to perform this operation.public AttributeTypeDef getAttributeTypeDefByName(String userId, String name) throws InvalidParameterException, RepositoryErrorException, TypeDefNotKnownException, UserNotAuthorizedException
getAttributeTypeDefByName in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.name - String name of the TypeDef.InvalidParameterException - the name is null.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.TypeDefNotKnownException - the requested TypeDef is not found in the metadata collection.UserNotAuthorizedException - the userId is not permitted to perform this operation.public void addTypeDefGallery(String userId, TypeDefGallery newTypes) throws InvalidParameterException, RepositoryErrorException, TypeDefNotSupportedException, TypeDefKnownException, TypeDefConflictException, InvalidTypeDefException, FunctionNotSupportedException, UserNotAuthorizedException
addTypeDefGallery in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.newTypes - TypeDefGalleryResponse structure describing the new AttributeTypeDefs and TypeDefs.InvalidParameterException - the new TypeDef is null.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.TypeDefNotSupportedException - the repository is not able to support this TypeDef.TypeDefKnownException - the TypeDef is already stored in the repository.TypeDefConflictException - the new TypeDef conflicts with an existing TypeDef.InvalidTypeDefException - the new TypeDef has invalid contents.FunctionNotSupportedException - the repository does not support this call.UserNotAuthorizedException - the userId is not permitted to perform this operation.public void addTypeDef(String userId, TypeDef newTypeDef) throws InvalidParameterException, RepositoryErrorException, TypeDefNotSupportedException, TypeDefKnownException, TypeDefConflictException, InvalidTypeDefException, FunctionNotSupportedException, UserNotAuthorizedException
addTypeDef in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.newTypeDef - TypeDef structure describing the new TypeDef.InvalidParameterException - the new TypeDef is null.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.TypeDefNotSupportedException - the repository is not able to support this TypeDef.TypeDefKnownException - the TypeDef is already stored in the repository.TypeDefConflictException - the new TypeDef conflicts with an existing TypeDef.InvalidTypeDefException - the new TypeDef has invalid contents.FunctionNotSupportedException - the repository does not support this call.UserNotAuthorizedException - the userId is not permitted to perform this operation.public void addAttributeTypeDef(String userId, AttributeTypeDef newAttributeTypeDef) throws InvalidParameterException, RepositoryErrorException, TypeDefNotSupportedException, TypeDefKnownException, TypeDefConflictException, InvalidTypeDefException, FunctionNotSupportedException, UserNotAuthorizedException
addAttributeTypeDef in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.newAttributeTypeDef - TypeDef structure describing the new TypeDef.InvalidParameterException - the new TypeDef is null.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.TypeDefNotSupportedException - the repository is not able to support this TypeDef.TypeDefKnownException - the TypeDef is already stored in the repository.TypeDefConflictException - the new TypeDef conflicts with an existing TypeDef.InvalidTypeDefException - the new TypeDef has invalid contents.FunctionNotSupportedException - the repository does not support this call.UserNotAuthorizedException - the userId is not permitted to perform this operation.public boolean verifyTypeDef(String userId, TypeDef typeDef) throws InvalidParameterException, RepositoryErrorException, TypeDefNotSupportedException, TypeDefConflictException, InvalidTypeDefException, UserNotAuthorizedException
verifyTypeDef in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.typeDef - TypeDef structure describing the TypeDef to test.InvalidParameterException - the TypeDef is null.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.TypeDefNotSupportedException - the repository is not able to support this TypeDef.TypeDefConflictException - the new TypeDef conflicts with an existing TypeDef.InvalidTypeDefException - the new TypeDef has invalid contents.UserNotAuthorizedException - the userId is not permitted to perform this operation.public boolean verifyAttributeTypeDef(String userId, AttributeTypeDef attributeTypeDef) throws InvalidParameterException, RepositoryErrorException, TypeDefNotSupportedException, TypeDefConflictException, InvalidTypeDefException, UserNotAuthorizedException
verifyAttributeTypeDef in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.attributeTypeDef - TypeDef structure describing the TypeDef to test.InvalidParameterException - the TypeDef is null.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.TypeDefNotSupportedException - the repository is not able to support this TypeDef.TypeDefConflictException - the new TypeDef conflicts with an existing TypeDef.InvalidTypeDefException - the new TypeDef has invalid contents.UserNotAuthorizedException - the userId is not permitted to perform this operation.public EntityDetail isEntityKnown(String userId, String guid) throws InvalidParameterException, RepositoryErrorException, UserNotAuthorizedException
isEntityKnown in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.guid - String unique identifier for the entityInvalidParameterException - the guid is null.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.UserNotAuthorizedException - the userId is not permitted to perform this operation.public EntitySummary getEntitySummary(String userId, String guid) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, UserNotAuthorizedException
getEntitySummary in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.guid - String unique identifier for the entity.InvalidParameterException - the guid is null.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.EntityNotKnownException - the requested entity instance is not known in the metadata collection.UserNotAuthorizedException - the userId is not permitted to perform this operation.public EntityDetail getEntityDetail(String userId, String guid) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, EntityProxyOnlyException, UserNotAuthorizedException
getEntityDetail in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.guid - String unique identifier for the entity.InvalidParameterException - the guid is null.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.EntityNotKnownException - the requested entity instance is not known in the metadata collection.EntityProxyOnlyException - the requested entity instance is only a proxy in the metadata collection.UserNotAuthorizedException - the userId is not permitted to perform this operation.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, FunctionNotSupportedException, UserNotAuthorizedException
getRelationshipsForEntity in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.entityGUID - String unique identifier for the entity.relationshipTypeGUID - String GUID of the the type of relationship required (null for all).fromRelationshipElement - the starting element number of the relationships to return.
This is used when retrieving elements
beyond the first page of results. Zero means start from the first element.limitResultsByStatus - Not implemented for IGC -- will only retrieve ACTIVE entities.asOfTime - Must be null (history not implemented for IGC).sequencingProperty - Must be null (there are no properties on IGC relationships).sequencingOrder - Enum defining how the results should be ordered.pageSize - -- the maximum number of result classifications that can be returned on this request. Zero means
unrestricted return results size.InvalidParameterException - a parameter 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.EntityNotKnownException - the requested entity instance is not known in the metadata collection.PropertyErrorException - the sequencing property is not valid for the attached classifications.PagingErrorException - the paging/sequencing parameters are set up incorrectly.FunctionNotSupportedException - the repository does not support the asOfTime parameter.UserNotAuthorizedException - the userId is not permitted to perform this operation.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
findEntitiesByProperty in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.entityTypeGUID - String unique identifier for the entity type of interest (null means any entity type).matchProperties - List of entity properties to match to (null means match on entityTypeGUID only).matchCriteria - Enum defining how the properties should be matched to the entities in the repository.fromEntityElement - 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 - Not implemented for IGC, only ACTIVE entities will be returned.limitResultsByClassification - List of classifications that must be present on all returned entities.asOfTime - Must be null (history not implemented for IGC).sequencingProperty - String name of the entity 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 entities that can be returned on this request. Zero means
unrestricted return results size.InvalidParameterException - a parameter 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
entity.PagingErrorException - the paging/sequencing parameters are set up incorrectly.FunctionNotSupportedException - the repository does not support the asOfTime parameter.UserNotAuthorizedException - the userId is not permitted to perform this operation.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, PropertyErrorException, PagingErrorException, FunctionNotSupportedException, UserNotAuthorizedException
findEntitiesByClassification in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.entityTypeGUID - unique identifier for the type of entity requested. Null mans any type of entity.classificationName - name of the classification a null is not valid.matchClassificationProperties - list of classification properties used to narrow the search.matchCriteria - Enum defining how the properties should be matched to the classifications in the repository.fromEntityElement - 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 - Not implemented for IGC, only ACTIVE entities will be returned.asOfTime - Requests a historical query of the entity. Null means return the present values. (not implemented
for IGC, must be null)sequencingProperty - String name of the entity 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 entities that can be returned on this request. Zero means
unrestricted return results size.InvalidParameterException - a parameter 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.ClassificationErrorException - the classification request is not known to the metadata collection.PropertyErrorException - the properties specified are not valid for the requested type of
classification.PagingErrorException - the paging/sequencing parameters are set up incorrectly.FunctionNotSupportedException - the repository does not support the asOfTime parameter.UserNotAuthorizedException - the userId is not permitted to perform this operation.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
findEntitiesByPropertyValue in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.entityTypeGUID - GUID of the type of entity to search for. Null means all types will
be searched (could be slow so not recommended).searchCriteria - String expression contained in any of the property values within the entities
of the supplied type.fromEntityElement - 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 - Not implemented for IGC, only ACTIVE entities will be returned.limitResultsByClassification - List of classifications that must be present on all returned entities.asOfTime - Must be null (history not implemented for IGC).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).
(currently not implemented for IGC)sequencingOrder - Enum defining how the results should be ordered.pageSize - the maximum number of result entities that can be returned on this request. Zero means
unrestricted return results size.InvalidParameterException - a parameter 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 sequencing property specified is not valid for any of the requested types of
entity.PagingErrorException - the paging/sequencing parameters are set up incorrectly.FunctionNotSupportedException - the repository does not support the asOfTime parameter.UserNotAuthorizedException - the userId is not permitted to perform this operation.public Relationship isRelationshipKnown(String userId, String guid) throws InvalidParameterException, RepositoryErrorException, UserNotAuthorizedException
isRelationshipKnown in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.guid - String unique identifier for the relationship.InvalidParameterException - the guid is null.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.UserNotAuthorizedException - the userId is not permitted to perform this operation.public Relationship getRelationship(String userId, String guid) throws InvalidParameterException, RepositoryErrorException, RelationshipNotKnownException, UserNotAuthorizedException
getRelationship in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.guid - String unique identifier for the relationship.InvalidParameterException - the guid is null.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.RelationshipNotKnownException - the metadata collection does not have a relationship with
the requested GUID stored.UserNotAuthorizedException - the userId is not permitted to perform this operation.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
findRelationshipsByProperty in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting userrelationshipTypeGUID - unique identifier (guid) for the new relationship's type.matchProperties - list of properties used to narrow the search.matchCriteria - Enum defining how the properties should be matched to the relationships in the repository.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 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.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.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 the asOfTime parameter.UserNotAuthorizedException - the userId is not permitted to perform this operation.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
findRelationshipsByPropertyValue in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.relationshipTypeGUID - GUID of the type of entity to search for. Null means all types will
be searched (could be slow so not recommended).searchCriteria - String expression contained in any of the property values within the entities
of the supplied type.fromRelationshipElement - Element number of the results to skip to when building the results list
to return. Zero means begin at the start of the results. This is used
to retrieve the results over a number of pages.limitResultsByStatus - By default, relationships in all 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.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.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 - there is a problem with one of the other parameters.PagingErrorException - the paging/sequencing parameters are set up incorrectly.FunctionNotSupportedException - the repository does not support the asOfTime parameter.UserNotAuthorizedException - the userId is not permitted to perform this operation.public InstanceGraph getLinkingEntities(String userId, String startEntityGUID, String endEntityGUID, List<InstanceStatus> limitResultsByStatus, Date asOfTime) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, PropertyErrorException, FunctionNotSupportedException, UserNotAuthorizedException
getLinkingEntities in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.startEntityGUID - The entity that is used to anchor the query.endEntityGUID - the other entity that defines the scope of the query.limitResultsByStatus - By default, relationships in all 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.asOfTime - Requests a historical query of the relationships for the entity. Null means return the
present values.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.EntityNotKnownException - the entity identified by either the startEntityGUID or the endEntityGUID
is not found in the metadata collection.PropertyErrorException - there is a problem with one of the other parameters.FunctionNotSupportedException - the repository does not support the asOfTime parameter.UserNotAuthorizedException - the userId is not permitted to perform this operation.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, TypeErrorException, RepositoryErrorException, EntityNotKnownException, PropertyErrorException, FunctionNotSupportedException, UserNotAuthorizedException
getEntityNeighborhood in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.entityGUID - the starting point of the query.entityTypeGUIDs - list of entity types to include in the query results. Null means include
all entities found, irrespective of their type.relationshipTypeGUIDs - list of relationship types to include in the query results. Null means include
all relationships found, irrespective of their type.limitResultsByStatus - By default, relationships in all 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.limitResultsByClassification - List of classifications that must be present on all returned entities.asOfTime - Requests a historical query of the relationships for the entity. Null means return the
present values.level - the number of the relationships out from the starting entity that the query will traverse to
gather results.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.EntityNotKnownException - the entity identified by the entityGUID is not found in the metadata collection.PropertyErrorException - there is a problem with one of the other parameters.FunctionNotSupportedException - the repository does not support the asOfTime parameter.UserNotAuthorizedException - the userId is not permitted to perform this operation.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
getRelatedEntities in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.startEntityGUID - unique identifier of the starting entity.entityTypeGUIDs - list of types to search for. Null means any type.fromEntityElement - starting element for results list. Used in paging. Zero means first element.limitResultsByStatus - By default, relationships in all 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.limitResultsByClassification - List of classifications that must be present on all returned entities.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 entities that can be returned on this request. Zero means
unrestricted return results size.InvalidParameterException - one of the parameters is invalid or null.TypeErrorException - one of the type guids 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.EntityNotKnownException - the entity identified by the startEntityGUID
is not found in the metadata collection.PropertyErrorException - the sequencing property specified is not valid for any of the requested types of
entity.PagingErrorException - the paging/sequencing parameters are set up incorrectly.FunctionNotSupportedException - the repository does not support the asOfTime parameter.UserNotAuthorizedException - the userId is not permitted to perform this operation.public EntityDetail updateEntityStatus(String userId, String entityGUID, InstanceStatus newStatus) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, StatusNotSupportedException, UserNotAuthorizedException
updateEntityStatus in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.entityGUID - unique identifier (guid) for the requested entity.newStatus - new InstanceStatus for the entity.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.EntityNotKnownException - the entity identified by the guid is not found in the metadata collection.StatusNotSupportedException - the metadata repository hosting the metadata collection does not support
the requested status.UserNotAuthorizedException - the userId is not permitted to perform this operation.public EntityDetail updateEntityProperties(String userId, String entityGUID, InstanceProperties properties) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, PropertyErrorException, UserNotAuthorizedException
updateEntityProperties in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.entityGUID - String unique identifier (guid) for the entity.properties - a list of properties to change.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.EntityNotKnownException - the entity identified by the guid is not found in the metadata collectionPropertyErrorException - one or more of the requested properties are not defined, or have different
characteristics in the TypeDef for this entity's typeUserNotAuthorizedException - the userId is not permitted to perform this operation.public void purgeEntity(String userId, String typeDefGUID, String typeDefName, String deletedEntityGUID) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, EntityNotDeletedException, UserNotAuthorizedException
purgeEntity in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.typeDefGUID - unique identifier of the type of the entity to purge.typeDefName - unique name of the type of the entity to purge.deletedEntityGUID - String unique identifier (guid) for the entity.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.EntityNotKnownException - the entity identified by the guid is not found in the metadata collectionEntityNotDeletedException - the entity is not in DELETED status and so can not be purgedUserNotAuthorizedException - the userId is not permitted to perform this operation.public EntityDetail classifyEntity(String userId, String entityGUID, String classificationName, InstanceProperties classificationProperties) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, ClassificationErrorException, PropertyErrorException, UserNotAuthorizedException
classifyEntity in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.entityGUID - String unique identifier (guid) for the entity.classificationName - String name for the classification.classificationProperties - list of properties to set in the classification.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.EntityNotKnownException - the entity identified by the guid is not found in the metadata collectionClassificationErrorException - the requested classification is either not known or not valid
for the entity.PropertyErrorException - one or more of the requested properties are not defined, or have different
characteristics in the TypeDef for this classification typeUserNotAuthorizedException - the userId is not permitted to perform this operation.public EntityDetail declassifyEntity(String userId, String entityGUID, String classificationName) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, ClassificationErrorException, UserNotAuthorizedException
declassifyEntity in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.entityGUID - String unique identifier (guid) for the entity.classificationName - String name for the classification.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.EntityNotKnownException - the entity identified by the guid is not found in the metadata collectionClassificationErrorException - the requested classification is not set on the entity.UserNotAuthorizedException - the userId is not permitted to perform this operation.public EntityDetail updateEntityClassification(String userId, String entityGUID, String classificationName, InstanceProperties properties) throws InvalidParameterException, RepositoryErrorException, EntityNotKnownException, ClassificationErrorException, PropertyErrorException, UserNotAuthorizedException
updateEntityClassification in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.entityGUID - String unique identifier (guid) for the entity.classificationName - String name for the classification.properties - list of properties for the classification.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.EntityNotKnownException - the entity identified by the guid is not found in the metadata collectionClassificationErrorException - the requested classification is not attached to the classification.PropertyErrorException - one or more of the requested properties are not defined, or have different
characteristics in the TypeDef for this classification typeUserNotAuthorizedException - the userId is not permitted to perform this operation.public Relationship addRelationship(String userId, String relationshipTypeGUID, InstanceProperties initialProperties, String entityOneGUID, String entityTwoGUID, InstanceStatus initialStatus) throws InvalidParameterException, RepositoryErrorException, TypeErrorException, PropertyErrorException, EntityNotKnownException, StatusNotSupportedException, UserNotAuthorizedException
addRelationship in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.relationshipTypeGUID - unique identifier (guid) for the new relationship's type.initialProperties - initial list of properties for the new entity; null means no properties.entityOneGUID - the unique identifier of one of the entities that the relationship is connecting together.entityTwoGUID - the unique identifier of the other entity that the relationship is connecting together.initialStatus - initial status typically set to DRAFT, PREPARED or ACTIVE.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.TypeErrorException - the requested type is not known, or not supported in the metadata repository
hosting 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.EntityNotKnownException - one of the requested entities is not known in the metadata collection.StatusNotSupportedException - the metadata repository hosting the metadata collection does not support
the requested status.UserNotAuthorizedException - the userId is not permitted to perform this operation.public Relationship updateRelationshipStatus(String userId, String relationshipGUID, InstanceStatus newStatus) throws InvalidParameterException, RepositoryErrorException, RelationshipNotKnownException, StatusNotSupportedException, UserNotAuthorizedException
updateRelationshipStatus in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.relationshipGUID - String unique identifier (guid) for the relationship.newStatus - new InstanceStatus for the relationship.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.StatusNotSupportedException - the metadata repository hosting the metadata collection does not support
the requested status.UserNotAuthorizedException - the userId is not permitted to perform this operation.public Relationship updateRelationshipProperties(String userId, String relationshipGUID, InstanceProperties properties) throws InvalidParameterException, RepositoryErrorException, RelationshipNotKnownException, PropertyErrorException, UserNotAuthorizedException
updateRelationshipProperties in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.relationshipGUID - String unique identifier (guid) for the relationship.properties - list of the properties to update.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.public void purgeRelationship(String userId, String typeDefGUID, String typeDefName, String deletedRelationshipGUID) throws InvalidParameterException, RepositoryErrorException, RelationshipNotKnownException, RelationshipNotDeletedException, UserNotAuthorizedException
purgeRelationship in class OMRSMetadataCollectionBaseuserId - unique identifier for requesting user.typeDefGUID - unique identifier of the type of the relationship to purge.typeDefName - unique name of the type of the relationship to purge.deletedRelationshipGUID - String unique identifier (guid) for the relationship.InvalidParameterException - one of the parameters is 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.RelationshipNotDeletedException - the requested relationship is not in DELETED status.UserNotAuthorizedException - the userId is not permitted to perform this operation.public Map<String,List<RelationshipMapping>> getIgcPropertiesToRelationshipMappings(String assetType, String userId)
assetType - the IGC asset type for which to find mappingsuserId - the userId making the requestMap<String, RelationshipMapping> - keyed by IGC asset type with values of the RelationshipMappingspublic EntityDetail getEntityDetail(String userId, String guid, Reference asset) throws RepositoryErrorException, EntityNotKnownException
userId - unique identifier for requesting user.guid - String unique identifier for the entity.asset - the IGC asset for which an EntityDetail should be constructed.RepositoryErrorException - there is a problem communicating with the metadata repository where
the metadata collection is stored.EntityNotKnownExceptionpublic ReferenceableMapper getMapperForParameters(Reference igcObject, String prefix, String userId)
igcObject - the IGC assetprefix - the prefix used for the asset (if any; null otherwise)userId - the user making the requestpublic List<EntityMapping> getMappers(String igcAssetType, String userId)
igcAssetType - the name of the IGC asset typeList<EntityMapping>public Map<String,TypeDefAttribute> getTypeDefAttributesForType(String omrsTypeName)
omrsTypeName - the name of the OMRS TypeDef for which to retrieve the attributesMap<String, TypeDefAttribute>public String getIgcAssetTypeForAssetName(String igcAssetName)
igcAssetName - the display name of the IGC asset typepublic void addSearchConditionFromValue(IGCSearchConditionSet igcSearchConditionSet, String omrsPropertyName, List<String> igcProperties, PropertyMappingSet propertyMappingSet, InstancePropertyValue value)
igcSearchConditionSet - the search conditions to which to add the criteriaomrsPropertyName - the OMRS property name to searchigcProperties - the list of IGC properties to which to add for inclusion in the IGC searchpropertyMappingSet - the property mappingsvalue - the value for which to searchpublic static final String getRidFromGeneratedId(String guid)
guid - the guid to translatepublic static final String getPrefixFromGeneratedId(String guid)
guid - the guid from which to retrieve the prefixpublic static final boolean isGeneratedGUID(String guid)
guid - the guid to testpublic static final String generateTypePrefix(String moniker)
moniker - a repeatable way by which to refer to the typepublic OMRSStub getOMRSStubForAsset(Reference asset)
asset - the asset for which to retrieve the OMRS stubpublic String upsertOMRSStubForAsset(Reference asset)
asset - the asset for which to upsert the OMRS stubpublic boolean deleteOMRSStubForAsset(String rid, String assetType)
rid - the Repository ID (RID) of the asset for which to delete the OMRS stubassetType - the IGC asset type of the asset for which to delete the OMRS stubpublic static String getStubNameFromAsset(Reference asset)
asset - the asset for which to construct the unique OMRS stub namepublic static String getStubNameForAsset(String rid, String assetType)
rid - the Repository ID (RID) of the asset for which to construct the unique OMRS stub nameassetType - the asset type (REST form) of the asset for which to construct the unique OMRS stub namepublic Reference getFullAssetDetails(String rid)
rid - the Repository ID (RID) of the asset for which to retrieve all detailsCopyright © 2018–2019 ODPi. All rights reserved.