LineageExchangeInterface (Asset Manager OMAS API 2.10 API)

All Superinterfaces:

SchemaExchangeInterface
```
public interface LineageExchangeInterface
extends SchemaExchangeInterface
```
The LineageExchangeInterface supports the exchange of process definitions and lineage linkage.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clearBusinessSignificant(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String elementExternalIdentifier)` Remove the "BusinessSignificant" designation from the element.
`void`	`clearControlFlow(String userId, String assetManagerGUID, String assetManagerName, String controlFlowGUID)` Remove the control flow relationship between two elements.
`void`	`clearDataFlow(String userId, String assetManagerGUID, String assetManagerName, String dataFlowGUID)` Remove the data flow relationship between two elements.
`void`	`clearLineageMapping(String userId, String assetManagerGUID, String assetManagerName, String sourceElementGUID, String destinationElementGUID)` Remove the lineage mapping between two elements.
`void`	`clearPortDelegation(String userId, String assetManagerGUID, String assetManagerName, String portOneGUID, String portTwoGUID)` Remove the port delegation relationship between two ports.
`void`	`clearPortSchemaType(String userId, String assetManagerGUID, String assetManagerName, String portGUID, String schemaTypeGUID)` Remove the schema type from a port.
`void`	`clearProcessCall(String userId, String assetManagerGUID, String assetManagerName, String processCallGUID)` Remove the process call relationship.
`void`	`clearProcessParent(String userId, String assetManagerGUID, String assetManagerName, String parentProcessGUID, String childProcessGUID)` Remove a parent-child relationship between two processes.
`void`	`clearProcessPort(String userId, String assetManagerGUID, String assetManagerName, String processGUID, String portGUID)` Unlink a port from a process.
`String`	`createPort(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String processGUID, String portExternalIdentifier, String portExternalIdentifierName, String portExternalIdentifierUsage, String portExternalIdentifierSource, KeyPattern portExternalIdentifierKeyPattern, Map<String,String> mappingProperties, PortProperties portProperties)` Create a new metadata element to represent a port.
`String`	`createProcess(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String processExternalIdentifier, String processExternalIdentifierName, String processExternalIdentifierUsage, String processExternalIdentifierSource, KeyPattern processExternalIdentifierKeyPattern, Map<String,String> mappingProperties, ProcessProperties processProperties, ProcessStatus initialStatus)` Create a new metadata element to represent a process.
`String`	`createProcessFromTemplate(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String templateGUID, String processExternalIdentifier, String processExternalIdentifierName, String processExternalIdentifierUsage, String processExternalIdentifierSource, KeyPattern processExternalIdentifierKeyPattern, Map<String,String> mappingProperties, TemplateProperties templateProperties)` Create a new metadata element to represent a process using an existing metadata element as a template.
`List<PortElement>`	`findPorts(String userId, String assetManagerGUID, String assetManagerName, String searchString, int startFrom, int pageSize)` Retrieve the list of port metadata elements that contain the search string.
`List<ProcessElement>`	`findProcesses(String userId, String assetManagerGUID, String assetManagerName, String searchString, int startFrom, int pageSize)` Retrieve the list of process metadata elements that contain the search string.
`ControlFlowElement`	`getControlFlow(String userId, String assetManagerGUID, String assetManagerName, String currentStepGUID, String nextStepGUID, String qualifiedName)` Retrieve the control flow relationship between two elements.
`List<ControlFlowElement>`	`getControlFlowNextSteps(String userId, String assetManagerGUID, String assetManagerName, String currentStepGUID)` Retrieve the control relationships linked from an specific element to the possible next elements in the process.
`List<ControlFlowElement>`	`getControlFlowPreviousSteps(String userId, String assetManagerGUID, String assetManagerName, String currentStepGUID)` Retrieve the control relationships linked from an specific element to the possible previous elements in the process.
`DataFlowElement`	`getDataFlow(String userId, String assetManagerGUID, String assetManagerName, String dataSupplierGUID, String dataConsumerGUID, String qualifiedName)` Retrieve the data flow relationship between two elements.
`List<DataFlowElement>`	`getDataFlowConsumers(String userId, String assetManagerGUID, String assetManagerName, String dataSupplierGUID)` Retrieve the data flow relationships linked from an specific element to the downstream consumers.
`List<DataFlowElement>`	`getDataFlowSuppliers(String userId, String assetManagerGUID, String assetManagerName, String dataConsumerGUID)` Retrieve the data flow relationships linked from an specific element to the upstream suppliers.
`List<LineageMappingElement>`	`getDestinationLineageMappings(String userId, String assetManagerGUID, String assetManagerName, String sourceElementGUID)` Retrieve the lineage mapping relationships linked from an specific source element to its destinations.
`PortElement`	`getPortByGUID(String userId, String assetManagerGUID, String assetManagerName, String portGUID)` Retrieve the port metadata element with the supplied unique identifier.
`PortElement`	`getPortDelegation(String userId, String assetManagerGUID, String assetManagerName, String portGUID)` Retrieve the port that this port delegates to.
`List<PortElement>`	`getPortsByName(String userId, String assetManagerGUID, String assetManagerName, String name, int startFrom, int pageSize)` Retrieve the list of port metadata elements with a matching qualified or display name.
`List<PortElement>`	`getPortsForProcess(String userId, String assetManagerGUID, String assetManagerName, String processGUID, int startFrom, int pageSize)` Retrieve the list of ports associated with a process.
`List<PortElement>`	`getPortUse(String userId, String assetManagerGUID, String assetManagerName, String portGUID, int startFrom, int pageSize)` Retrieve the list of ports that delegate to this port.
`ProcessElement`	`getProcessByGUID(String userId, String assetManagerGUID, String assetManagerName, String processGUID)` Retrieve the process metadata element with the supplied unique identifier.
`ProcessCallElement`	`getProcessCall(String userId, String assetManagerGUID, String assetManagerName, String callerGUID, String calledGUID, String qualifiedName)` Retrieve the process call relationship between two elements.
`List<ProcessCallElement>`	`getProcessCalled(String userId, String assetManagerGUID, String assetManagerName, String callerGUID)` Retrieve the process call relationships linked from an specific element to the elements it calls.
`List<ProcessCallElement>`	`getProcessCallers(String userId, String assetManagerGUID, String assetManagerName, String calledGUID)` Retrieve the process call relationships linked from an specific element to its callers.
`List<ProcessElement>`	`getProcessesByName(String userId, String assetManagerGUID, String assetManagerName, String name, int startFrom, int pageSize)` Retrieve the list of process metadata elements with a matching qualified or display name.
`List<ProcessElement>`	`getProcessesForAssetManager(String userId, String assetManagerGUID, String assetManagerName, int startFrom, int pageSize)` Return the list of processes associated with the asset manager.
`ProcessElement`	`getProcessParent(String userId, String assetManagerGUID, String assetManagerName, String processGUID)` Retrieve the process metadata element with the supplied unique identifier.
`List<LineageMappingElement>`	`getSourceLineageMappings(String userId, String assetManagerGUID, String assetManagerName, String destinationElementGUID)` Retrieve the lineage mapping relationships linked from an specific destination element to its sources.
`List<ProcessElement>`	`getSubProcesses(String userId, String assetManagerGUID, String assetManagerName, String processGUID, int startFrom, int pageSize)` Retrieve the process metadata element with the supplied unique identifier.
`void`	`publishProcess(String userId, String assetManagerGUID, String assetManagerName, String processGUID)` Update the zones for the asset so that it becomes visible to consumers.
`void`	`removePort(String userId, String assetManagerGUID, String assetManagerName, String portGUID, String portExternalIdentifier)` Remove the metadata element representing a port.
`void`	`removeProcess(String userId, String assetManagerGUID, String assetManagerName, String processGUID, String processExternalIdentifier)` Remove the metadata element representing a process.
`void`	`setBusinessSignificant(String userId, String assetManagerGUID, String assetManagerName, String elementGUID, String elementExternalIdentifier)` Classify a port, process or asset as "BusinessSignificant" (this may effect the way that lineage is displayed).
`String`	`setupControlFlow(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String currentStepGUID, String nextStepGUID, String qualifiedName, String description, String guard)` Link two elements to show that when one completes the next is started.
`String`	`setupDataFlow(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String dataSupplierGUID, String dataConsumerGUID, String qualifiedName, String description, String formula)` Link two elements together to show that data flows from one to the other.
`void`	`setupLineageMapping(String userId, String assetManagerGUID, String assetManagerName, String sourceElementGUID, String destinationElementGUID)` Link two elements together to show that they are part of the lineage of the data that is moving between the processes.
`void`	`setupPortDelegation(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String portOneGUID, String portTwoGUID)` Link two ports together to show that portTwo is an implementation of portOne.
`void`	`setupPortSchemaType(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String portGUID, String schemaTypeGUID)` Link a schema type to a port to show the structure of data it accepts.
`String`	`setupProcessCall(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String callerGUID, String calledGUID, String qualifiedName, String description, String formula)` Link two elements together to show a request-response call between them.
`void`	`setupProcessParent(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String parentProcessGUID, String childProcessGUID, ProcessContainmentType containmentType)` Create a parent-child relationship between two processes.
`void`	`setupProcessPort(String userId, String assetManagerGUID, String assetManagerName, boolean assetManagerIsHome, String processGUID, String portGUID)` Link a port to a process.
`void`	`updateControlFlow(String userId, String assetManagerGUID, String assetManagerName, String controlFlowGUID, String qualifiedName, String description, String guard)` Update the relationship between two elements that shows that when one completes the next is started.
`void`	`updateDataFlow(String userId, String assetManagerGUID, String assetManagerName, String dataFlowGUID, String qualifiedName, String description, String formula)` Update relationship between two elements that shows that data flows from one to the other.
`void`	`updatePort(String userId, String assetManagerGUID, String assetManagerName, String portGUID, String portExternalIdentifier, PortProperties portProperties)` Update the properties of the metadata element representing a port.
`void`	`updateProcess(String userId, String assetManagerGUID, String assetManagerName, String processGUID, String processExternalIdentifier, boolean isMergeUpdate, ProcessProperties processProperties)` Update the metadata element representing a process.
`void`	`updateProcessCall(String userId, String assetManagerGUID, String assetManagerName, String processCallGUID, String qualifiedName, String description, String formula)` Update the relationship between two elements that shows a request-response call between them.
`void`	`updateProcessStatus(String userId, String assetManagerGUID, String assetManagerName, String processGUID, String processExternalIdentifier, ProcessStatus processStatus)` Update the status of the metadata element representing a process.
`void`	`withdrawProcess(String userId, String assetManagerGUID, String assetManagerName, String processGUID)` Update the zones for the asset so that it is no longer visible to consumers.

- Method Detail
  - createProcess
```
String createProcess(String userId,
                     String assetManagerGUID,
                     String assetManagerName,
                     boolean assetManagerIsHome,
                     String processExternalIdentifier,
                     String processExternalIdentifierName,
                     String processExternalIdentifierUsage,
                     String processExternalIdentifierSource,
                     KeyPattern processExternalIdentifierKeyPattern,
                     Map<String,String> mappingProperties,
                     ProcessProperties processProperties,
                     ProcessStatus initialStatus)
              throws InvalidParameterException,
                     UserNotAuthorizedException,
                     PropertyServerException
