Class ProcessHandler<PROCESS,PORT,DATA_FLOW,CONTROL_FLOW,PROCESS_CALL,LINEAGE_MAPPING>


public class ProcessHandler<PROCESS,PORT,DATA_FLOW,CONTROL_FLOW,PROCESS_CALL,LINEAGE_MAPPING> extends ReferenceableHandler<PROCESS>
ProcessHandler provides the methods to create and maintain processes and their contents. It does not currently support effectivity dates - but probably should.
  • Constructor Details

    • ProcessHandler

      public ProcessHandler(OpenMetadataAPIGenericConverter<PROCESS> converter, Class<PROCESS> beanClass, OpenMetadataAPIGenericConverter<PORT> portConverter, Class<PORT> portBeanClass, OpenMetadataAPIGenericConverter<DATA_FLOW> dataFlowConverter, Class<DATA_FLOW> dataFlowBeanClass, OpenMetadataAPIGenericConverter<CONTROL_FLOW> controlFlowConverter, Class<CONTROL_FLOW> controlFlowBeanClass, OpenMetadataAPIGenericConverter<PROCESS_CALL> processCallConverter, Class<PROCESS_CALL> processCallBeanClass, OpenMetadataAPIGenericConverter<LINEAGE_MAPPING> lineageMappingConverter, Class<LINEAGE_MAPPING> lineageMappingClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)
      Construct the handler information needed to interact with the repository services
      Parameters:
      converter - specific converter for the PROCESS bean class
      beanClass - name of bean class that is represented by the generic class PROCESS
      portConverter - specific converter for the PORT bean class
      portBeanClass - name of bean class that is represented by the generic class PORT
      dataFlowConverter - specific converter for the DATA_FLOW bean class
      dataFlowBeanClass - name of bean class that is represented by the generic class DATA_FLOW
      controlFlowConverter - specific converter for the CONTROL_FLOW bean class
      controlFlowBeanClass - name of bean class that is represented by the generic class CONTROL_FLOW
      processCallConverter - specific converter for the PROCESS_CALL bean class
      processCallBeanClass - name of bean class that is represented by the generic class PROCESS_CALL
      lineageMappingConverter - specific converter for the LINEAGE_MAPPING bean class
      lineageMappingClass - name of bean class that is represented by the generic class LINEAGE_MAPPING
      serviceName - name of this service
      serverName - name of the local server
      invalidParameterHandler - handler for managing parameter errors
      repositoryHandler - manages calls to the repository services
      repositoryHelper - provides utilities for manipulating the repository services objects
      localServerUserId - userId for this server
      securityVerifier - open metadata security services verifier
      supportedZones - list of zones that the access service is allowed to serve Asset instances from.
      defaultZones - list of zones that the access service should set in all new Asset instances.
      publishZones - list of zones that the access service sets up in published Asset instances.
      auditLog - destination for audit log events.
  • Method Details

    • createProcess

      public String createProcess(String userId, String externalSourceGUID, String externalSourceName, String qualifiedName, String name, String resourceName, String versionIdentifier, String technicalDescription, String deployedImplementationType, String formula, String formulaType, String implementationLanguage, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> suppliedExtendedProperties, InstanceStatus initialStatus, Date effectiveFrom, Date effectiveTo, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create a new metadata element to represent a process.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      qualifiedName - unique name for this asset
      name - the short name property for the process
      resourceName - the full name property for the process
      versionIdentifier - the stored version identifier property for the process
      technicalDescription - the stored description property associated with the process
      deployedImplementationType - technology type
      formula - the formula that characterize the processing behavior of the process
      formulaType - the language of the formula
      implementationLanguage - the implementation language used to create the process
      additionalProperties - any arbitrary properties not part of the type system
      suppliedTypeName - name of the type that is a subtype of asset - or null to create standard type
      suppliedExtendedProperties - properties from any subtype
      initialStatus - status value for the new process (default = ACTIVE)
      effectiveFrom - starting time for this relationship (null for all time)
      effectiveTo - ending time for this relationship (null for all time)
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public String createProcessFromTemplate(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, String templateGUIDParameterName, String qualifiedName, String qualifiedNameParameterName, String technicalName, String versionIdentifier, String description, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      templateGUID - unique identifier of the metadata element to copy
      templateGUIDParameterName - parameter supplying templateGUID
      qualifiedName - unique name for the term - used in other configuration
      qualifiedNameParameterName - parameter supplying qualifiedName
      technicalName - short name for the process
      versionIdentifier - version identifier for the process
      description - description of the process
      forLineage - the request is to support lineage retrieval this means entities with the Memento classification can be returned
      forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void updateProcess(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, boolean isMergeUpdate, String qualifiedName, String name, String resourceName, String versionIdentifier, String technicalDescription, String deployedImplementationType, String formula, String implementationLanguage, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> suppliedExtendedProperties, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update the metadata element representing a process.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      processGUID - unique identifier of the metadata element to update
      processGUIDParameterName - unique identifier of the process in the external process manager
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      qualifiedName - unique name for this asset
      name - the display name property for the process
      resourceName - the full name property for the process
      versionIdentifier - version identifier for the process
      technicalDescription - the stored description property associated with the process
      deployedImplementationType - technology type
      formula - the formula that characterize the processing behavior of the process
      implementationLanguage - the implementation language used to create the process
      additionalProperties - any arbitrary properties not part of the type system
      suppliedTypeName - name of the type that is a subtype of asset - or null to create standard type
      suppliedExtendedProperties - properties from any subtype
      effectiveFrom - time when this process becomes visible to queries - null for any time
      effectiveTo - time when this process stops being visible to queries - null for never
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void updateProcessStatus(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, InstanceStatus processStatus, String processStatusParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update the status of the metadata element representing a process.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      processGUID - unique identifier of the process to update
      processGUIDParameterName - unique identifier of the process in the external process manager
      processStatus - new status for the process
      processStatusParameterName - parameter supplying processStatus
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void setupProcessParent(String userId, String externalSourceGUID, String externalSourceName, String parentProcessGUID, String parentProcessGUIDParameterName, String childProcessGUID, String childProcessGUIDParameterName, Date effectiveFrom, Date effectiveTo, int containmentType, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create a parent-child relationship between two processes.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      parentProcessGUID - unique identifier of the process in the external process manager that is to be the parent process
      parentProcessGUIDParameterName - parameter supplying parentProcessGUID
      childProcessGUID - unique identifier of the process in the external process manager that is to be the nested sub-process
      childProcessGUIDParameterName - parameter supplying childProcessGUID
      effectiveFrom - the date when this element is active - null for active now
      effectiveTo - the date when this element becomes inactive - null for active until deleted
      containmentType - describes the ownership of the sub-process
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void clearProcessParent(String userId, String externalSourceGUID, String externalSourceName, String parentProcessGUID, String parentProcessGUIDParameterName, String childProcessGUID, String childProcessGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove a parent-child relationship between two processes.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      parentProcessGUID - unique identifier of the process in the external process manager that is to be the parent process
      parentProcessGUIDParameterName - parameter supplying parentProcessGUID
      childProcessGUID - unique identifier of the process in the external process manager that is to be the nested sub-process
      childProcessGUIDParameterName - parameter supplying childProcessGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void publishProcess(String userId, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update the zones for the process 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
      processGUID - unique identifier of the metadata element to publish
      processGUIDParameterName - parameter supplying processGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void withdrawProcess(String userId, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update the zones for the process so that it is no longer visible to consumers.
      Parameters:
      userId - calling user
      processGUID - unique identifier of the metadata element to withdraw
      processGUIDParameterName - parameter supplying processGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void removeProcess(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the metadata element representing a process.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      processGUID - unique identifier of the metadata element to remove
      processGUIDParameterName - unique identifier of the process in the external process manager
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public List<PROCESS> findProcesses(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      searchStringParameterName - parameter supplying searchString
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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)
    • getProcessesByName

      public List<PROCESS> getProcessesByName(String userId, String name, String nameParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      nameParameterName - parameter supplying name
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public PROCESS getProcessByGUID(String userId, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      processGUIDParameterName - parameter supplying processGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public PROCESS getProcessParent(String userId, String processGUID, String processGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      processGUIDParameterName - parameter supplying processGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public List<PROCESS> getSubProcesses(String userId, String processGUID, String processGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      processGUIDParameterName - parameter supplying processGUID
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public String createPort(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, String qualifiedName, String displayName, int portType, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Create a new metadata element to represent a port.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      processGUID - unique identifier of the process where the port is located
      processGUIDParameterName - parameter supplying processGUID
      qualifiedName - unique name for the port - used in other configuration
      displayName - short display name for the port
      portType - description of the port
      additionalProperties - additional properties for a port
      suppliedTypeName - type name from the caller (enables creation of subtypes)
      extendedProperties - properties for a port subtype
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void updatePort(String userId, String externalSourceGUID, String externalSourceName, String portGUID, String portGUIDParameterName, String qualifiedName, String displayName, int portType, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      portGUID - unique identifier of the port to update
      portGUIDParameterName - parameter supplying portGUID
      qualifiedName - unique name for the port - used in other configuration
      displayName - short display name for the port
      portType - description of the port
      additionalProperties - additional properties for a port
      suppliedTypeName - type name from the caller (enables creation of subtypes)
      extendedProperties - properties for a port subtype
      effectiveFrom - the date when this element is active - null for active now
      effectiveTo - the date when this element becomes inactive - null for active until deleted
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void setupProcessPort(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, String portGUID, String portGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Link a port to a process.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      processGUID - unique identifier of the process
      processGUIDParameterName - parameter supplying processGUID
      portGUID - unique identifier of the port
      portGUIDParameterName - parameter supplying portGUID
      effectiveFrom - the date when this element is active - null for active now
      effectiveTo - the date when this element becomes inactive - null for active until deleted
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void clearProcessPort(String userId, String externalSourceGUID, String externalSourceName, String processGUID, String processGUIDParameterName, String portGUID, String portGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Unlink a port from a process.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      processGUID - unique identifier of the process
      processGUIDParameterName - parameter supplying processGUID
      portGUID - unique identifier of the port
      portGUIDParameterName - parameter supplying portGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void setupPortDelegation(String userId, String externalSourceGUID, String externalSourceName, String portOneGUID, String portOneGUIDParameterName, String portTwoGUID, String portTwoGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      portOneGUID - unique identifier of the port at end 1
      portOneGUIDParameterName - parameter supplying portOneGUID
      portTwoGUID - unique identifier of the port at end 2
      portTwoGUIDParameterName - parameter supplying portTwoGUID
      effectiveFrom - the date when this element is active - null for active now
      effectiveTo - the date when this element becomes inactive - null for active until deleted
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void clearPortDelegation(String userId, String externalSourceGUID, String externalSourceName, String portOneGUID, String portOneGUIDParameterName, String portTwoGUID, String portTwoGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the port delegation relationship between two ports.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      portOneGUID - unique identifier of the port at end 1
      portOneGUIDParameterName - parameter supplying portOneGUID
      portTwoGUID - unique identifier of the port at end 2
      portTwoGUIDParameterName - parameter supplying portTwoGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void setupPortSchemaType(String userId, String externalSourceGUID, String externalSourceName, String portGUID, String portGUIDParameterName, String schemaTypeGUID, String schemaTypeGUIDParameterName, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Link a schema type to a port to show the structure of data it accepts.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      portGUID - unique identifier of the port
      portGUIDParameterName - parameter supplying portGUID
      schemaTypeGUID - unique identifier of the schemaType
      schemaTypeGUIDParameterName - parameter supplying schemaTypeGUID
      effectiveFrom - the date when this element is active - null for active now
      effectiveTo - the date when this element becomes inactive - null for active until deleted
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void clearPortSchemaType(String userId, String externalSourceGUID, String externalSourceName, String portGUID, String portGUIDParameterName, String schemaTypeGUID, String schemaTypeGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the schema type from a port.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      portGUID - unique identifier of the port
      portGUIDParameterName - parameter supplying portGUID
      schemaTypeGUID - unique identifier of the schemaType
      schemaTypeGUIDParameterName - parameter supplying schemaTypeGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void removePort(String userId, String externalSourceGUID, String externalSourceName, String portGUID, String portGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the metadata element representing a port.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      portGUID - unique identifier of the metadata element to remove
      portGUIDParameterName - parameter supplying portGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public List<PORT> findPorts(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      searchString - string to find in the properties
      searchStringParameterName - parameter supplying searchString
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public List<PORT> getPortsForProcess(String userId, String processGUID, String processGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the list of ports associated with a process.
      Parameters:
      userId - calling user
      processGUID - unique identifier of the process of interest
      processGUIDParameterName - parameter passing processGUID
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public List<PORT> getPortUse(String userId, String portGUID, String portGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the list of ports that delegate to this port.
      Parameters:
      userId - calling user
      portGUID - unique identifier of the starting port
      portGUIDParameterName - parameter passing portGUID
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public PORT getPortDelegation(String userId, String portGUID, String portGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the port that this port delegates to.
      Parameters:
      userId - calling user
      portGUID - unique identifier of the starting port alias
      portGUIDParameterName - parameter passing portGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public List<PORT> getPortsByName(String userId, String name, String nameParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      name - name to search for
      nameParameterName - parameter supplying name
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public PORT getPortByGUID(String userId, String portGUID, String portGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the port metadata element with the supplied unique identifier.
      Parameters:
      userId - calling user
      portGUID - unique identifier of the requested metadata element
      portGUIDParameterName - parameter passing portGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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)
    • setupDataFlow

      public String setupDataFlow(String userId, String externalSourceGUID, String externalSourceName, String dataSupplierGUID, String dataSupplierGUIDParameterName, String dataConsumerGUID, String dataConsumerGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String formula, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Link two elements together to show that data flows from one to the other.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      dataSupplierGUID - unique identifier of the data supplier
      dataSupplierGUIDParameterName - parameter supplying dataSupplierGUID
      dataConsumerGUID - unique identifier of the data consumer
      dataConsumerGUIDParameterName - parameter supplying dataConsumerGUID
      effectiveFrom - the date when this element is active - null for active now
      effectiveTo - the date when this element becomes inactive - null for active until deleted
      qualifiedName - unique identifier for the information supply chain
      label - label for the visualization of the relationship
      description - description and/or purpose of the data flow
      formula - function that determines the subset of the data that flows
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public DATA_FLOW getDataFlow(String userId, String dataSupplierGUID, String dataSupplierGUIDParameterName, String dataConsumerGUID, String dataConsumerGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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.
      Parameters:
      userId - calling user
      dataSupplierGUID - unique identifier of the data supplier
      dataSupplierGUIDParameterName - parameter supplying dataSupplierGUID
      dataConsumerGUID - unique identifier of the data consumer
      dataConsumerGUIDParameterName - parameter supplying dataConsumerGUID
      qualifiedName - unique identifier for the information supply chain
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - time when the relationship is effective
      methodName - calling method
      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

      public void updateDataFlow(String userId, String externalSourceGUID, String externalSourceName, String dataFlowGUID, String dataFlowGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String formula, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update relationship between two elements that shows that data flows from one to the other.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      dataFlowGUID - unique identifier of the data flow relationship
      dataFlowGUIDParameterName - parameter supplying dataFlowGUID
      effectiveFrom - the date when this element is active - null for active now
      effectiveTo - the date when this element becomes inactive - null for active until deleted
      qualifiedName - unique identifier for the information supply chain
      label - label for the visualization of the relationship
      description - description and/or purpose of the data flow
      formula - function that determines the subset of the data that flows
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void clearDataFlow(String userId, String externalSourceGUID, String externalSourceName, String dataFlowGUID, String dataFlowGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the data flow relationship between two elements.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      dataFlowGUID - unique identifier of the data flow relationship
      dataFlowGUIDParameterName - parameter supplying dataFlowGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public List<DATA_FLOW> getDataFlowConsumers(String userId, String dataSupplierGUID, String dataSupplierGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      dataSupplierGUIDParameterName - parameter supplying dataSupplierGUID
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public List<DATA_FLOW> getDataFlowSuppliers(String userId, String dataConsumerGUID, String dataConsumerGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      dataConsumerGUIDParameterName - parameter supplying dataConsumerGUID
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public String setupControlFlow(String userId, String externalSourceGUID, String externalSourceName, String currentStepGUID, String currentStepGUIDParameterName, String nextStepGUID, String nextStepGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String guard, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Link two elements to show that when one completes the next is started.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      currentStepGUID - unique identifier of the previous step
      currentStepGUIDParameterName - parameter supplying currentStepGUID
      nextStepGUID - unique identifier of the next step
      nextStepGUIDParameterName - parameter supplying nextStepGUID
      effectiveFrom - the date when this element is active - null for active now
      effectiveTo - the date when this element becomes inactive - null for active until deleted
      qualifiedName - unique identifier for the information supply chain
      label - label for the visualization of the relationship
      description - description and/or purpose of the control flow
      guard - function that must be true to travel down this control flow
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public CONTROL_FLOW getControlFlow(String userId, String currentStepGUID, String currentStepGUIDParameterName, String nextStepGUID, String nextStepGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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.
      Parameters:
      userId - calling user
      currentStepGUID - unique identifier of the previous step
      currentStepGUIDParameterName - parameter supplying currentStepGUID
      nextStepGUID - unique identifier of the next step
      nextStepGUIDParameterName - parameter supplying nextStepGUID
      qualifiedName - unique identifier for the information supply chain
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void updateControlFlow(String userId, String externalSourceGUID, String externalSourceName, String controlFlowGUID, String controlFlowGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String guard, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update the relationship between two elements that shows that when one completes the next is started.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      controlFlowGUID - unique identifier of the control flow relationship
      controlFlowGUIDParameterName - parameter supplying controlFlowGUID
      effectiveFrom - the date when this element is active - null for active now
      effectiveTo - the date when this element becomes inactive - null for active until deleted
      qualifiedName - unique identifier for the information supply chain
      label - label for the visualization of the relationship
      description - description and/or purpose of the control flow
      guard - function that must be true to travel down this control flow
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void clearControlFlow(String userId, String externalSourceGUID, String externalSourceName, String controlFlowGUID, String controlFlowGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the control flow relationship between two elements.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      controlFlowGUID - unique identifier of the control flow relationship
      controlFlowGUIDParameterName - parameter supplying controlFlowGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public List<CONTROL_FLOW> getControlFlowNextSteps(String userId, String currentStepGUID, String currentStepGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      currentStepGUIDParameterName - parameter supplying currentStepGUID
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public List<CONTROL_FLOW> getControlFlowPreviousSteps(String userId, String currentStepGUID, String currentStepGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      currentStepGUIDParameterName - parameter supplying currentStepGUID
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public String setupProcessCall(String userId, String externalSourceGUID, String externalSourceName, String callerGUID, String callerGUIDParameterName, String calledGUID, String calledGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String formula, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Link two elements together to show a request-response call between them.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      callerGUID - unique identifier of the element that is making the call
      callerGUIDParameterName - parameter supplying callerGUID
      calledGUID - unique identifier of the element that is processing the call
      calledGUIDParameterName - parameter supplying calledGUID
      qualifiedName - unique identifier for the information supply chain
      label - label for the visualization of the relationship
      description - description and/or purpose of the process call
      formula - function that determines the subset of the data that flows
      effectiveFrom - the date when this element is active - null for active now
      effectiveTo - the date when this element becomes inactive - null for active until deleted
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public PROCESS_CALL getProcessCall(String userId, String callerGUID, String callerGUIDParameterName, String calledGUID, String calledGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      callerGUIDParameterName - parameter supplying callerGUID
      calledGUID - unique identifier of the element that is processing the call
      calledGUIDParameterName - parameter supplying calledGUID
      qualifiedName - unique identifier for the information supply chain
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void updateProcessCall(String userId, String externalSourceGUID, String externalSourceName, String processCallGUID, String processCallGUIDParameterName, Date effectiveFrom, Date effectiveTo, String qualifiedName, String label, String description, String formula, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update the relationship between two elements that shows a request-response call between them.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      processCallGUID - unique identifier of the process call relationship
      processCallGUIDParameterName - parameter supplying processCallGUID
      effectiveFrom - the date when this element is active - null for active now
      effectiveTo - the date when this element becomes inactive - null for active until deleted
      qualifiedName - unique identifier for the information supply chain
      label - label for the visualization of the relationship
      description - description and/or purpose of the process call
      formula - function that determines the subset of the data that flows
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void clearProcessCall(String userId, String externalSourceGUID, String externalSourceName, String processCallGUID, String processCallGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the process call relationship.
      Parameters:
      userId - calling user
      externalSourceGUID - unique identifier of software capability representing the caller
      externalSourceName - unique name of software capability representing the caller
      processCallGUID - unique identifier of the process call relationship
      processCallGUIDParameterName - parameter supplying processCallGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public List<PROCESS_CALL> getProcessCalled(String userId, String callerGUID, String callerGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      callerGUIDParameterName - parameter supplying callerGUID
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public List<PROCESS_CALL> getProcessCallers(String userId, String calledGUID, String calledGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      calledGUIDParameterName - parameter supplying calledGUID
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public String setupLineageMapping(String userId, String sourceElementGUID, String sourceElementGUIDParameterName, String destinationElementGUID, String destinationElementGUIDParameterName, String qualifiedName, String label, String description, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Link to 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
      sourceElementGUIDParameterName - parameter supplying sourceElementGUID
      destinationElementGUID - unique identifier of the destination
      destinationElementGUIDParameterName - parameter supplying destinationElementGUID
      qualifiedName - unique identifier for the information supply chain
      label - label for the visualization of the relationship
      description - description and/or purpose of the mapping
      effectiveFrom - the date when this element is active - null for active now
      effectiveTo - the date when this element becomes inactive - null for active until deleted
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public LINEAGE_MAPPING getLineageMapping(String userId, String sourceElementGUID, String sourceElementGUIDParameterName, String destinationElementGUID, String destinationElementGUIDParameterName, String qualifiedName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Retrieve the lineage mapping relationship between two elements. The qualifiedName is optional unless there is more than one lineage mapping 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
      sourceElementGUID - unique identifier of the source
      sourceElementGUIDParameterName - parameter supplying sourceElementGUID
      destinationElementGUID - unique identifier of the destination
      destinationElementGUIDParameterName - parameter supplying destinationElementGUID
      qualifiedName - unique identifier for the information supply chain
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void updateLineageMapping(String userId, String lineageMappingGUID, String lineageMappingGUIDParameterName, String qualifiedName, String label, String description, Date effectiveFrom, Date effectiveTo, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Update the relationship between two elements that shows a request-response call between them.
      Parameters:
      userId - calling user
      lineageMappingGUID - unique identifier of the process call relationship
      lineageMappingGUIDParameterName - parameter supplying lineageMappingGUID
      effectiveFrom - the date when this element is active - null for active now
      effectiveTo - the date when this element becomes inactive - null for active until deleted
      qualifiedName - unique identifier for the information supply chain
      label - label for the visualization of the relationship
      description - description and/or purpose of the mapping
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public void clearLineageMapping(String userId, String lineageMappingGUID, String lineageMappingGUIDParameterName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
      Remove the lineage mapping relationship.
      Parameters:
      userId - calling user
      lineageMappingGUID - unique identifier of the lineage mapping relationship
      lineageMappingGUIDParameterName - parameter supplying lineageMappingGUID
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public List<LINEAGE_MAPPING> getDestinationLineageMappings(String userId, String sourceElementGUID, String sourceElementGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      sourceElementGUIDParameterName - parameter supplying sourceElementGUID
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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

      public List<LINEAGE_MAPPING> getSourceLineageMappings(String userId, String destinationElementGUID, String destinationElementGUIDParameterName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, String methodName) 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
      destinationElementGUIDParameterName - parameter supplying destinationElementGUID
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      methodName - calling method
      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)