Interface ProcessManagerInterface

  • All Known Implementing Classes:
    ProcessManagerClient

    public interface ProcessManagerInterface
    The ProcessManagerInterface supports the management of process definitions and lineage linkage.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearBusinessSignificant​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String elementGUID, java.util.Date effectiveTime)
      Remove the "BusinessSignificant" designation from the element.
      void clearControlFlow​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String controlFlowGUID, java.util.Date effectiveTime)
      Remove the control flow relationship between two elements.
      void clearDataFlow​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String dataFlowGUID, java.util.Date effectiveTime)
      Remove the data flow relationship between two elements.
      void clearLineageMapping​(java.lang.String userId, java.lang.String lineageMappingGUID, java.util.Date effectiveTime)
      Remove the lineage mapping relationship.
      void clearProcessCall​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String processCallGUID, java.util.Date effectiveTime)
      Remove the process call relationship.
      void clearProcessParent​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String parentProcessGUID, java.lang.String childProcessGUID, java.util.Date effectiveTime)
      Remove a parent-child relationship between two processes.
      java.lang.String createProcess​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, ProcessStatus processStatus, ProcessProperties processProperties)
      Create a new metadata element to represent a process.
      java.lang.String createProcessFromTemplate​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a process using an existing metadata element as a template.
      java.util.List<ProcessElement> findProcesses​(java.lang.String userId, java.lang.String searchString, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of process metadata elements that contain the search string.
      ControlFlowElement getControlFlow​(java.lang.String userId, java.lang.String currentStepGUID, java.lang.String nextStepGUID, java.lang.String qualifiedName, java.util.Date effectiveTime)
      Retrieve the control flow relationship between two elements.
      java.util.List<ControlFlowElement> getControlFlowNextSteps​(java.lang.String userId, java.lang.String currentStepGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the control relationships linked from a specific element to the possible next elements in the process.
      java.util.List<ControlFlowElement> getControlFlowPreviousSteps​(java.lang.String userId, java.lang.String currentStepGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the control relationships linked from a specific element to the possible previous elements in the process.
      DataFlowElement getDataFlow​(java.lang.String userId, java.lang.String dataSupplierGUID, java.lang.String dataConsumerGUID, java.lang.String qualifiedName, java.util.Date effectiveTime)
      Retrieve the data flow relationship between two elements.
      java.util.List<DataFlowElement> getDataFlowConsumers​(java.lang.String userId, java.lang.String dataSupplierGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the data flow relationships linked from a specific element to the downstream consumers.
      java.util.List<DataFlowElement> getDataFlowSuppliers​(java.lang.String userId, java.lang.String dataConsumerGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the data flow relationships linked from a specific element to the upstream suppliers.
      java.util.List<LineageMappingElement> getDestinationLineageMappings​(java.lang.String userId, java.lang.String sourceElementGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the lineage mapping relationships linked from a specific source element to its destinations.
      LineageMappingElement getLineageMapping​(java.lang.String userId, java.lang.String sourceElementGUID, java.lang.String destinationElementGUID, java.lang.String qualifiedName, java.util.Date effectiveTime)
      Retrieve the lineage mapping relationship between two elements.
      ProcessElement getProcessByGUID​(java.lang.String userId, java.lang.String processGUID)
      Retrieve the process metadata element with the supplied unique identifier.
      ProcessCallElement getProcessCall​(java.lang.String userId, java.lang.String callerGUID, java.lang.String calledGUID, java.lang.String qualifiedName, java.util.Date effectiveTime)
      Retrieve the process call relationship between two elements.
      java.util.List<ProcessCallElement> getProcessCalled​(java.lang.String userId, java.lang.String callerGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the process call relationships linked from a specific element to the elements it calls.
      java.util.List<ProcessCallElement> getProcessCallers​(java.lang.String userId, java.lang.String calledGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the process call relationships linked from a specific element to its callers.
      java.util.List<ProcessElement> getProcessesByName​(java.lang.String userId, java.lang.String name, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the list of process metadata elements with a matching qualified or display name.
      java.util.List<ProcessElement> getProcessesForInfrastructureManager​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.util.Date effectiveTime, int startFrom, int pageSize)
      Return the list of processes associated with the infrastructure manager.
      ProcessElement getProcessParent​(java.lang.String userId, java.lang.String processGUID, java.util.Date effectiveTime)
      Retrieve the process metadata element with the supplied unique identifier.
      java.util.List<LineageMappingElement> getSourceLineageMappings​(java.lang.String userId, java.lang.String destinationElementGUID, int startFrom, int pageSize, java.util.Date effectiveTime)
      Retrieve the lineage mapping relationships linked from a specific destination element to its sources.
      java.util.List<ProcessElement> getSubProcesses​(java.lang.String userId, java.lang.String processGUID, java.util.Date effectiveTime, int startFrom, int pageSize)
      Retrieve the process metadata element with the supplied unique identifier.
      void publishProcess​(java.lang.String userId, java.lang.String processGUID)
      Update the zones for the asset so that it becomes visible to consumers.
      void removeProcess​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String processGUID)
      Remove the metadata element representing a process.
      void setBusinessSignificant​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String elementGUID, java.util.Date effectiveFrom, java.util.Date effectiveTo)
      Classify a port, process or asset as "BusinessSignificant" (this may affect the way that lineage is displayed).
      java.lang.String setupControlFlow​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String currentStepGUID, java.lang.String nextStepGUID, ControlFlowProperties properties, java.util.Date effectiveTime)
      Link two elements to show that when one completes the next is started.
      java.lang.String setupDataFlow​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String dataSupplierGUID, java.lang.String dataConsumerGUID, DataFlowProperties properties, java.util.Date effectiveTime)
      Link two elements together to show that data flows from one to the other.
      java.lang.String setupLineageMapping​(java.lang.String userId, java.lang.String sourceElementGUID, java.lang.String destinationElementGUID, LineageMappingProperties properties, java.util.Date effectiveTime)
      Link two elements together to show that they are part of the lineage of the data that is moving between the processes.
      java.lang.String setupProcessCall​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String callerGUID, java.lang.String calledGUID, ProcessCallProperties properties, java.util.Date effectiveTime)
      Link two elements together to show a request-response call between them.
      void setupProcessParent​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String parentProcessGUID, java.lang.String childProcessGUID, ProcessContainmentType containmentType, java.util.Date effectiveFrom, java.util.Date effectiveTo)
      Create a parent-child relationship between two processes.
      void updateControlFlow​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String controlFlowGUID, ControlFlowProperties properties, java.util.Date effectiveTime)
      Update the relationship between two elements that shows that when one completes the next is started.
      void updateDataFlow​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String dataFlowGUID, DataFlowProperties properties, java.util.Date effectiveTime)
      Update relationship between two elements that shows that data flows from one to the other.
      void updateLineageMapping​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String lineageMappingGUID, LineageMappingProperties properties, java.util.Date effectiveTime)
      Update the lineage mapping relationship between two elements.
      void updateProcess​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String processGUID, boolean isMergeUpdate, ProcessProperties processProperties)
      Update the metadata element representing a process.
      void updateProcessCall​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String processCallGUID, ProcessCallProperties properties, java.util.Date effectiveTime)
      Update the relationship between two elements that shows a request-response call between them.
      void updateProcessStatus​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String processGUID, ProcessStatus processStatus)
      Update the status of the metadata element representing a process.
      void withdrawProcess​(java.lang.String userId, java.lang.String processGUID)
      Update the zones for the asset so that it is no longer visible to consumers.
    • Method Detail

      • createProcess

        java.lang.String createProcess​(java.lang.String userId,
                                       java.lang.String infrastructureManagerGUID,
                                       java.lang.String infrastructureManagerName,
                                       boolean infrastructureManagerIsHome,
                                       ProcessStatus processStatus,
                                       ProcessProperties processProperties)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
        Create a new metadata element to represent a process.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        infrastructureManagerIsHome - ensure that only the infrastructure manager can update this process
        processStatus - initial status of the process
        processProperties - properties about the process to store
        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

        java.lang.String createProcessFromTemplate​(java.lang.String userId,
                                                   java.lang.String infrastructureManagerGUID,
                                                   java.lang.String infrastructureManagerName,
                                                   boolean infrastructureManagerIsHome,
                                                   java.lang.String templateGUID,
                                                   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
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        infrastructureManagerIsHome - ensure that only the infrastructure manager can update this process
        templateGUID - unique identifier of the metadata element to copy
        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​(java.lang.String userId,
                           java.lang.String infrastructureManagerGUID,
                           java.lang.String infrastructureManagerName,
                           java.lang.String processGUID,
                           boolean isMergeUpdate,
                           ProcessProperties processProperties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
        Update the metadata element representing a process.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        processGUID - unique identifier of the metadata element to update
        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​(java.lang.String userId,
                                 java.lang.String infrastructureManagerGUID,
                                 java.lang.String infrastructureManagerName,
                                 java.lang.String processGUID,
                                 ProcessStatus processStatus)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
        Update the status of the metadata element representing a process.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        processGUID - unique identifier of the process to update
        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​(java.lang.String userId,
                                java.lang.String infrastructureManagerGUID,
                                java.lang.String infrastructureManagerName,
                                boolean infrastructureManagerIsHome,
                                java.lang.String parentProcessGUID,
                                java.lang.String childProcessGUID,
                                ProcessContainmentType containmentType,
                                java.util.Date effectiveFrom,
                                java.util.Date effectiveTo)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
        Create a parent-child relationship between two processes.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset
        parentProcessGUID - unique identifier of the process that is to be the parent process
        childProcessGUID - unique identifier of the process that is to be the nested sub-process
        containmentType - describes the ownership of the sub-process
        effectiveFrom - time when this relationship is effective - null means immediately
        effectiveTo - time when this relationship is no longer effective - null means forever
        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​(java.lang.String userId,
                                java.lang.String infrastructureManagerGUID,
                                java.lang.String infrastructureManagerName,
                                java.lang.String parentProcessGUID,
                                java.lang.String childProcessGUID,
                                java.util.Date effectiveTime)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
        Remove a parent-child relationship between two processes.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        parentProcessGUID - unique identifier of the process that is to be the parent process
        childProcessGUID - unique identifier of the process that is to be the nested sub-process
        effectiveTime - time when the relationship is effective
        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​(java.lang.String userId,
                             java.lang.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 IT Infrastructure OMAS. This is the setting when the host is first created).
        Parameters:
        userId - calling user
        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​(java.lang.String userId,
                           java.lang.String infrastructureManagerGUID,
                           java.lang.String infrastructureManagerName,
                           java.lang.String processGUID)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
        Remove the metadata element representing a process.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        processGUID - unique identifier of the metadata element to remove
        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

        java.util.List<ProcessElement> findProcesses​(java.lang.String userId,
                                                     java.lang.String searchString,
                                                     java.util.Date effectiveTime,
                                                     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
        searchString - string to find in the properties
        effectiveTime - effective time for the query
        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)
      • getProcessesForInfrastructureManager

        java.util.List<ProcessElement> getProcessesForInfrastructureManager​(java.lang.String userId,
                                                                            java.lang.String infrastructureManagerGUID,
                                                                            java.lang.String infrastructureManagerName,
                                                                            java.util.Date effectiveTime,
                                                                            int startFrom,
                                                                            int pageSize)
                                                                     throws InvalidParameterException,
                                                                            UserNotAuthorizedException,
                                                                            PropertyServerException
        Return the list of processes associated with the infrastructure manager.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        effectiveTime - effective time for the query
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of metadata elements describing the processes associated with the requested infrastructure 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

        java.util.List<ProcessElement> getProcessesByName​(java.lang.String userId,
                                                          java.lang.String name,
                                                          java.util.Date effectiveTime,
                                                          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
        name - name to search for
        effectiveTime - effective time for the query
        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)
      • getSubProcesses

        java.util.List<ProcessElement> getSubProcesses​(java.lang.String userId,
                                                       java.lang.String processGUID,
                                                       java.util.Date effectiveTime,
                                                       int startFrom,
                                                       int pageSize)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException
        Retrieve the process metadata element with the supplied unique identifier.
        Parameters:
        userId - calling user
        processGUID - unique identifier of the requested metadata element
        effectiveTime - effective time for the query
        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)
      • setBusinessSignificant

        void setBusinessSignificant​(java.lang.String userId,
                                    java.lang.String infrastructureManagerGUID,
                                    java.lang.String infrastructureManagerName,
                                    java.lang.String elementGUID,
                                    java.util.Date effectiveFrom,
                                    java.util.Date effectiveTo)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
        Classify a port, process or asset as "BusinessSignificant" (this may affect the way that lineage is displayed).
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        elementGUID - unique identifier of the metadata element to update
        effectiveFrom - time when this hosting is effective - null means immediately
        effectiveTo - time when this hosting is no longer effective - null means forever
        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​(java.lang.String userId,
                                      java.lang.String infrastructureManagerGUID,
                                      java.lang.String infrastructureManagerName,
                                      java.lang.String elementGUID,
                                      java.util.Date effectiveTime)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException
        Remove the "BusinessSignificant" designation from the element.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        elementGUID - unique identifier of the metadata element to update
        effectiveTime - time when the hosting is effective
        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

        java.lang.String setupDataFlow​(java.lang.String userId,
                                       java.lang.String infrastructureManagerGUID,
                                       java.lang.String infrastructureManagerName,
                                       boolean infrastructureManagerIsHome,
                                       java.lang.String dataSupplierGUID,
                                       java.lang.String dataConsumerGUID,
                                       DataFlowProperties properties,
                                       java.util.Date effectiveTime)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException
        Link two elements together to show that data flows from one to the other.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset
        dataSupplierGUID - unique identifier of the data supplier
        dataConsumerGUID - unique identifier of the data consumer
        effectiveTime - optional date for effective time of the query. Null means any effective time
        properties - qualified name for this relationship and other related properties
        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​(java.lang.String userId,
                                    java.lang.String dataSupplierGUID,
                                    java.lang.String dataConsumerGUID,
                                    java.lang.String qualifiedName,
                                    java.util.Date effectiveTime)
                             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
        dataSupplierGUID - unique identifier of the data supplier
        dataConsumerGUID - unique identifier of the data consumer
        qualifiedName - unique identifier for this relationship
        effectiveTime - effective time for the query
        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​(java.lang.String userId,
                            java.lang.String infrastructureManagerGUID,
                            java.lang.String infrastructureManagerName,
                            java.lang.String dataFlowGUID,
                            DataFlowProperties properties,
                            java.util.Date effectiveTime)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
        Update relationship between two elements that shows that data flows from one to the other.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        dataFlowGUID - unique identifier of the data flow relationship
        properties - qualified name for this relationship and other related properties
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        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​(java.lang.String userId,
                           java.lang.String infrastructureManagerGUID,
                           java.lang.String infrastructureManagerName,
                           java.lang.String dataFlowGUID,
                           java.util.Date effectiveTime)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
        Remove the data flow relationship between two elements.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        dataFlowGUID - unique identifier of the data flow relationship
        effectiveTime - time when the relationship is effective
        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

        java.util.List<DataFlowElement> getDataFlowConsumers​(java.lang.String userId,
                                                             java.lang.String dataSupplierGUID,
                                                             int startFrom,
                                                             int pageSize,
                                                             java.util.Date effectiveTime)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException
        Retrieve the data flow relationships linked from a specific element to the downstream consumers.
        Parameters:
        userId - calling user
        dataSupplierGUID - unique identifier of the data supplier
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - effective time for the query
        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

        java.util.List<DataFlowElement> getDataFlowSuppliers​(java.lang.String userId,
                                                             java.lang.String dataConsumerGUID,
                                                             int startFrom,
                                                             int pageSize,
                                                             java.util.Date effectiveTime)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException
        Retrieve the data flow relationships linked from a specific element to the upstream suppliers.
        Parameters:
        userId - calling user
        dataConsumerGUID - unique identifier of the data consumer
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - effective time for the query
        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

        java.lang.String setupControlFlow​(java.lang.String userId,
                                          java.lang.String infrastructureManagerGUID,
                                          java.lang.String infrastructureManagerName,
                                          boolean infrastructureManagerIsHome,
                                          java.lang.String currentStepGUID,
                                          java.lang.String nextStepGUID,
                                          ControlFlowProperties properties,
                                          java.util.Date effectiveTime)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Link two elements to show that when one completes the next is started.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset
        currentStepGUID - unique identifier of the previous step
        nextStepGUID - unique identifier of the next step
        effectiveTime - optional date for effective time of the query. Null means any effective time
        properties - qualified name for this relationship and other related properties
        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​(java.lang.String userId,
                                          java.lang.String currentStepGUID,
                                          java.lang.String nextStepGUID,
                                          java.lang.String qualifiedName,
                                          java.util.Date effectiveTime)
                                   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
        currentStepGUID - unique identifier of the previous step
        nextStepGUID - unique identifier of the next step
        qualifiedName - unique identifier for this relationship
        effectiveTime - effective time for the query
        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​(java.lang.String userId,
                               java.lang.String infrastructureManagerGUID,
                               java.lang.String infrastructureManagerName,
                               java.lang.String controlFlowGUID,
                               ControlFlowProperties properties,
                               java.util.Date effectiveTime)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
        Update the relationship between two elements that shows that when one completes the next is started.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        controlFlowGUID - unique identifier of the control flow relationship
        properties - qualified name for this relationship and other related properties
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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​(java.lang.String userId,
                              java.lang.String infrastructureManagerGUID,
                              java.lang.String infrastructureManagerName,
                              java.lang.String controlFlowGUID,
                              java.util.Date effectiveTime)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Remove the control flow relationship between two elements.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        controlFlowGUID - unique identifier of the control flow relationship
        effectiveTime - time when the relationship is effective
        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

        java.util.List<ControlFlowElement> getControlFlowNextSteps​(java.lang.String userId,
                                                                   java.lang.String currentStepGUID,
                                                                   int startFrom,
                                                                   int pageSize,
                                                                   java.util.Date effectiveTime)
                                                            throws InvalidParameterException,
                                                                   UserNotAuthorizedException,
                                                                   PropertyServerException
        Retrieve the control relationships linked from a specific element to the possible next elements in the process.
        Parameters:
        userId - calling user
        currentStepGUID - unique identifier of the current step
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - effective time for the query
        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

        java.util.List<ControlFlowElement> getControlFlowPreviousSteps​(java.lang.String userId,
                                                                       java.lang.String currentStepGUID,
                                                                       int startFrom,
                                                                       int pageSize,
                                                                       java.util.Date effectiveTime)
                                                                throws InvalidParameterException,
                                                                       UserNotAuthorizedException,
                                                                       PropertyServerException
        Retrieve the control relationships linked from a specific element to the possible previous elements in the process.
        Parameters:
        userId - calling user
        currentStepGUID - unique identifier of the current step
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - effective time for the query
        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

        java.lang.String setupProcessCall​(java.lang.String userId,
                                          java.lang.String infrastructureManagerGUID,
                                          java.lang.String infrastructureManagerName,
                                          boolean infrastructureManagerIsHome,
                                          java.lang.String callerGUID,
                                          java.lang.String calledGUID,
                                          ProcessCallProperties properties,
                                          java.util.Date effectiveTime)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Link two elements together to show a request-response call between them.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        infrastructureManagerIsHome - ensure that only the infrastructure 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
        properties - qualified name for this relationship and other related properties
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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​(java.lang.String userId,
                                          java.lang.String callerGUID,
                                          java.lang.String calledGUID,
                                          java.lang.String qualifiedName,
                                          java.util.Date effectiveTime)
                                   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
        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
        effectiveTime - effective time for the query
        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​(java.lang.String userId,
                               java.lang.String infrastructureManagerGUID,
                               java.lang.String infrastructureManagerName,
                               java.lang.String processCallGUID,
                               ProcessCallProperties properties,
                               java.util.Date effectiveTime)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
        Update the relationship between two elements that shows a request-response call between them.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        processCallGUID - unique identifier of the process call relationship
        properties - qualified name for this relationship and other related properties
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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​(java.lang.String userId,
                              java.lang.String infrastructureManagerGUID,
                              java.lang.String infrastructureManagerName,
                              java.lang.String processCallGUID,
                              java.util.Date effectiveTime)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Remove the process call relationship.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        processCallGUID - unique identifier of the process call relationship
        effectiveTime - time when the relationship is effective
        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

        java.util.List<ProcessCallElement> getProcessCalled​(java.lang.String userId,
                                                            java.lang.String callerGUID,
                                                            int startFrom,
                                                            int pageSize,
                                                            java.util.Date effectiveTime)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException
        Retrieve the process call relationships linked from a specific element to the elements it calls.
        Parameters:
        userId - calling user
        callerGUID - unique identifier of the element that is making the call
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - effective time for the query
        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

        java.util.List<ProcessCallElement> getProcessCallers​(java.lang.String userId,
                                                             java.lang.String calledGUID,
                                                             int startFrom,
                                                             int pageSize,
                                                             java.util.Date effectiveTime)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException
        Retrieve the process call relationships linked from a specific element to its callers.
        Parameters:
        userId - calling user
        calledGUID - unique identifier of the element that is processing the call
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - effective time for the query
        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

        java.lang.String setupLineageMapping​(java.lang.String userId,
                                             java.lang.String sourceElementGUID,
                                             java.lang.String destinationElementGUID,
                                             LineageMappingProperties properties,
                                             java.util.Date effectiveTime)
                                      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
        sourceElementGUID - unique identifier of the source
        destinationElementGUID - unique identifier of the destination
        properties - properties of the relationship and effectivity dates
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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)
      • getLineageMapping

        LineageMappingElement getLineageMapping​(java.lang.String userId,
                                                java.lang.String sourceElementGUID,
                                                java.lang.String destinationElementGUID,
                                                java.lang.String qualifiedName,
                                                java.util.Date effectiveTime)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException
        Retrieve the lineage mapping relationship between two elements. The qualifiedName is optional unless there is more than one lineage mapping relationship between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.
        Parameters:
        userId - calling user
        sourceElementGUID - unique identifier of the source
        destinationElementGUID - unique identifier of the destination
        qualifiedName - unique identifier for this relationship
        effectiveTime - effective time for the query
        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)
      • updateLineageMapping

        void updateLineageMapping​(java.lang.String userId,
                                  java.lang.String infrastructureManagerGUID,
                                  java.lang.String infrastructureManagerName,
                                  java.lang.String lineageMappingGUID,
                                  LineageMappingProperties properties,
                                  java.util.Date effectiveTime)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Update the lineage mapping relationship between two elements.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the caller
        infrastructureManagerName - unique name of software server capability representing the caller
        lineageMappingGUID - unique identifier of the relationship
        properties - qualified name for this relationship and other related properties
        effectiveTime - optional date for effective time of the query. Null means any effective time
        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

        java.util.List<LineageMappingElement> getDestinationLineageMappings​(java.lang.String userId,
                                                                            java.lang.String sourceElementGUID,
                                                                            int startFrom,
                                                                            int pageSize,
                                                                            java.util.Date effectiveTime)
                                                                     throws InvalidParameterException,
                                                                            UserNotAuthorizedException,
                                                                            PropertyServerException
        Retrieve the lineage mapping relationships linked from a specific source element to its destinations.
        Parameters:
        userId - calling user
        sourceElementGUID - unique identifier of the source
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - effective time for the query
        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

        java.util.List<LineageMappingElement> getSourceLineageMappings​(java.lang.String userId,
                                                                       java.lang.String destinationElementGUID,
                                                                       int startFrom,
                                                                       int pageSize,
                                                                       java.util.Date effectiveTime)
                                                                throws InvalidParameterException,
                                                                       UserNotAuthorizedException,
                                                                       PropertyServerException
        Retrieve the lineage mapping relationships linked from a specific destination element to its sources.
        Parameters:
        userId - calling user
        destinationElementGUID - unique identifier of the destination
        startFrom - paging start point
        pageSize - maximum results that can be returned
        effectiveTime - effective time for the query
        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)