```
    Create a new metadata element to represent a process.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    assetManagerIsHome - ensure that only the asset manager can update this process
    
    processExternalIdentifier - unique identifier of the process in the external asset manager
    
    processExternalIdentifierName - name of property for the external identifier in the external asset manager
    
    processExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager
    
    processExternalIdentifierSource - component that issuing this request.
    
    processExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)
    
    mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata
    
    processProperties - properties about the process to store
    
    initialStatus - status value for the new process (default = ACTIVE)
    
    Returns:
    
    unique identifier of the new process
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createProcessFromTemplate
```
String createProcessFromTemplate(String userId,
                                 String assetManagerGUID,
                                 String assetManagerName,
                                 boolean assetManagerIsHome,
                                 String templateGUID,
                                 String processExternalIdentifier,
                                 String processExternalIdentifierName,
                                 String processExternalIdentifierUsage,
                                 String processExternalIdentifierSource,
                                 KeyPattern processExternalIdentifierKeyPattern,
                                 Map<String,String> mappingProperties,
                                 TemplateProperties templateProperties)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
```
    Create a new metadata element to represent a process using an existing metadata element as a template.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    assetManagerIsHome - ensure that only the asset manager can update this process
    
    templateGUID - unique identifier of the metadata element to copy
    
    processExternalIdentifier - unique identifier of the process in the external asset manager
    
    processExternalIdentifierName - name of property for the external identifier in the external asset manager
    
    processExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager
    
    processExternalIdentifierSource - component that issuing this request.
    
    processExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)
    
    mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata
    
    templateProperties - properties that override the template
    
    Returns:
    
    unique identifier of the new process
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateProcess
```
void updateProcess(String userId,
                   String assetManagerGUID,
                   String assetManagerName,
                   String processGUID,
                   String processExternalIdentifier,
                   boolean isMergeUpdate,
                   ProcessProperties processProperties)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   PropertyServerException
