RepositoryHandler (Repository Handler Services 1.6 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryHandler

```
public class RepositoryHandler
extends Object
```
RepositoryHandler issues common calls to the open metadata repository to retrieve and store metadata. It converts the repository service exceptions into access service exceptions.

Constructor Summary

Constructors
Constructor and Description
`RepositoryHandler(AuditLog auditLog, RepositoryErrorHandler errorHandler, OMRSMetadataCollection metadataCollection, int maxPageSize)` Construct the basic handler with information needed to call the repository services and report any error.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`addUniqueAttachedEntityToAnchor(String userId, String anchorEntityGUID, String anchorEntityTypeName, String anchorRelationshipTypeGUID, String anchorRelationshipTypeName, InstanceProperties anchorRelationshipProperties, String attachedEntityTypeGUID, String attachedEntityTypeName, InstanceProperties attachedEntityProperties, String methodName)` Remove an entity attached to an anchor.
`void`	`classifyEntity(String userId, String entityGUID, String classificationTypeGUID, String classificationTypeName, InstanceProperties properties, String methodName)` Add a new classification to an existing entity in the open metadata repository.
`int`	`countAttachedRelationshipsByType(String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, String methodName)` Count the number of relationships of a specific type attached to an anchor entity.
`String`	`createEntity(String userId, String entityTypeGUID, String entityTypeName, InstanceProperties properties, InstanceStatus instanceStatus, String methodName)` Create a new entity in the open metadata repository with the specified instance status.
`String`	`createEntity(String userId, String entityTypeGUID, String entityTypeName, InstanceProperties properties, List<Classification> initialClassifications, InstanceStatus instanceStatus, String methodName)` Create a new entity in the open metadata repository with the specified instance status.
`String`	`createEntity(String userId, String entityTypeGUID, String entityTypeName, InstanceProperties properties, List<Classification> initialClassifications, String methodName)` Create a new entity in the open metadata repository with the ACTIVE instance status.
`String`	`createEntity(String userId, String entityTypeGUID, String entityTypeName, InstanceProperties properties, String methodName)` Create a new entity in the open metadata repository with the ACTIVE instance status.
`String`	`createExternalEntity(String userId, String entityTypeGUID, String entityTypeName, String externalSourceGUID, String externalSourceName, InstanceProperties properties, InstanceStatus instanceStatus, String methodName)` Create a new entity from an external source in the open metadata repository with the specified instance status.
`String`	`createExternalEntity(String userId, String entityTypeGUID, String entityTypeName, String externalSourceGUID, String externalSourceName, InstanceProperties properties, List<Classification> initialClassifications, InstanceStatus instanceStatus, String methodName)` Create a new entity from an external source in the open metadata repository with the specified instance status.
`String`	`createExternalEntity(String userId, String entityTypeGUID, String entityTypeName, String externalSourceGUID, String externalSourceName, InstanceProperties properties, List<Classification> initialClassifications, String methodName)` Create a new entity from an external source in the open metadata repository with the ACTIVE instance status.
`String`	`createExternalEntity(String userId, String entityTypeGUID, String entityTypeName, String externalSourceGUID, String externalSourceName, InstanceProperties properties, String methodName)` Create a new entity from an external source in the open metadata repository with the ACTIVE instance status.
`void`	`createExternalRelationship(String userId, String relationshipTypeGUID, String externalSourceGUID, String externalSourceName, String end1GUID, String end2GUID, InstanceProperties relationshipProperties, String methodName)` Create a relationship from an external source between two entities.
`void`	`createRelationship(String userId, String relationshipTypeGUID, String end1GUID, String end2GUID, InstanceProperties relationshipProperties, String methodName)` Create a relationship between two entities.
`void`	`declassifyEntity(String userId, String entityGUID, String classificationTypeGUID, String classificationTypeName, String methodName)` Remove an existing classification from an existing entity in the open metadata repository.
`void`	`ensureRelationship(String userId, String end1TypeName, String end1GUID, String end2GUID, String relationshipTypeGUID, String relationshipTypeName, InstanceProperties relationshipProperties, String methodName)` Create a relationship between two entities.
`List<EntityDetail>`	`getAttachedEntitiesFromUser(String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, String attachedEntityTypeGUID, String attachedEntityTypeName, int startingFrom, int pageSize, String methodName)` Return the list of entities at the other end of the requested relationship type that were created or edited by the requesting user.
`EntityDetail`	`getAttachedEntityFromUser(String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, String attachedEntityTypeGUID, String attachedEntityTypeName, String methodName)` Return the list of entities at the other end of the requested relationship type that were created or edited by the requesting user.
`List<EntityDetail>`	`getEntitiesByAllProperties(String userId, InstanceProperties properties, String entityTypeGUID, int startingFrom, int pageSize, String methodName)` Return the entities that match all supplied properties.
`List<EntityDetail>`	`getEntitiesByName(String userId, InstanceProperties nameProperties, String entityTypeGUID, int startingFrom, int pageSize, String methodName)` Return the requested entity by name.
`List<EntityDetail>`	`getEntitiesByType(String userId, String entityTypeGUID, int startingFrom, int pageSize, String methodName)` Return the requested entities that match the requested type.
`List<EntityDetail>`	`getEntitiesForClassificationType(String userId, String entityEntityTypeGUID, String classificationName, int startingFrom, int pageSize, String methodName)` Return the list of entities by the requested classification type.
`List<EntityDetail>`	`getEntitiesForRelationshipEnd(String userId, String anchorEntityGUID, String anchorEntityTypeName, boolean anchorAtEnd1, String relationshipTypeGUID, String relationshipTypeName, int startingFrom, int pageSize, String methodName)` Return the list of entities at the requested end of the requested relationship type.
`List<EntityDetail>`	`getEntitiesForRelationshipType(String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, int startingFrom, int pageSize, String methodName)` Return the list of entities at the other end of the requested relationship type.
`List<EntityDetail>`	`getEntitiesForType(String userId, String entityTypeGUID, String entityTypeName, int startingFrom, int pageSize, String methodName)` Return the list of entities of the requested type.
`EntityDetail`	`getEntityByGUID(String userId, String guid, String guidParameterName, String entityTypeName, String methodName)` Return the requested entity, converting any errors from the repository services into the local OMAS exceptions.
`List<EntityDetail>`	`getEntityByName(String userId, InstanceProperties nameProperties, String entityTypeGUID, String methodName)` Return the requested entity by name.
`EntityDetail`	`getEntityForRelationship(String userId, EntityProxy requiredEnd, String methodName)` Return the list of entities at the other end of the requested relationship type.
`EntityDetail`	`getEntityForRelationshipType(String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, String methodName)` Return the entity at the other end of the requested relationship type.
`OMRSMetadataCollection`	`getMetadataCollection()` Return the metadata collection for the repository.
`EntityProxy`	`getOtherEnd(String anchorEntityGUID, Relationship relationship)` Return the entity proxy for the related entity.
`List<Relationship>`	`getPagedRelationshipsByType(String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, int startingFrom, int maximumResults, String methodName)` Return the list of relationships of the requested type connected to the anchor entity.
`List<EntityProxy>`	`getRelatedEntityProxies(String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, int startingFrom, int pageSize, String methodName)` Return the list of entity proxies for the entities at the far end of the relationships linked to the anchor entity.
`Relationship`	`getRelationshipBetweenEntities(String userId, String entity1GUID, String entity1TypeName, String entity2GUID, String relationshipTypeGUID, String relationshipTypeName, String methodName)` Return the list of relationships of the requested type connected to the anchor entity.
`List<Relationship>`	`getRelationshipsByType(String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, int startingFrom, int pageSize, String methodName)` Return the list of relationships of the requested type connected to the anchor entity.
`List<Relationship>`	`getRelationshipsByType(String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, String methodName)` Return the list of relationships of the requested type connected to the anchor entity.
`List<Relationship>`	`getRequiredRelationshipsByType(String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, String methodName)` Return the list of relationships of the requested type connected to the anchor entity.
`EntityDetail`	`getUniqueEntityByName(String userId, String nameValue, String nameParameterName, InstanceProperties nameProperties, String entityTypeGUID, String entityTypeName, String methodName)` Return the requested entity by name.
`Relationship`	`getUniqueRelationshipByType(String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, String methodName)` Return the list of relationships of the requested type connected to the anchor entity.
`boolean`	`isEntityATypeOf(String userId, String guid, String guidParameterName, String entityTypeName, String methodName)` Test whether an entity is of a particular type or not.
`EntitySummary`	`isEntityKnown(String userId, String guid, String entityTypeName, String methodName, String guidParameterName)` Validate that the supplied GUID is for a real entity.
`void`	`purgeRelationship(String userId, String relationshipTypeGUID, String relationshipTypeName, String relationshipGUID, String methodName)` Purge a relationship between two entities.
`void`	`reclassifyEntity(String userId, String entityGUID, String classificationTypeGUID, String classificationTypeName, InstanceProperties properties, String methodName)` Update the properties of an existing classification to an existing entity in the open metadata repository.
`void`	`removeAllRelationshipsOfType(String userId, String anchorEntityGUID, String anchorEntityTypeName, String relationshipTypeGUID, String relationshipTypeName, String methodName)` Remove all relationships of a certain type anchored at a particular entity.
`void`	`removeEntity(String userId, String obsoleteEntityGUID, String entityTypeGUID, String entityTypeName, String validatingPropertyName, String validatingProperty, String methodName)` Remove an entity from the open metadata repository if the validating properties match.
`void`	`removeEntityOnLastUse(String userId, String obsoleteEntityGUID, String guidParameterName, String entityTypeGUID, String entityTypeName, String methodName)` Remove an entity from the repository if it is no longer connected to any other entity.
`void`	`removeIsolatedEntity(String userId, String obsoleteEntityGUID, String entityTypeGUID, String entityTypeName, String methodName)` Remove an entity from the open metadata repository after checking that is is not connected to anything else.
`void`	`removeRelationship(String userId, String relationshipTypeGUID, String relationshipTypeName, String relationshipGUID, String methodName)` Delete a relationship between two entities.
`void`	`removeRelationshipBetweenEntities(String userId, String relationshipTypeGUID, String relationshipTypeName, String entity1GUID, String entity1TypeName, String entity2GUID, String methodName)` Delete a relationship between two entities.
`void`	`removeUniqueEntityTypeFromAnchor(String userId, String anchorEntityGUID, String anchorEntityTypeName, String anchorRelationshipTypeGUID, String anchorRelationshipTypeName, String attachedEntityTypeGUID, String attachedEntityTypeName, String methodName)` Remove an entity attached to an anchor.
`void`	`removeUniqueRelationshipByType(String userId, String entityGUID, String entityTypeName, String relationshipTypeGUID, String relationshipTypeName, String methodName)` Remove the relationship connected to the supplied entity.
`void`	`updateEntity(String userId, String entityGUID, String entityTypeGUID, String entityTypeName, InstanceProperties properties, String methodName)` Update an existing entity in the open metadata repository.
`void`	`updateEntityStatus(String userId, String entityGUID, String entityTypeGUID, String entityTypeName, InstanceStatus instanceStatus, String methodName)` Update an existing entity status in the open metadata repository.
`void`	`updateRelationshipProperties(String userId, String relationshipGUID, InstanceProperties relationshipProperties, String methodName)` Update the properties in the requested relationship.
`void`	`updateUniqueRelationshipByType(String userId, String end1GUID, String end1TypeName, String end2GUID, String end2TypeName, String relationshipTypeGUID, String relationshipTypeName, String methodName)` Ensure that the unique relationship between two entities is established.
`EntitySummary`	`validateEntityGUID(String userId, String guid, String entityTypeName, String methodName, String guidParameterName)` Validate that the supplied GUID is for a real entity and map exceptions if not

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- RepositoryHandler
```
public RepositoryHandler(AuditLog auditLog,
                         RepositoryErrorHandler errorHandler,
                         OMRSMetadataCollection metadataCollection,
                         int maxPageSize)
```
  Construct the basic handler with information needed to call the repository services and report any error.
  
  Parameters:
  
  auditLog - logging destination
  
  errorHandler - generates error messages and exceptions
  
  metadataCollection - access to the repository content.
  
  maxPageSize - maximum number of instances that can be returned on a single call

Method Detail

validateEntityGUID

public EntitySummary validateEntityGUID(String userId,
                                        String guid,
                                        String entityTypeName,
                                        String methodName,
                                        String guidParameterName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Validate that the supplied GUID is for a real entity and map exceptions if not

Parameters:: userId - user making the request.; guid - unique identifier of the entity.; entityTypeName - expected type of asset.; methodName - name of method called.; guidParameterName - name of parameter that passed the guid
Returns:: retrieved entity
Throws:: InvalidParameterException - entity not known; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

isEntityKnown

public EntitySummary isEntityKnown(String userId,
                                   String guid,
                                   String entityTypeName,
                                   String methodName,
                                   String guidParameterName)
                            throws UserNotAuthorizedException,
                                   PropertyServerException

Validate that the supplied GUID is for a real entity. Return null if not

Parameters:: userId - user making the request.; guid - unique identifier of the entity.; entityTypeName - expected type of asset.; methodName - name of method called.; guidParameterName - name of parameter that passed the guid
Returns:: retrieved entity
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

createEntity

public String createEntity(String userId,
                           String entityTypeGUID,
                           String entityTypeName,
                           InstanceProperties properties,
                           String methodName)
                    throws UserNotAuthorizedException,
                           PropertyServerException

Create a new entity in the open metadata repository with the ACTIVE instance status.

Parameters:: userId - calling user; entityTypeGUID - type of entity to create; entityTypeName - name of the entity's type; properties - properties for the entity; methodName - name of calling method
Returns:: unique identifier of new entity
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

createEntity

public String createEntity(String userId,
                           String entityTypeGUID,
                           String entityTypeName,
                           InstanceProperties properties,
                           List<Classification> initialClassifications,
                           String methodName)
                    throws UserNotAuthorizedException,
                           PropertyServerException

Create a new entity in the open metadata repository with the ACTIVE instance status.

Parameters:: userId - calling user; entityTypeGUID - type of entity to create; entityTypeName - name of the entity's type; properties - properties for the entity; initialClassifications - list of classifications to attach to the entity; methodName - name of calling method
Returns:: unique identifier of new entity
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

createEntity

public String createEntity(String userId,
                           String entityTypeGUID,
                           String entityTypeName,
                           InstanceProperties properties,
                           InstanceStatus instanceStatus,
                           String methodName)
                    throws UserNotAuthorizedException,
                           PropertyServerException

Create a new entity in the open metadata repository with the specified instance status.

Parameters:: userId - calling user; entityTypeGUID - type of entity to create; entityTypeName - name of the entity's type; properties - properties for the entity; instanceStatus - initial status (needs to be valid for type); methodName - name of calling method
Returns:: unique identifier of new entity
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

createEntity

public String createEntity(String userId,
                           String entityTypeGUID,
                           String entityTypeName,
                           InstanceProperties properties,
                           List<Classification> initialClassifications,
                           InstanceStatus instanceStatus,
                           String methodName)
                    throws UserNotAuthorizedException,
                           PropertyServerException

Create a new entity in the open metadata repository with the specified instance status.

Parameters:: userId - calling user; entityTypeGUID - type of entity to create; entityTypeName - name of the entity's type; properties - properties for the entity; initialClassifications - list of classifications for the first version of this entity.; instanceStatus - initial status (needs to be valid for type); methodName - name of calling method
Returns:: unique identifier of new entity
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

createExternalEntity

public String createExternalEntity(String userId,
                                   String entityTypeGUID,
                                   String entityTypeName,
                                   String externalSourceGUID,
                                   String externalSourceName,
                                   InstanceProperties properties,
                                   String methodName)
                            throws UserNotAuthorizedException,
                                   PropertyServerException

Create a new entity from an external source in the open metadata repository with the ACTIVE instance status.

Parameters:: userId - calling user; entityTypeGUID - type of entity to create; entityTypeName - name of the entity's type; externalSourceGUID - unique identifier (guid) for the external source.; externalSourceName - unique name for the external source.; properties - properties for the entity; methodName - name of calling method
Returns:: unique identifier of new entity
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

createExternalEntity

public String createExternalEntity(String userId,
                                   String entityTypeGUID,
                                   String entityTypeName,
                                   String externalSourceGUID,
                                   String externalSourceName,
                                   InstanceProperties properties,
                                   List<Classification> initialClassifications,
                                   String methodName)
                            throws UserNotAuthorizedException,
                                   PropertyServerException

Create a new entity from an external source in the open metadata repository with the ACTIVE instance status.

Parameters:: userId - calling user; entityTypeGUID - type of entity to create; entityTypeName - name of the entity's type; externalSourceGUID - unique identifier (guid) for the external source.; externalSourceName - unique name for the external source.; properties - properties for the entity; initialClassifications - list of classifications to attach to the entity; methodName - name of calling method
Returns:: unique identifier of new entity
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

createExternalEntity

public String createExternalEntity(String userId,
                                   String entityTypeGUID,
                                   String entityTypeName,
                                   String externalSourceGUID,
                                   String externalSourceName,
                                   InstanceProperties properties,
                                   InstanceStatus instanceStatus,
                                   String methodName)
                            throws UserNotAuthorizedException,
                                   PropertyServerException

Create a new entity from an external source in the open metadata repository with the specified instance status.

Parameters:: userId - calling user; entityTypeGUID - type of entity to create; entityTypeName - name of the entity's type; externalSourceGUID - unique identifier (guid) for the external source.; externalSourceName - unique name for the external source.; properties - properties for the entity; instanceStatus - initial status (needs to be valid for type); methodName - name of calling method
Returns:: unique identifier of new entity
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

createExternalEntity

public String createExternalEntity(String userId,
                                   String entityTypeGUID,
                                   String entityTypeName,
                                   String externalSourceGUID,
                                   String externalSourceName,
                                   InstanceProperties properties,
                                   List<Classification> initialClassifications,
                                   InstanceStatus instanceStatus,
                                   String methodName)
                            throws UserNotAuthorizedException,
                                   PropertyServerException

Create a new entity from an external source in the open metadata repository with the specified instance status.

Parameters:: userId - calling user; entityTypeGUID - type of entity to create; entityTypeName - name of the entity's type; externalSourceGUID - unique identifier (guid) for the external source.; externalSourceName - unique name for the external source.; properties - properties for the entity; initialClassifications - list of classifications for the first version of this entity.; instanceStatus - initial status (needs to be valid for type); methodName - name of calling method
Returns:: unique identifier of new entity
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

addUniqueAttachedEntityToAnchor

public String addUniqueAttachedEntityToAnchor(String userId,
                                              String anchorEntityGUID,
                                              String anchorEntityTypeName,
                                              String anchorRelationshipTypeGUID,
                                              String anchorRelationshipTypeName,
                                              InstanceProperties anchorRelationshipProperties,
                                              String attachedEntityTypeGUID,
                                              String attachedEntityTypeName,
                                              InstanceProperties attachedEntityProperties,
                                              String methodName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Remove an entity attached to an anchor. There should be only one instance of this relationship.

Parameters:: userId - calling user; anchorEntityGUID - unique identifier of the anchor entity; anchorEntityTypeName - name of anchor entity's type; anchorRelationshipTypeGUID - unique identifier for the relationship's type; anchorRelationshipTypeName - unique name for the relationship's type; anchorRelationshipProperties - properties from relationship; attachedEntityTypeGUID - unique identifier for the attached entity's type; attachedEntityTypeName - name of the attached entity's type; attachedEntityProperties - properties of entity; methodName - name of calling method
Returns:: attached entity GUID
Throws:: InvalidParameterException - the entity guid is not known; UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - problem accessing the property server

updateEntity

public void updateEntity(String userId,
                         String entityGUID,
                         String entityTypeGUID,
                         String entityTypeName,
                         InstanceProperties properties,
                         String methodName)
                  throws UserNotAuthorizedException,
                         PropertyServerException

Update an existing entity in the open metadata repository.

Parameters:: userId - calling user; entityGUID - unique identifier of entity to update; entityTypeGUID - type of entity to create; entityTypeName - name of the entity's type; properties - properties for the entity; methodName - name of calling method
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

updateEntityStatus

public void updateEntityStatus(String userId,
                               String entityGUID,
                               String entityTypeGUID,
                               String entityTypeName,
                               InstanceStatus instanceStatus,
                               String methodName)
                        throws UserNotAuthorizedException,
                               PropertyServerException

Update an existing entity status in the open metadata repository.

Parameters:: userId - calling user; entityGUID - unique identifier of entity to update; entityTypeGUID - type of entity to create; entityTypeName - name of the entity's type; instanceStatus - initial status (needs to be valid for type); methodName - name of calling method
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

classifyEntity

public void classifyEntity(String userId,
                           String entityGUID,
                           String classificationTypeGUID,
                           String classificationTypeName,
                           InstanceProperties properties,
                           String methodName)
                    throws UserNotAuthorizedException,
                           PropertyServerException

Add a new classification to an existing entity in the open metadata repository.

Parameters:: userId - calling user; entityGUID - unique identifier of entity to update; classificationTypeGUID - type of classification to create; classificationTypeName - name of the classification's type; properties - properties for the classification; methodName - name of calling method
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

reclassifyEntity

public void reclassifyEntity(String userId,
                             String entityGUID,
                             String classificationTypeGUID,
                             String classificationTypeName,
                             InstanceProperties properties,
                             String methodName)
                      throws UserNotAuthorizedException,
                             PropertyServerException

Update the properties of an existing classification to an existing entity in the open metadata repository.

Parameters:: userId - calling user; entityGUID - unique identifier of entity to update; classificationTypeGUID - type of classification to create; classificationTypeName - name of the classification's type; properties - properties for the classification; methodName - name of calling method
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

declassifyEntity

public void declassifyEntity(String userId,
                             String entityGUID,
                             String classificationTypeGUID,
                             String classificationTypeName,
                             String methodName)
                      throws UserNotAuthorizedException,
                             PropertyServerException

Remove an existing classification from an existing entity in the open metadata repository.

Parameters:: userId - calling user; entityGUID - unique identifier of entity to update; classificationTypeGUID - type of classification to create; classificationTypeName - name of the classification's type; methodName - name of calling method
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

removeEntity

public void removeEntity(String userId,
                         String obsoleteEntityGUID,
                         String entityTypeGUID,
                         String entityTypeName,
                         String validatingPropertyName,
                         String validatingProperty,
                         String methodName)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException

Remove an entity from the open metadata repository if the validating properties match.

Parameters:: userId - calling user; obsoleteEntityGUID - unique identifier of the entity; entityTypeGUID - type of entity to delete; entityTypeName - name of the entity's type; validatingPropertyName - name of property that should be in the entity if we have the correct one.; validatingProperty - value of property that should be in the entity if we have the correct one.; methodName - name of calling method
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem; InvalidParameterException - mismatch on properties

removeEntityOnLastUse

public void removeEntityOnLastUse(String userId,
                                  String obsoleteEntityGUID,
                                  String guidParameterName,
                                  String entityTypeGUID,
                                  String entityTypeName,
                                  String methodName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Remove an entity from the repository if it is no longer connected to any other entity.

Parameters:: userId - calling user; obsoleteEntityGUID - unique identifier of the entity; guidParameterName - name of parameter that passed the entity guid; entityTypeGUID - unique identifier for the entity's type; entityTypeName - name of the entity's type; methodName - name of calling method
Throws:: InvalidParameterException - the entity guid is not known; UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - problem accessing the property server

removeIsolatedEntity
```
public void removeIsolatedEntity(String userId,
                                 String obsoleteEntityGUID,
                                 String entityTypeGUID,
                                 String entityTypeName,
                                 String methodName)
                          throws UserNotAuthorizedException,
                                 PropertyServerException
```
Remove an entity from the open metadata repository after checking that is is not connected to anything else. The repository handler helps to ensure that all relationships are deleted explicitly ensuring the events are created and making it easier for third party repositories to keep track of changes rather than have to implement the implied deletes from the logical graph.

Parameters:

userId - calling user

obsoleteEntityGUID - unique identifier of the entity

entityTypeGUID - type of entity to delete

entityTypeName - name of the entity's type

methodName - name of calling method

Throws:

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

removeUniqueEntityTypeFromAnchor

public void removeUniqueEntityTypeFromAnchor(String userId,
                                             String anchorEntityGUID,
                                             String anchorEntityTypeName,
                                             String anchorRelationshipTypeGUID,
                                             String anchorRelationshipTypeName,
                                             String attachedEntityTypeGUID,
                                             String attachedEntityTypeName,
                                             String methodName)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException

Remove an entity attached to an anchor. There should be only one instance of this relationship.

Parameters:: userId - calling user; anchorEntityGUID - unique identifier of the anchor entity; anchorEntityTypeName - name of anchor entity's type; anchorRelationshipTypeGUID - unique identifier for the relationship's type; anchorRelationshipTypeName - unique name for the relationship's type; attachedEntityTypeGUID - unique identifier for the attached entity's type; attachedEntityTypeName - name of the attached entity's type; methodName - name of calling method
Throws:: InvalidParameterException - the entity guid is not known; UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - problem accessing the property server

getEntitiesForType

public List<EntityDetail> getEntitiesForType(String userId,
                                             String entityTypeGUID,
                                             String entityTypeName,
                                             int startingFrom,
                                             int pageSize,
                                             String methodName)
                                      throws UserNotAuthorizedException,
                                             PropertyServerException

Return the list of entities of the requested type.

Parameters:: userId - user making the request; entityTypeGUID - identifier for the entity's type; entityTypeName - name for the entity's type; startingFrom - initial position in the stored list.; pageSize - maximum number of definitions to return on this call.; methodName - name of calling method
Returns:: retrieved entities or null
Throws:: PropertyServerException - problem accessing the property server; UserNotAuthorizedException - security access problem

getEntitiesForRelationshipType

public List<EntityDetail> getEntitiesForRelationshipType(String userId,
                                                         String anchorEntityGUID,
                                                         String anchorEntityTypeName,
                                                         String relationshipTypeGUID,
                                                         String relationshipTypeName,
                                                         int startingFrom,
                                                         int pageSize,
                                                         String methodName)
                                                  throws UserNotAuthorizedException,
                                                         PropertyServerException

Return the list of entities at the other end of the requested relationship type.

Parameters:: userId - user making the request; anchorEntityGUID - starting entity's GUID; anchorEntityTypeName - starting entity's type name; relationshipTypeGUID - identifier for the relationship to follow; relationshipTypeName - type name for the relationship to follow; startingFrom - initial position in the stored list.; pageSize - maximum number of definitions to return on this call.; methodName - name of calling method
Returns:: retrieved entities or null
Throws:: PropertyServerException - problem accessing the property server; UserNotAuthorizedException - security access problem

getEntitiesForClassificationType

public List<EntityDetail> getEntitiesForClassificationType(String userId,
                                                           String entityEntityTypeGUID,
                                                           String classificationName,
                                                           int startingFrom,
                                                           int pageSize,
                                                           String methodName)
                                                    throws UserNotAuthorizedException,
                                                           PropertyServerException

Return the list of entities by the requested classification type.

Parameters:: userId - user making the request; entityEntityTypeGUID - starting entity's GUID; classificationName - type name for the classification to follow; startingFrom - initial position in the stored list.; pageSize - maximum number of definitions to return on this call.; methodName - name of calling method
Returns:: retrieved entities or null
Throws:: PropertyServerException - problem accessing the property server; UserNotAuthorizedException - security access problem

getEntitiesForRelationshipEnd

public List<EntityDetail> getEntitiesForRelationshipEnd(String userId,
                                                        String anchorEntityGUID,
                                                        String anchorEntityTypeName,
                                                        boolean anchorAtEnd1,
                                                        String relationshipTypeGUID,
                                                        String relationshipTypeName,
                                                        int startingFrom,
                                                        int pageSize,
                                                        String methodName)
                                                 throws UserNotAuthorizedException,
                                                        PropertyServerException

Return the list of entities at the requested end of the requested relationship type.

Parameters:: userId - user making the request; anchorEntityGUID - starting entity's GUID; anchorEntityTypeName - starting entity's type name; anchorAtEnd1 - indicates that the match of the anchor entity must be at end 1 (otherwise it is at end two); relationshipTypeGUID - identifier for the relationship to follow; relationshipTypeName - type name for the relationship to follow; startingFrom - initial position in the stored list.; pageSize - maximum number of definitions to return on this call.; methodName - name of calling method
Returns:: retrieved entities or null
Throws:: PropertyServerException - problem accessing the property server; UserNotAuthorizedException - security access problem

getAttachedEntityFromUser

public EntityDetail getAttachedEntityFromUser(String userId,
                                              String anchorEntityGUID,
                                              String anchorEntityTypeName,
                                              String relationshipTypeGUID,
                                              String relationshipTypeName,
                                              String attachedEntityTypeGUID,
                                              String attachedEntityTypeName,
                                              String methodName)
                                       throws UserNotAuthorizedException,
                                              PropertyServerException

Return the list of entities at the other end of the requested relationship type that were created or edited by the requesting user.

Parameters:: userId - user making the request; anchorEntityGUID - starting entity's GUID; anchorEntityTypeName - starting entity's type name; relationshipTypeGUID - identifier for the relationship to follow; relationshipTypeName - type name for the relationship to follow; attachedEntityTypeGUID - identifier for the relationship to follow; attachedEntityTypeName - type name for the relationship to follow; methodName - name of calling method
Returns:: retrieved entities or null
Throws:: PropertyServerException - problem accessing the property server; UserNotAuthorizedException - security access problem

getAttachedEntitiesFromUser

public List<EntityDetail> getAttachedEntitiesFromUser(String userId,
                                                      String anchorEntityGUID,
                                                      String anchorEntityTypeName,
                                                      String relationshipTypeGUID,
                                                      String relationshipTypeName,
                                                      String attachedEntityTypeGUID,
                                                      String attachedEntityTypeName,
                                                      int startingFrom,
                                                      int pageSize,
                                                      String methodName)
                                               throws UserNotAuthorizedException,
                                                      PropertyServerException

Return the list of entities at the other end of the requested relationship type that were created or edited by the requesting user.

Parameters:: userId - user making the request; anchorEntityGUID - starting entity's GUID; anchorEntityTypeName - starting entity's type name; relationshipTypeGUID - identifier for the relationship to follow; relationshipTypeName - type name for the relationship to follow; attachedEntityTypeGUID - identifier for the relationship to follow; attachedEntityTypeName - type name for the relationship to follow; startingFrom - initial position in the stored list.; pageSize - maximum number of definitions to return on this call.; methodName - name of calling method
Returns:: retrieved entities or null
Throws:: PropertyServerException - problem accessing the property server; UserNotAuthorizedException - security access problem

getRelatedEntityProxies

public List<EntityProxy> getRelatedEntityProxies(String userId,
                                                 String anchorEntityGUID,
                                                 String anchorEntityTypeName,
                                                 String relationshipTypeGUID,
                                                 String relationshipTypeName,
                                                 int startingFrom,
                                                 int pageSize,
                                                 String methodName)
                                          throws UserNotAuthorizedException,
                                                 PropertyServerException

Return the list of entity proxies for the entities at the far end of the relationships linked to the anchor entity.

Parameters:: userId - user making the request; anchorEntityGUID - starting entity's GUID; anchorEntityTypeName - starting entity's type name; relationshipTypeGUID - identifier for the relationship to follow; relationshipTypeName - type name for the relationship to follow; startingFrom - initial position in the stored list.; pageSize - maximum number of definitions to return on this call.; methodName - calling method
Returns:: list of entity proxies
Throws:: PropertyServerException - problem accessing the property server; UserNotAuthorizedException - security access problem

getOtherEnd
```
public EntityProxy getOtherEnd(String anchorEntityGUID,
                               Relationship relationship)
```
Return the entity proxy for the related entity.

Parameters:

anchorEntityGUID - unique identifier of the anchor entity

relationship - relationship to another entity

Returns:

proxy to the other entity.

getEntityForRelationship

public EntityDetail getEntityForRelationship(String userId,
                                             EntityProxy requiredEnd,
                                             String methodName)
                                      throws UserNotAuthorizedException,
                                             PropertyServerException

Return the list of entities at the other end of the requested relationship type.

Parameters:: userId - user making the request; requiredEnd - entityProxy from relationship; methodName - name of calling method
Returns:: retrieved entities or null
Throws:: PropertyServerException - problem accessing the property server; UserNotAuthorizedException - security access problem

getEntityForRelationshipType

public EntityDetail getEntityForRelationshipType(String userId,
                                                 String anchorEntityGUID,
                                                 String anchorEntityTypeName,
                                                 String relationshipTypeGUID,
                                                 String relationshipTypeName,
                                                 String methodName)
                                          throws UserNotAuthorizedException,
                                                 PropertyServerException

Return the entity at the other end of the requested relationship type. The assumption is that this is a 0..1 relationship so one entity (or null) is returned. If lots of relationships are found then the PropertyServerException is thrown.

Parameters:: userId - user making the request; anchorEntityGUID - starting entity's GUID; anchorEntityTypeName - starting entity's type name; relationshipTypeGUID - identifier for the relationship to follow; relationshipTypeName - type name for the relationship to follow; methodName - name of calling method
Returns:: retrieved entity or null
Throws:: PropertyServerException - problem accessing the property server; UserNotAuthorizedException - security access problem

getEntityByGUID

public EntityDetail getEntityByGUID(String userId,
                                    String guid,
                                    String guidParameterName,
                                    String entityTypeName,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Return the requested entity, converting any errors from the repository services into the local OMAS exceptions.

Parameters:: userId - calling user; guid - unique identifier for the entity; guidParameterName - name of the guid parameter for error handling; entityTypeName - expected type of the entity; methodName - calling method name
Returns:: entity detail object
Throws:: InvalidParameterException - one of the parameters is null or invalid.; UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - problem retrieving the entity.

isEntityATypeOf

public boolean isEntityATypeOf(String userId,
                               String guid,
                               String guidParameterName,
                               String entityTypeName,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Test whether an entity is of a particular type or not.

Parameters:: userId - calling user; guid - unique identifier of the entity.; guidParameterName - name of the parameter containing the guid.; entityTypeName - name of the type to test for; methodName - calling method
Returns:: boolean flag
Throws:: InvalidParameterException - one of the parameters is null or invalid.; UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - problem retrieving the entity.

getEntityByName

public List<EntityDetail> getEntityByName(String userId,
                                          InstanceProperties nameProperties,
                                          String entityTypeGUID,
                                          String methodName)
                                   throws UserNotAuthorizedException,
                                          PropertyServerException

Return the requested entity by name.

Parameters:: userId - calling userId; nameProperties - list of name properties to search on.; entityTypeGUID - unique identifier of the entity's type; methodName - calling method
Returns:: list of returned entities
Throws:: UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - problem retrieving the entity.

getEntitiesByName

public List<EntityDetail> getEntitiesByName(String userId,
                                            InstanceProperties nameProperties,
                                            String entityTypeGUID,
                                            int startingFrom,
                                            int pageSize,
                                            String methodName)
                                     throws UserNotAuthorizedException,
                                            PropertyServerException

Return the requested entity by name.

Parameters:: userId - calling userId; nameProperties - list of name properties to search on.; entityTypeGUID - unique identifier of the entity's type; startingFrom - initial position in the stored list.; pageSize - maximum number of definitions to return on this call.; methodName - calling method
Returns:: list of returned entities
Throws:: UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - problem retrieving the entity.

getEntitiesByAllProperties

public List<EntityDetail> getEntitiesByAllProperties(String userId,
                                                     InstanceProperties properties,
                                                     String entityTypeGUID,
                                                     int startingFrom,
                                                     int pageSize,
                                                     String methodName)
                                              throws UserNotAuthorizedException,
                                                     PropertyServerException

Return the entities that match all supplied properties.

Parameters:: userId - calling userId; properties - list of name properties to search on.; entityTypeGUID - unique identifier of the entity's type; startingFrom - initial position in the stored list.; pageSize - maximum number of definitions to return on this call.; methodName - calling method
Returns:: list of returned entities
Throws:: UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - problem retrieving the entity.

getUniqueEntityByName

public EntityDetail getUniqueEntityByName(String userId,
                                          String nameValue,
                                          String nameParameterName,
                                          InstanceProperties nameProperties,
                                          String entityTypeGUID,
                                          String entityTypeName,
                                          String methodName)
                                   throws UserNotAuthorizedException,
                                          PropertyServerException

Return the requested entity by name.

Parameters:: userId - calling userId; nameValue - property name being searched for; nameParameterName - name of parameter that passed the name value; nameProperties - list of name properties to search on; entityTypeGUID - type of entity to create; entityTypeName - name of the entity's type; methodName - calling method
Returns:: list of returned entities
Throws:: UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - problem retrieving the entity.

getEntitiesByType

public List<EntityDetail> getEntitiesByType(String userId,
                                            String entityTypeGUID,
                                            int startingFrom,
                                            int pageSize,
                                            String methodName)
                                     throws UserNotAuthorizedException,
                                            PropertyServerException

Return the requested entities that match the requested type.

Parameters:: userId - calling userId; entityTypeGUID - type of entity required; startingFrom - initial position in the stored list.; pageSize - maximum number of definitions to return on this call.; methodName - calling method
Returns:: list of returned entities
Throws:: UserNotAuthorizedException - user not authorized to issue this request.; PropertyServerException - problem retrieving the entity.

getRelationshipsByType

public List<Relationship> getRelationshipsByType(String userId,
                                                 String anchorEntityGUID,
                                                 String anchorEntityTypeName,
                                                 String relationshipTypeGUID,
                                                 String relationshipTypeName,
                                                 String methodName)
                                          throws UserNotAuthorizedException,
                                                 PropertyServerException

Return the list of relationships of the requested type connected to the anchor entity. The list is expected to be small.

Parameters:: userId - user making the request; anchorEntityGUID - starting entity's GUID; anchorEntityTypeName - starting entity's type name; relationshipTypeGUID - identifier for the relationship to follow; relationshipTypeName - type name for the relationship to follow; methodName - name of calling method
Returns:: retrieved relationships or null
Throws:: UserNotAuthorizedException - security access problem; PropertyServerException - problem accessing the property server

getRelationshipsByType

public List<Relationship> getRelationshipsByType(String userId,
                                                 String anchorEntityGUID,
                                                 String anchorEntityTypeName,
                                                 String relationshipTypeGUID,
                                                 String relationshipTypeName,
                                                 int startingFrom,
                                                 int pageSize,
                                                 String methodName)
                                          throws UserNotAuthorizedException,
                                                 PropertyServerException

Return the list of relationships of the requested type connected to the anchor entity. The list is expected to be small.

Parameters:: userId - user making the request; anchorEntityGUID - starting entity's GUID; anchorEntityTypeName - starting entity's type name; relationshipTypeGUID - identifier for the relationship to follow; relationshipTypeName - type name for the relationship to follow; startingFrom - initial position in the stored list.; pageSize - maximum number of definitions to return on this call.; methodName - name of calling method
Returns:: retrieved relationships or null
Throws:: UserNotAuthorizedException - security access problem; PropertyServerException - problem accessing the property server

getRequiredRelationshipsByType

public List<Relationship> getRequiredRelationshipsByType(String userId,
                                                         String anchorEntityGUID,
                                                         String anchorEntityTypeName,
                                                         String relationshipTypeGUID,
                                                         String relationshipTypeName,
                                                         String methodName)
                                                  throws UserNotAuthorizedException,
                                                         PropertyServerException

Return the list of relationships of the requested type connected to the anchor entity. No relationships found results in an exception.

Parameters:: userId - user making the request; anchorEntityGUID - starting entity's GUID; anchorEntityTypeName - starting entity's type name; relationshipTypeGUID - identifier for the relationship to follow; relationshipTypeName - type name for the relationship to follow; methodName - name of calling method
Returns:: retrieved relationships or null
Throws:: UserNotAuthorizedException - security access problem; PropertyServerException - problem accessing the property server

countAttachedRelationshipsByType

public int countAttachedRelationshipsByType(String userId,
                                            String anchorEntityGUID,
                                            String anchorEntityTypeName,
                                            String relationshipTypeGUID,
                                            String relationshipTypeName,
                                            String methodName)
                                     throws PropertyServerException,
                                            UserNotAuthorizedException

Count the number of relationships of a specific type attached to an anchor entity.

Parameters:: userId - user making the request; anchorEntityGUID - starting entity's GUID; anchorEntityTypeName - starting entity's type name; relationshipTypeGUID - identifier for the relationship to follow; relationshipTypeName - type name for the relationship to follow; methodName - name of calling method
Returns:: count of the number of relationships
Throws:: UserNotAuthorizedException - user not authorized to issue this request; PropertyServerException - problem accessing the property server

getRelationshipBetweenEntities

public Relationship getRelationshipBetweenEntities(String userId,
                                                   String entity1GUID,
                                                   String entity1TypeName,
                                                   String entity2GUID,
                                                   String relationshipTypeGUID,
                                                   String relationshipTypeName,
                                                   String methodName)
                                            throws UserNotAuthorizedException,
                                                   PropertyServerException

Return the list of relationships of the requested type connected to the anchor entity.

Parameters:: userId - user making the request; entity1GUID - entity at end 1 GUID; entity1TypeName - entity 1's type name; entity2GUID - entity at end 2 GUID; relationshipTypeGUID - identifier for the relationship to follow; relationshipTypeName - type name for the relationship to follow; methodName - name of calling method
Returns:: retrieved relationship or null
Throws:: UserNotAuthorizedException - security access problem; PropertyServerException - problem accessing the property server

getPagedRelationshipsByType

public List<Relationship> getPagedRelationshipsByType(String userId,
                                                      String anchorEntityGUID,
                                                      String anchorEntityTypeName,
                                                      String relationshipTypeGUID,
                                                      String relationshipTypeName,
                                                      int startingFrom,
                                                      int maximumResults,
                                                      String methodName)
                                               throws UserNotAuthorizedException,
                                                      PropertyServerException

Return the list of relationships of the requested type connected to the anchor entity.

Parameters:: userId - user making the request; anchorEntityGUID - starting entity's GUID; anchorEntityTypeName - starting entity's type name; relationshipTypeGUID - identifier for the relationship to follow; relationshipTypeName - type name for the relationship to follow; startingFrom - results starting point; maximumResults - page size; methodName - name of calling method
Returns:: retrieved relationships or null
Throws:: UserNotAuthorizedException - security access problem; PropertyServerException - problem accessing the property server

getUniqueRelationshipByType

public Relationship getUniqueRelationshipByType(String userId,
                                                String anchorEntityGUID,
                                                String anchorEntityTypeName,
                                                String relationshipTypeGUID,
                                                String relationshipTypeName,
                                                String methodName)
                                         throws UserNotAuthorizedException,
                                                PropertyServerException

Return the list of relationships of the requested type connected to the anchor entity. The assumption is that this is a 0..1 relationship so one relationship (or null) is returned. If lots of relationships are found then the PropertyServerException is thrown.

Parameters:: userId - user making the request; anchorEntityGUID - starting entity's GUID; anchorEntityTypeName - starting entity's type name; relationshipTypeGUID - identifier for the relationship to follow; relationshipTypeName - type name for the relationship to follow; methodName - name of calling method
Returns:: retrieved relationship or null
Throws:: UserNotAuthorizedException - security access problem; PropertyServerException - problem accessing the property server

createRelationship

public void createRelationship(String userId,
                               String relationshipTypeGUID,
                               String end1GUID,
                               String end2GUID,
                               InstanceProperties relationshipProperties,
                               String methodName)
                        throws UserNotAuthorizedException,
                               PropertyServerException

Create a relationship between two entities.

Parameters:: userId - calling user; relationshipTypeGUID - unique identifier of the relationship's type; end1GUID - entity to store at end 1; end2GUID - entity to store at end 2; relationshipProperties - properties for the relationship; methodName - name of calling method
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

ensureRelationship

public void ensureRelationship(String userId,
                               String end1TypeName,
                               String end1GUID,
                               String end2GUID,
                               String relationshipTypeGUID,
                               String relationshipTypeName,
                               InstanceProperties relationshipProperties,
                               String methodName)
                        throws UserNotAuthorizedException,
                               PropertyServerException

Create a relationship between two entities.

Parameters:: userId - calling user; end1TypeName - unique name of the end 1's type; end1GUID - entity to store at end 1; end2GUID - entity to store at end 2; relationshipTypeGUID - unique identifier of the relationship's type; relationshipTypeName - unique name of the relationship's type; relationshipProperties - properties for the relationship; methodName - name of calling method
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

createExternalRelationship

public void createExternalRelationship(String userId,
                                       String relationshipTypeGUID,
                                       String externalSourceGUID,
                                       String externalSourceName,
                                       String end1GUID,
                                       String end2GUID,
                                       InstanceProperties relationshipProperties,
                                       String methodName)
                                throws UserNotAuthorizedException,
                                       PropertyServerException

Create a relationship from an external source between two entities.

Parameters:: userId - calling user; relationshipTypeGUID - unique identifier of the relationship's type; externalSourceGUID - unique identifier (guid) for the external source.; externalSourceName - unique name for the external source.; end1GUID - entity to store at end 1; end2GUID - entity to store at end 2; relationshipProperties - properties for the relationship; methodName - name of calling method
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

removeRelationship

public void removeRelationship(String userId,
                               String relationshipTypeGUID,
                               String relationshipTypeName,
                               String relationshipGUID,
                               String methodName)
                        throws UserNotAuthorizedException,
                               PropertyServerException

Delete a relationship between two entities. If delete is not supported, purge is used.

Parameters:: userId - calling user; relationshipTypeGUID - unique identifier of the type of relationship to delete; relationshipTypeName - name of the type of relationship to delete; relationshipGUID - unique identifier of the relationship to delete; methodName - name of calling method
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

purgeRelationship

public void purgeRelationship(String userId,
                              String relationshipTypeGUID,
                              String relationshipTypeName,
                              String relationshipGUID,
                              String methodName)
                       throws UserNotAuthorizedException,
                              PropertyServerException

Purge a relationship between two entities.

Parameters:: userId - calling user; relationshipTypeGUID - unique identifier of the type of relationship to delete; relationshipTypeName - name of the type of relationship to delete; relationshipGUID - unique identifier of the relationship to delete; methodName - name of calling method
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

removeAllRelationshipsOfType

public void removeAllRelationshipsOfType(String userId,
                                         String anchorEntityGUID,
                                         String anchorEntityTypeName,
                                         String relationshipTypeGUID,
                                         String relationshipTypeName,
                                         String methodName)
                                  throws UserNotAuthorizedException,
                                         PropertyServerException

Remove all relationships of a certain type anchored at a particular entity.

Parameters:: userId - calling user; anchorEntityGUID - identifier of starting entity; anchorEntityTypeName - type of entity; relationshipTypeGUID - unique identifier of the relationship type; relationshipTypeName - unique name of the relationship type; methodName - calling method
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

removeRelationshipBetweenEntities

public void removeRelationshipBetweenEntities(String userId,
                                              String relationshipTypeGUID,
                                              String relationshipTypeName,
                                              String entity1GUID,
                                              String entity1TypeName,
                                              String entity2GUID,
                                              String methodName)
                                       throws UserNotAuthorizedException,
                                              PropertyServerException

Delete a relationship between two entities.

Parameters:: userId - calling user; relationshipTypeGUID - unique identifier of the type of relationship to delete; relationshipTypeName - name of the type of relationship to delete; entity1GUID - unique identifier of the entity at end 1 of the relationship to delete; entity1TypeName - type name of the entity at end 1 of the relationship to delete; entity2GUID - unique identifier of the entity at end 1 of the relationship to delete; methodName - name of calling method
Throws:: PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

updateRelationshipProperties

public void updateRelationshipProperties(String userId,
                                         String relationshipGUID,
                                         InstanceProperties relationshipProperties,
                                         String methodName)
                                  throws UserNotAuthorizedException,
                                         PropertyServerException

Update the properties in the requested relationship.

Parameters:: userId - calling user; relationshipGUID - unique identifier of the relationship.; relationshipProperties - new properties for relationship; methodName - name of calling method.
Throws:: PropertyServerException - there is a problem communicating with the repository.; UserNotAuthorizedException - security access problem

updateUniqueRelationshipByType

public void updateUniqueRelationshipByType(String userId,
                                           String end1GUID,
                                           String end1TypeName,
                                           String end2GUID,
                                           String end2TypeName,
                                           String relationshipTypeGUID,
                                           String relationshipTypeName,
                                           String methodName)
                                    throws UserNotAuthorizedException,
                                           PropertyServerException

Ensure that the unique relationship between two entities is established. It is possible that there is already a relationship of this type between either of the entities and another and so that needs to be removed first.

Parameters:: userId - calling user; end1GUID - unique identifier of the entity for end 1 of the relationship.; end1TypeName - type of the entity for end 1; end2GUID - unique identifier of the entity for end 2 of the relationship.; end2TypeName - type of the entity for end 2; relationshipTypeGUID - unique identifier of the type of relationship to create.; relationshipTypeName - name of the type of relationship to create.; methodName - name of calling method.
Throws:: PropertyServerException - there is a problem communicating with the repository.; UserNotAuthorizedException - security access problem

removeUniqueRelationshipByType

public void removeUniqueRelationshipByType(String userId,
                                           String entityGUID,
                                           String entityTypeName,
                                           String relationshipTypeGUID,
                                           String relationshipTypeName,
                                           String methodName)
                                    throws UserNotAuthorizedException,
                                           PropertyServerException

Remove the relationship connected to the supplied entity. Due to the definition of the relationship, only one is expected.

Parameters:: userId - calling user; entityGUID - unique identity of the anchor entity.; entityTypeName - type name of entity; relationshipTypeGUID - unique identifier of the relationship's type; relationshipTypeName - name of the relationship's type; methodName - calling method
Throws:: UserNotAuthorizedException - security access problem; PropertyServerException - there is a problem communicating with the repository.

getMetadataCollection
```
public OMRSMetadataCollection getMetadataCollection()
```
Return the metadata collection for the repository. This is used by services that need function that is not supported by this class.

Returns:

metadata collection for the repository

Class RepositoryHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RepositoryHandler

Method Detail

validateEntityGUID

isEntityKnown

createEntity

createEntity

createEntity

createEntity

createExternalEntity

createExternalEntity

createExternalEntity

createExternalEntity

addUniqueAttachedEntityToAnchor

updateEntity

updateEntityStatus

classifyEntity

reclassifyEntity

declassifyEntity

removeEntity

removeEntityOnLastUse

removeIsolatedEntity

removeUniqueEntityTypeFromAnchor

getEntitiesForType

getEntitiesForRelationshipType

getEntitiesForClassificationType

getEntitiesForRelationshipEnd

getAttachedEntityFromUser

getAttachedEntitiesFromUser

getRelatedEntityProxies

getOtherEnd

getEntityForRelationship

getEntityForRelationshipType

getEntityByGUID

isEntityATypeOf

getEntityByName

getEntitiesByName

getEntitiesByAllProperties

getUniqueEntityByName

getEntitiesByType

getRelationshipsByType

getRelationshipsByType

getRequiredRelationshipsByType

countAttachedRelationshipsByType

getRelationshipBetweenEntities

getPagedRelationshipsByType

getUniqueRelationshipByType

createRelationship

ensureRelationship

createExternalRelationship

removeRelationship

purgeRelationship

removeAllRelationshipsOfType

removeRelationshipBetweenEntities

updateRelationshipProperties

updateUniqueRelationshipByType

removeUniqueRelationshipByType

getMetadataCollection