```
    Update the metadata element representing a process.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    processGUID - unique identifier of the metadata element to update
    
    processExternalIdentifier - unique identifier of the process in the external asset manager
    
    isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
    
    processProperties - new properties for the metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateProcessStatus
```
void updateProcessStatus(String userId,
                         String assetManagerGUID,
                         String assetManagerName,
                         String processGUID,
                         String processExternalIdentifier,
                         ProcessStatus processStatus)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
```
    Update the status of the metadata element representing a process.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    processGUID - unique identifier of the process to update
    
    processExternalIdentifier - unique identifier of the process in the external asset manager
    
    processStatus - new status for the process
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupProcessParent
```
void setupProcessParent(String userId,
                        String assetManagerGUID,
                        String assetManagerName,
                        boolean assetManagerIsHome,
                        String parentProcessGUID,
                        String childProcessGUID,
                        ProcessContainmentType containmentType)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException
```
    Create a parent-child relationship between two processes.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    assetManagerIsHome - ensure that only the asset manager can update this asset
    
    parentProcessGUID - unique identifier of the process in the external asset manager that is to be the parent process
    
    childProcessGUID - unique identifier of the process in the external asset manager that is to be the nested sub-process
    
    containmentType - describes the ownership of the sub-process
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearProcessParent
```
void clearProcessParent(String userId,
                        String assetManagerGUID,
                        String assetManagerName,
                        String parentProcessGUID,
                        String childProcessGUID)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException
```
    Remove a parent-child relationship between two processes.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    parentProcessGUID - unique identifier of the process in the external asset manager that is to be the parent process
    
    childProcessGUID - unique identifier of the process in the external asset manager that is to be the nested sub-process
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - publishProcess
```
void publishProcess(String userId,
                    String assetManagerGUID,
                    String assetManagerName,
                    String processGUID)
             throws InvalidParameterException,
                    UserNotAuthorizedException,
                    PropertyServerException
```
    Update the zones for the asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Asset Manager OMAS).
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    processGUID - unique identifier of the metadata element to publish
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - withdrawProcess
```
void withdrawProcess(String userId,
                     String assetManagerGUID,
                     String assetManagerName,
                     String processGUID)
              throws InvalidParameterException,
                     UserNotAuthorizedException,
                     PropertyServerException
```
    Update the zones for the asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Asset Manager OMAS. This is the setting when the process is first created).
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    processGUID - unique identifier of the metadata element to withdraw
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - removeProcess
```
void removeProcess(String userId,
                   String assetManagerGUID,
                   String assetManagerName,
                   String processGUID,
                   String processExternalIdentifier)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   PropertyServerException
```
    Remove the metadata element representing a process.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    processGUID - unique identifier of the metadata element to remove
    
    processExternalIdentifier - unique identifier of the process in the external asset manager
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findProcesses
```
List<ProcessElement> findProcesses(String userId,
                                   String assetManagerGUID,
                                   String assetManagerName,
                                   String searchString,
                                   int startFrom,
                                   int pageSize)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
```
    Retrieve the list of process metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    searchString - string to find in the properties
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getProcessesForAssetManager
```
List<ProcessElement> getProcessesForAssetManager(String userId,
                                                 String assetManagerGUID,
                                                 String assetManagerName,
                                                 int startFrom,
                                                 int pageSize)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
```
    Return the list of processes associated with the asset manager.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of metadata elements describing the processes associated with the requested asset manager
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getProcessesByName
```
List<ProcessElement> getProcessesByName(String userId,
                                        String assetManagerGUID,
                                        String assetManagerName,
                                        String name,
                                        int startFrom,
                                        int pageSize)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
```
    Retrieve the list of process metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    name - name to search for
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getProcessByGUID
```
ProcessElement getProcessByGUID(String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String processGUID)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
```
    Retrieve the process metadata element with the supplied unique identifier.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    processGUID - unique identifier of the requested metadata element
    
    Returns:
    
    requested metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getProcessParent
```
ProcessElement getProcessParent(String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String processGUID)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
```
    Retrieve the process metadata element with the supplied unique identifier.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    processGUID - unique identifier of the requested metadata element
    
    Returns:
    
    parent process element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getSubProcesses
```
List<ProcessElement> getSubProcesses(String userId,
                                     String assetManagerGUID,
                                     String assetManagerName,
                                     String processGUID,
                                     int startFrom,
                                     int pageSize)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
```
    Retrieve the process metadata element with the supplied unique identifier.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    processGUID - unique identifier of the requested metadata element
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of process element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - createPort
```
String createPort(String userId,
                  String assetManagerGUID,
                  String assetManagerName,
                  boolean assetManagerIsHome,
                  String processGUID,
                  String portExternalIdentifier,
                  String portExternalIdentifierName,
                  String portExternalIdentifierUsage,
                  String portExternalIdentifierSource,
                  KeyPattern portExternalIdentifierKeyPattern,
                  Map<String,String> mappingProperties,
                  PortProperties portProperties)
           throws InvalidParameterException,
                  UserNotAuthorizedException,
                  PropertyServerException
```
    Create a new metadata element to represent a port.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    assetManagerIsHome - ensure that only the asset manager can update this port
    
    processGUID - unique identifier of the process where the port is located
    
    portExternalIdentifier - unique identifier of the port in the external asset manager
    
    portExternalIdentifierName - name of property for the external identifier in the external asset manager
    
    portExternalIdentifierUsage - optional usage description for the external identifier when calling the external asset manager
    
    portExternalIdentifierSource - component that issuing this request.
    
    portExternalIdentifierKeyPattern - pattern for the external identifier within the external asset manager (default is LOCAL_KEY)
    
    mappingProperties - additional properties to help with the mapping of the elements in the external asset manager and open metadata
    
    portProperties - properties for the port
    
    Returns:
    
    unique identifier of the new metadata element for the port
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updatePort
```
void updatePort(String userId,
                String assetManagerGUID,
                String assetManagerName,
                String portGUID,
                String portExternalIdentifier,
                PortProperties portProperties)
         throws InvalidParameterException,
                UserNotAuthorizedException,
                PropertyServerException
```
    Update the properties of the metadata element representing a port. This call replaces all existing properties with the supplied properties.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    portGUID - unique identifier of the port to update
    
    portProperties - new properties for the port
    
    portExternalIdentifier - unique identifier of the port in the external asset manager
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupProcessPort
```
void setupProcessPort(String userId,
                      String assetManagerGUID,
                      String assetManagerName,
                      boolean assetManagerIsHome,
                      String processGUID,
                      String portGUID)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException
```
    Link a port to a process.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    assetManagerIsHome - ensure that only the asset manager can update this asset
    
    processGUID - unique identifier of the process
    
    portGUID - unique identifier of the port
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearProcessPort
```
void clearProcessPort(String userId,
                      String assetManagerGUID,
                      String assetManagerName,
                      String processGUID,
                      String portGUID)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException
```
    Unlink a port from a process.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    processGUID - unique identifier of the process
    
    portGUID - unique identifier of the port
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupPortDelegation
```
void setupPortDelegation(String userId,
                         String assetManagerGUID,
                         String assetManagerName,
                         boolean assetManagerIsHome,
                         String portOneGUID,
                         String portTwoGUID)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
```
    Link two ports together to show that portTwo is an implementation of portOne. (That is, portOne delegates to portTwo.)
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    assetManagerIsHome - ensure that only the asset manager can update this asset
    
    portOneGUID - unique identifier of the port at end 1
    
    portTwoGUID - unique identifier of the port at end 2
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearPortDelegation
```
void clearPortDelegation(String userId,
                         String assetManagerGUID,
                         String assetManagerName,
                         String portOneGUID,
                         String portTwoGUID)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
```
    Remove the port delegation relationship between two ports.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    portOneGUID - unique identifier of the port at end 1
    
    portTwoGUID - unique identifier of the port at end 2
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupPortSchemaType
```
void setupPortSchemaType(String userId,
                         String assetManagerGUID,
                         String assetManagerName,
                         boolean assetManagerIsHome,
                         String portGUID,
                         String schemaTypeGUID)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
```
    Link a schema type to a port to show the structure of data it accepts.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    assetManagerIsHome - ensure that only the asset manager can update this asset
    
    portGUID - unique identifier of the port
    
    schemaTypeGUID - unique identifier of the schemaType
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearPortSchemaType
```
void clearPortSchemaType(String userId,
                         String assetManagerGUID,
                         String assetManagerName,
                         String portGUID,
                         String schemaTypeGUID)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
```
    Remove the schema type from a port.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    portGUID - unique identifier of the port
    
    schemaTypeGUID - unique identifier of the schemaType
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - removePort
```
void removePort(String userId,
                String assetManagerGUID,
                String assetManagerName,
                String portGUID,
                String portExternalIdentifier)
         throws InvalidParameterException,
                UserNotAuthorizedException,
                PropertyServerException
```
    Remove the metadata element representing a port.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    portGUID - unique identifier of the metadata element to remove
    
    portExternalIdentifier - unique identifier of the port in the external asset manager
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - findPorts
```
List<PortElement> findPorts(String userId,
                            String assetManagerGUID,
                            String assetManagerName,
                            String searchString,
                            int startFrom,
                            int pageSize)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
```
    Retrieve the list of port metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    searchString - string to find in the properties
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getPortsForProcess
```
List<PortElement> getPortsForProcess(String userId,
                                     String assetManagerGUID,
                                     String assetManagerName,
                                     String processGUID,
                                     int startFrom,
                                     int pageSize)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
```
    Retrieve the list of ports associated with a process.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    processGUID - unique identifier of the process of interest
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of associated metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getPortUse
```
List<PortElement> getPortUse(String userId,
                             String assetManagerGUID,
                             String assetManagerName,
                             String portGUID,
                             int startFrom,
                             int pageSize)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
    Retrieve the list of ports that delegate to this port.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    portGUID - unique identifier of the starting port
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of associated metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getPortDelegation
```
PortElement getPortDelegation(String userId,
                              String assetManagerGUID,
                              String assetManagerName,
                              String portGUID)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
```
    Retrieve the port that this port delegates to.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    portGUID - unique identifier of the starting port alias
    
    Returns:
    
    matching metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getPortsByName
```
List<PortElement> getPortsByName(String userId,
                                 String assetManagerGUID,
                                 String assetManagerName,
                                 String name,
                                 int startFrom,
                                 int pageSize)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
```
    Retrieve the list of port metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    name - name to search for
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of matching metadata elements
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getPortByGUID
```
PortElement getPortByGUID(String userId,
                          String assetManagerGUID,
                          String assetManagerName,
                          String portGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException
```
    Retrieve the port metadata element with the supplied unique identifier.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    portGUID - unique identifier of the requested metadata element
    
    Returns:
    
    matching metadata element
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setBusinessSignificant
```
void setBusinessSignificant(String userId,
                            String assetManagerGUID,
                            String assetManagerName,
                            String elementGUID,
                            String elementExternalIdentifier)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
```
    Classify a port, process or asset as "BusinessSignificant" (this may effect the way that lineage is displayed).
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    elementGUID - unique identifier of the metadata element to update
    
    elementExternalIdentifier - unique identifier of the port in the external asset manager
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearBusinessSignificant
```
void clearBusinessSignificant(String userId,
                              String assetManagerGUID,
                              String assetManagerName,
                              String elementGUID,
                              String elementExternalIdentifier)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
```
    Remove the "BusinessSignificant" designation from the element.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    elementGUID - unique identifier of the metadata element to update
    
    elementExternalIdentifier - unique identifier of the element in the external asset manager (can be null)
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupDataFlow
```
String setupDataFlow(String userId,
                     String assetManagerGUID,
                     String assetManagerName,
                     boolean assetManagerIsHome,
                     String dataSupplierGUID,
                     String dataConsumerGUID,
                     String qualifiedName,
                     String description,
                     String formula)
              throws InvalidParameterException,
                     UserNotAuthorizedException,
                     PropertyServerException
```
    Link two elements together to show that data flows from one to the other.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    assetManagerIsHome - ensure that only the asset manager can update this asset
    
    dataSupplierGUID - unique identifier of the data supplier
    
    dataConsumerGUID - unique identifier of the data consumer
    
    qualifiedName - unique identifier for this relationship
    
    description - description and/or purpose of the data flow
    
    formula - function that determines the subset of the data that flows
    
    Returns:
    
    unique identifier of the relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getDataFlow
```
DataFlowElement getDataFlow(String userId,
                            String assetManagerGUID,
                            String assetManagerName,
                            String dataSupplierGUID,
                            String dataConsumerGUID,
                            String qualifiedName)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
```
    Retrieve the data flow relationship between two elements. The qualifiedName is optional unless there is more than one data flow relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    dataSupplierGUID - unique identifier of the data supplier
    
    dataConsumerGUID - unique identifier of the data consumer
    
    qualifiedName - unique identifier for this relationship
    
    Returns:
    
    unique identifier and properties of the relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateDataFlow
```
void updateDataFlow(String userId,
                    String assetManagerGUID,
                    String assetManagerName,
                    String dataFlowGUID,
                    String qualifiedName,
                    String description,
                    String formula)
             throws InvalidParameterException,
                    UserNotAuthorizedException,
                    PropertyServerException
```
    Update relationship between two elements that shows that data flows from one to the other.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    dataFlowGUID - unique identifier of the data flow relationship
    
    qualifiedName - unique identifier for this relationship
    
    description - description and/or purpose of the data flow
    
    formula - function that determines the subset of the data that flows
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearDataFlow
```
void clearDataFlow(String userId,
                   String assetManagerGUID,
                   String assetManagerName,
                   String dataFlowGUID)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   PropertyServerException
```
    Remove the data flow relationship between two elements.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    dataFlowGUID - unique identifier of the data flow relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getDataFlowConsumers
```
List<DataFlowElement> getDataFlowConsumers(String userId,
                                           String assetManagerGUID,
                                           String assetManagerName,
                                           String dataSupplierGUID)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
```
    Retrieve the data flow relationships linked from an specific element to the downstream consumers.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    dataSupplierGUID - unique identifier of the data supplier
    
    Returns:
    
    unique identifier and properties of the relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getDataFlowSuppliers
```
List<DataFlowElement> getDataFlowSuppliers(String userId,
                                           String assetManagerGUID,
                                           String assetManagerName,
                                           String dataConsumerGUID)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
```
    Retrieve the data flow relationships linked from an specific element to the upstream suppliers.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    dataConsumerGUID - unique identifier of the data consumer
    
    Returns:
    
    unique identifier and properties of the relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupControlFlow
```
String setupControlFlow(String userId,
                        String assetManagerGUID,
                        String assetManagerName,
                        boolean assetManagerIsHome,
                        String currentStepGUID,
                        String nextStepGUID,
                        String qualifiedName,
                        String description,
                        String guard)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException
```
    Link two elements to show that when one completes the next is started.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    assetManagerIsHome - ensure that only the asset manager can update this asset
    
    currentStepGUID - unique identifier of the previous step
    
    nextStepGUID - unique identifier of the next step
    
    qualifiedName - unique identifier for this relationship
    
    description - description and/or purpose of the data flow
    
    guard - function that must be true to travel down this control flow
    
    Returns:
    
    unique identifier for the control flow relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getControlFlow
```
ControlFlowElement getControlFlow(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  String currentStepGUID,
                                  String nextStepGUID,
                                  String qualifiedName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
```
    Retrieve the control flow relationship between two elements. The qualifiedName is optional unless there is more than one control flow relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    currentStepGUID - unique identifier of the previous step
    
    nextStepGUID - unique identifier of the next step
    
    qualifiedName - unique identifier for this relationship
    
    Returns:
    
    unique identifier and properties of the relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateControlFlow
```
void updateControlFlow(String userId,
                       String assetManagerGUID,
                       String assetManagerName,
                       String controlFlowGUID,
                       String qualifiedName,
                       String description,
                       String guard)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException
```
    Update the relationship between two elements that shows that when one completes the next is started.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    controlFlowGUID - unique identifier of the control flow relationship
    
    qualifiedName - unique identifier for this relationship
    
    description - description and/or purpose of the data flow
    
    guard - function that must be true to travel down this control flow
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearControlFlow
```
void clearControlFlow(String userId,
                      String assetManagerGUID,
                      String assetManagerName,
                      String controlFlowGUID)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException
```
    Remove the control flow relationship between two elements.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    controlFlowGUID - unique identifier of the control flow relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getControlFlowNextSteps
```
List<ControlFlowElement> getControlFlowNextSteps(String userId,
                                                 String assetManagerGUID,
                                                 String assetManagerName,
                                                 String currentStepGUID)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
```
    Retrieve the control relationships linked from an specific element to the possible next elements in the process.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    currentStepGUID - unique identifier of the current step
    
    Returns:
    
    unique identifier and properties of the relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getControlFlowPreviousSteps
```
List<ControlFlowElement> getControlFlowPreviousSteps(String userId,
                                                     String assetManagerGUID,
                                                     String assetManagerName,
                                                     String currentStepGUID)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException
```
    Retrieve the control relationships linked from an specific element to the possible previous elements in the process.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    currentStepGUID - unique identifier of the current step
    
    Returns:
    
    unique identifier and properties of the relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupProcessCall
```
String setupProcessCall(String userId,
                        String assetManagerGUID,
                        String assetManagerName,
                        boolean assetManagerIsHome,
                        String callerGUID,
                        String calledGUID,
                        String qualifiedName,
                        String description,
                        String formula)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException
```
    Link two elements together to show a request-response call between them.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    assetManagerIsHome - ensure that only the asset manager can update this asset
    
    callerGUID - unique identifier of the element that is making the call
    
    calledGUID - unique identifier of the element that is processing the call
    
    qualifiedName - unique identifier for this relationship
    
    description - description and/or purpose of the data flow
    
    formula - function that determines the subset of the data that flows
    
    Returns:
    
    unique identifier of the new relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getProcessCall
```
ProcessCallElement getProcessCall(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  String callerGUID,
                                  String calledGUID,
                                  String qualifiedName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
```
    Retrieve the process call relationship between two elements. The qualifiedName is optional unless there is more than one process call relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    callerGUID - unique identifier of the element that is making the call
    
    calledGUID - unique identifier of the element that is processing the call
    
    qualifiedName - unique identifier for this relationship
    
    Returns:
    
    unique identifier and properties of the relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - updateProcessCall
```
void updateProcessCall(String userId,
                       String assetManagerGUID,
                       String assetManagerName,
                       String processCallGUID,
                       String qualifiedName,
                       String description,
                       String formula)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException
```
    Update the relationship between two elements that shows a request-response call between them.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    processCallGUID - unique identifier of the process call relationship
    
    qualifiedName - unique identifier for this relationship
    
    description - description and/or purpose of the data flow
    
    formula - function that determines the subset of the data that flows
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearProcessCall
```
void clearProcessCall(String userId,
                      String assetManagerGUID,
                      String assetManagerName,
                      String processCallGUID)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException
```
    Remove the process call relationship.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    processCallGUID - unique identifier of the process call relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getProcessCalled
```
List<ProcessCallElement> getProcessCalled(String userId,
                                          String assetManagerGUID,
                                          String assetManagerName,
                                          String callerGUID)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
```
    Retrieve the process call relationships linked from an specific element to the elements it calls.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    callerGUID - unique identifier of the element that is making the call
    
    Returns:
    
    unique identifier and properties of the relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getProcessCallers
```
List<ProcessCallElement> getProcessCallers(String userId,
                                           String assetManagerGUID,
                                           String assetManagerName,
                                           String calledGUID)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
```
    Retrieve the process call relationships linked from an specific element to its callers.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    calledGUID - unique identifier of the element that is processing the call
    
    Returns:
    
    unique identifier and properties of the relationship
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - setupLineageMapping
```
void setupLineageMapping(String userId,
                         String assetManagerGUID,
                         String assetManagerName,
                         String sourceElementGUID,
                         String destinationElementGUID)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
```
    Link two elements together to show that they are part of the lineage of the data that is moving between the processes. Typically the lineage relationships stitch together processes and data assets supported by different technologies.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    sourceElementGUID - unique identifier of the source
    
    destinationElementGUID - unique identifier of the destination
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - clearLineageMapping
```
void clearLineageMapping(String userId,
                         String assetManagerGUID,
                         String assetManagerName,
                         String sourceElementGUID,
                         String destinationElementGUID)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
```
    Remove the lineage mapping between two elements.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    sourceElementGUID - unique identifier of the source
    
    destinationElementGUID - unique identifier of the destination
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getDestinationLineageMappings
```
List<LineageMappingElement> getDestinationLineageMappings(String userId,
                                                          String assetManagerGUID,
                                                          String assetManagerName,
                                                          String sourceElementGUID)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException
```
    Retrieve the lineage mapping relationships linked from an specific source element to its destinations.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    sourceElementGUID - unique identifier of the source
    
    Returns:
    
    list of lineage mapping relationships
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)
  - getSourceLineageMappings
```
List<LineageMappingElement> getSourceLineageMappings(String userId,
                                                     String assetManagerGUID,
                                                     String assetManagerName,
                                                     String destinationElementGUID)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException
```
    Retrieve the lineage mapping relationships linked from an specific destination element to its sources.
    
    Parameters:
    
    userId - calling user
    
    assetManagerGUID - unique identifier of software server capability representing the caller
    
    assetManagerName - unique name of software server capability representing the caller
    
    destinationElementGUID - unique identifier of the destination
    
    Returns:
    
    list of lineage mapping relationships
    
    Throws:
    
    InvalidParameterException - one of the parameters is invalid
    
    UserNotAuthorizedException - the user is not authorized to issue this request
    
    PropertyServerException - there is a problem reported in the open metadata server(s)

Interface LineageExchangeInterface

Method Summary

Methods inherited from interface org.odpi.openmetadata.accessservices.assetmanager.api.SchemaExchangeInterface

Method Detail

createProcess

createProcessFromTemplate

updateProcess

updateProcessStatus

setupProcessParent

clearProcessParent

publishProcess

withdrawProcess

removeProcess

findProcesses

getProcessesForAssetManager

getProcessesByName

getProcessByGUID

getProcessParent

getSubProcesses

createPort

updatePort

setupProcessPort

clearProcessPort

setupPortDelegation

clearPortDelegation

setupPortSchemaType

clearPortSchemaType

removePort

findPorts

getPortsForProcess

getPortUse

getPortDelegation

getPortsByName

getPortByGUID

setBusinessSignificant

clearBusinessSignificant

setupDataFlow

getDataFlow

updateDataFlow

clearDataFlow

getDataFlowConsumers

getDataFlowSuppliers

setupControlFlow

getControlFlow

updateControlFlow

clearControlFlow

getControlFlowNextSteps

getControlFlowPreviousSteps

setupProcessCall

getProcessCall

updateProcessCall

clearProcessCall

getProcessCalled

getProcessCallers

setupLineageMapping

clearLineageMapping

getDestinationLineageMappings

getSourceLineageMappings