Package org.odpi.openmetadata.accessservices.assetmanager.handlers

Class ProcessExchangeHandler

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.handlers.ProcessExchangeHandler

public class ProcessExchangeHandler
extends Object

ProcessExchangeHandler is the server-side for managing processes.

Constructor Summary

Constructors

Constructor	Description
ProcessExchangeHandler(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 process exchange handler with information needed to work with process related objects for Asset Manager OMAS.

Method Summary

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProcessExchangeHandler

public ProcessExchangeHandler(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 process exchange handler with information needed to work with process related objects for Asset Manager OMAS.

Parameters:

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 instances from.

defaultZones - list of zones that the access service should set in all new instances.

publishZones - list of zones that the access service sets up in published instances.

auditLog - destination for audit log events.

Method Detail

createProcess

public String createProcess(String userId,
                            MetadataCorrelationProperties correlationProperties,
                            boolean assetManagerIsHome,
                            ProcessProperties processProperties,
                            ProcessStatus processStatus,
                            Date effectiveTime,
                            String methodName)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Create a new metadata element to represent a process.

Parameters:

userId - calling user

correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata

assetManagerIsHome - ensure that only the process manager can update this process

processProperties - properties about the process to store

processStatus - initial status of the process

effectiveTime - optional date for effective time of the query. Null means any effective time

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,
                                        MetadataCorrelationProperties correlationProperties,
                                        boolean assetManagerIsHome,
                                        String templateGUID,
                                        TemplateProperties templateProperties,
                                        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

correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata

assetManagerIsHome - ensure that only the process manager can update this process

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

effectiveTime - optional date for effective time of the query. Null means any effective time

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,
                          MetadataCorrelationProperties correlationProperties,
                          String processGUID,
                          boolean isMergeUpdate,
                          ProcessProperties processProperties,
                          boolean forLineage,
                          boolean forDuplicateProcessing,
                          Date effectiveTime,
                          String methodName)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Update the metadata element representing a process.

Parameters:

userId - calling user

correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata

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

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,
                                MetadataCorrelationProperties correlationProperties,
                                String processGUID,
                                ProcessStatus processStatus,
                                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

correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata

processGUID - unique identifier of the process to update

processStatus - new status for the 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)

setupProcessParent

public void setupProcessParent(String userId,
                               String assetManagerGUID,
                               String assetManagerName,
                               boolean assetManagerIsHome,
                               String parentProcessGUID,
                               String childProcessGUID,
                               ProcessContainmentType containmentType,
                               Date effectiveFrom,
                               Date effectiveTo,
                               boolean forLineage,
                               boolean forDuplicateProcessing,
                               Date effectiveTime,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Create a parent-child relationship between two processes.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the process manager can update this process

parentProcessGUID - unique identifier of the process in the external process manager that is to be the parent process

childProcessGUID - unique identifier of the process in the external process manager that is to be the nested sub-process

containmentType - describes the ownership of the sub-process

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)

clearProcessParent

public void clearProcessParent(String userId,
                               String assetManagerGUID,
                               String assetManagerName,
                               String parentProcessGUID,
                               String childProcessGUID,
                               boolean forLineage,
                               boolean forDuplicateProcessing,
                               Date effectiveTime,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Remove a parent-child relationship between two processes.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

parentProcessGUID - unique identifier of the process in the external process manager that is to be the parent process

childProcessGUID - unique identifier of the process in the external process manager that is to be the nested 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)

publishProcess

public void publishProcess(String userId,
                           String processGUID,
                           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

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,
                            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. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Asset Manager OMAS. This is the setting when the process is first created).

Parameters:

userId - calling user

processGUID - unique identifier of the metadata element to withdraw

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,
                          MetadataCorrelationProperties correlationProperties,
                          String processGUID,
                          boolean forLineage,
                          boolean forDuplicateProcessing,
                          Date effectiveTime,
                          String methodName)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Remove the metadata element representing a process.

Parameters:

userId - calling user

correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata

processGUID - unique identifier of the metadata element to remove

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<ProcessElement> findProcesses(String userId,
                                          String assetManagerGUID,
                                          String assetManagerName,
                                          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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

searchString - string to find in the properties

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)

getProcessesForAssetManager

public List<ProcessElement> getProcessesForAssetManager(String userId,
                                                        String assetManagerGUID,
                                                        String assetManagerName,
                                                        int startFrom,
                                                        int pageSize,
                                                        boolean forLineage,
                                                        boolean forDuplicateProcessing,
                                                        Date effectiveTime,
                                                        String methodName)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Return the list of processes associated with the process manager.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

startFrom - paging start point

pageSize - maximum results that can be returned

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 metadata elements describing the processes associated with the requested process 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

public List<ProcessElement> getProcessesByName(String userId,
                                               String assetManagerGUID,
                                               String assetManagerName,
                                               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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

name - name to search for

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 ProcessElement getProcessByGUID(String userId,
                                       String assetManagerGUID,
                                       String assetManagerName,
                                       String processGUID,
                                       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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

processGUID - unique identifier of the requested metadata element

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 ProcessElement getProcessParent(String userId,
                                       String assetManagerGUID,
                                       String assetManagerName,
                                       String processGUID,
                                       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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

processGUID - unique identifier of the requested metadata element

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<ProcessElement> getSubProcesses(String userId,
                                            String assetManagerGUID,
                                            String assetManagerName,
                                            String processGUID,
                                            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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

processGUID - unique identifier of the requested metadata element

startFrom - paging start point

pageSize - maximum results that can be returned

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,
                         MetadataCorrelationProperties correlationProperties,
                         boolean assetManagerIsHome,
                         String processGUID,
                         PortProperties portProperties,
                         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

correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata

assetManagerIsHome - ensure that only the process manager can update this port

processGUID - unique identifier of the process where the port is located

portProperties - properties for the port

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,
                       MetadataCorrelationProperties correlationProperties,
                       String portGUID,
                       PortProperties portProperties,
                       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

correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata

portGUID - unique identifier of the port to update

portProperties - new properties for the port

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 assetManagerGUID,
                             String assetManagerName,
                             boolean assetManagerIsHome,
                             String processGUID,
                             String portGUID,
                             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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the process manager can update this process

processGUID - unique identifier of the process

portGUID - unique identifier of the port

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 assetManagerGUID,
                             String assetManagerName,
                             String processGUID,
                             String portGUID,
                             boolean forLineage,
                             boolean forDuplicateProcessing,
                             Date effectiveTime,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Unlink a port from a process.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

processGUID - unique identifier of the process

portGUID - unique identifier of the port

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 assetManagerGUID,
                                String assetManagerName,
                                boolean assetManagerIsHome,
                                String portOneGUID,
                                String portTwoGUID,
                                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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the process manager can update this process

portOneGUID - unique identifier of the port at end 1

portTwoGUID - unique identifier of the port at end 2

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 assetManagerGUID,
                                String assetManagerName,
                                String portOneGUID,
                                String portTwoGUID,
                                boolean forLineage,
                                boolean forDuplicateProcessing,
                                Date effectiveTime,
                                String methodName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Remove the port delegation relationship between two ports.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

portOneGUID - unique identifier of the port at end 1

portTwoGUID - unique identifier of the port at end 2

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 assetManagerGUID,
                                String assetManagerName,
                                boolean assetManagerIsHome,
                                String portGUID,
                                String schemaTypeGUID,
                                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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the process manager can update this process

portGUID - unique identifier of the port

schemaTypeGUID - unique identifier of the schemaType

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 assetManagerGUID,
                                String assetManagerName,
                                String portGUID,
                                String schemaTypeGUID,
                                boolean forLineage,
                                boolean forDuplicateProcessing,
                                Date effectiveTime,
                                String methodName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Remove the schema type from a port.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

portGUID - unique identifier of the port

schemaTypeGUID - unique identifier of the schemaType

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,
                       MetadataCorrelationProperties correlationProperties,
                       String portGUID,
                       boolean forLineage,
                       boolean forDuplicateProcessing,
                       Date effectiveTime,
                       String methodName)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

Remove the metadata element representing a port.

Parameters:

userId - calling user

correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata

portGUID - unique identifier of the metadata element to remove

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<PortElement> findPorts(String userId,
                                   String assetManagerGUID,
                                   String assetManagerName,
                                   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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

searchString - string to find in the properties

searchStringParameterName - parameter supplying search string

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<PortElement> getPortsForProcess(String userId,
                                            String assetManagerGUID,
                                            String assetManagerName,
                                            String processGUID,
                                            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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

processGUID - unique identifier of the process of interest

startFrom - paging start point

pageSize - maximum results that can be returned

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<PortElement> getPortUse(String userId,
                                    String assetManagerGUID,
                                    String assetManagerName,
                                    String portGUID,
                                    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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

portGUID - unique identifier of the starting port

startFrom - paging start point

pageSize - maximum results that can be returned

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 PortElement getPortDelegation(String userId,
                                     String assetManagerGUID,
                                     String assetManagerName,
                                     String portGUID,
                                     boolean forLineage,
                                     boolean forDuplicateProcessing,
                                     Date effectiveTime,
                                     String methodName)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Retrieve the port that this port delegates to.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

portGUID - unique identifier of the starting port alias

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<PortElement> getPortsByName(String userId,
                                        String assetManagerGUID,
                                        String assetManagerName,
                                        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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

name - name to search for

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 PortElement getPortByGUID(String userId,
                                 String assetManagerGUID,
                                 String assetManagerName,
                                 String portGUID,
                                 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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

portGUID - unique identifier of the requested metadata element

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)

setBusinessSignificant

public void setBusinessSignificant(String userId,
                                   MetadataCorrelationProperties correlationProperties,
                                   String elementGUID,
                                   boolean forLineage,
                                   boolean forDuplicateProcessing,
                                   Date effectiveTime,
                                   String methodName)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Classify a port, process or process as "BusinessSignificant" (this may affect the way that lineage is displayed).

Parameters:

userId - calling user

correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata

elementGUID - unique identifier of the metadata element to update

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)

clearBusinessSignificant

public void clearBusinessSignificant(String userId,
                                     MetadataCorrelationProperties correlationProperties,
                                     String elementGUID,
                                     boolean forLineage,
                                     boolean forDuplicateProcessing,
                                     Date effectiveTime,
                                     String methodName)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Remove the "BusinessSignificant" designation from the element.

Parameters:

userId - calling user

correlationProperties - properties to help with the mapping of the elements in the external asset manager and open metadata

elementGUID - unique identifier of the metadata element to update

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)

setupDataFlow

public String setupDataFlow(String userId,
                            String assetManagerGUID,
                            String assetManagerName,
                            boolean assetManagerIsHome,
                            String dataSupplierGUID,
                            String dataConsumerGUID,
                            String qualifiedName,
                            String description,
                            String formula,
                            Date effectiveFrom,
                            Date effectiveTo,
                            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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the process manager can update this process

dataSupplierGUID - unique identifier of the data supplier

dataConsumerGUID - unique identifier of the data consumer

qualifiedName - unique identifier for this relationship

description - description and/or purpose of the data flow

formula - function that determines the subset of the data that flows

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 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 DataFlowElement getDataFlow(String userId,
                                   String dataSupplierGUID,
                                   String dataConsumerGUID,
                                   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

dataConsumerGUID - unique identifier of the data consumer

qualifiedName - unique identifier for this relationship

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)

updateDataFlow

public void updateDataFlow(String userId,
                           String assetManagerGUID,
                           String assetManagerName,
                           String dataFlowGUID,
                           String qualifiedName,
                           String description,
                           String formula,
                           Date effectiveFrom,
                           Date effectiveTo,
                           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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

dataFlowGUID - unique identifier of the data flow relationship

qualifiedName - unique identifier for this relationship

description - description and/or purpose of the data flow

formula - function that determines the subset of the data that flows

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)

clearDataFlow

public void clearDataFlow(String userId,
                          String assetManagerGUID,
                          String assetManagerName,
                          String dataFlowGUID,
                          boolean forLineage,
                          boolean forDuplicateProcessing,
                          Date effectiveTime,
                          String methodName)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Remove the data flow relationship between two elements.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

dataFlowGUID - unique identifier of the data flow relationship

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<DataFlowElement> getDataFlowConsumers(String userId,
                                                  String dataSupplierGUID,
                                                  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

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<DataFlowElement> getDataFlowSuppliers(String userId,
                                                  String dataConsumerGUID,
                                                  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

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 assetManagerGUID,
                               String assetManagerName,
                               boolean assetManagerIsHome,
                               String currentStepGUID,
                               String nextStepGUID,
                               String qualifiedName,
                               String description,
                               String guard,
                               Date effectiveFrom,
                               Date effectiveTo,
                               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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the process manager can update this process

currentStepGUID - unique identifier of the previous step

nextStepGUID - unique identifier of the next step

qualifiedName - unique identifier for this relationship

description - description and/or purpose of the control flow

guard - function that must be true to travel down this control flow

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 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 ControlFlowElement getControlFlow(String userId,
                                         String currentStepGUID,
                                         String nextStepGUID,
                                         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

nextStepGUID - unique identifier of the next step

qualifiedName - unique identifier for this relationship

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 assetManagerGUID,
                              String assetManagerName,
                              String controlFlowGUID,
                              String qualifiedName,
                              String description,
                              String guard,
                              Date effectiveFrom,
                              Date effectiveTo,
                              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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

controlFlowGUID - unique identifier of the control flow relationship

qualifiedName - unique identifier for this relationship

description - description and/or purpose of the control flow

guard - function that must be true to travel down this control flow

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)

clearControlFlow

public void clearControlFlow(String userId,
                             String assetManagerGUID,
                             String assetManagerName,
                             String controlFlowGUID,
                             boolean forLineage,
                             boolean forDuplicateProcessing,
                             Date effectiveTime,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Remove the control flow relationship between two elements.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

controlFlowGUID - unique identifier of the control flow relationship

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<ControlFlowElement> getControlFlowNextSteps(String userId,
                                                        String currentStepGUID,
                                                        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

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<ControlFlowElement> getControlFlowPreviousSteps(String userId,
                                                            String currentStepGUID,
                                                            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

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 assetManagerGUID,
                               String assetManagerName,
                               boolean assetManagerIsHome,
                               String callerGUID,
                               String calledGUID,
                               String qualifiedName,
                               String description,
                               String formula,
                               Date effectiveFrom,
                               Date effectiveTo,
                               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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

assetManagerIsHome - ensure that only the process manager can update this process

callerGUID - unique identifier of the element that is making the call

calledGUID - unique identifier of the element that is processing the call

qualifiedName - unique identifier for this relationship

description - description and/or purpose of the process call

formula - function that describes the function performed

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 ProcessCallElement getProcessCall(String userId,
                                         String callerGUID,
                                         String calledGUID,
                                         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

calledGUID - unique identifier of the element that is processing the call

qualifiedName - unique identifier for this relationship

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 assetManagerGUID,
                              String assetManagerName,
                              String processCallGUID,
                              String qualifiedName,
                              String description,
                              String formula,
                              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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

processCallGUID - unique identifier of the process call relationship

qualifiedName - unique identifier for this relationship

description - description and/or purpose of the data flow

formula - function that describes the function performed

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)

clearProcessCall

public void clearProcessCall(String userId,
                             String assetManagerGUID,
                             String assetManagerName,
                             String processCallGUID,
                             boolean forLineage,
                             boolean forDuplicateProcessing,
                             Date effectiveTime,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Remove the process call relationship.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

processCallGUID - unique identifier of the process call relationship

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<ProcessCallElement> getProcessCalled(String userId,
                                                 String callerGUID,
                                                 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

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<ProcessCallElement> getProcessCallers(String userId,
                                                  String calledGUID,
                                                  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

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 void setupLineageMapping(String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String sourceElementGUID,
                                String destinationElementGUID,
                                String qualifiedName,
                                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

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

sourceElementGUID - unique identifier of the source

destinationElementGUID - unique identifier of the destination

qualifiedName - unique identifier for this 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

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 LineageMappingElement getLineageMapping(String userId,
                                               String sourceElementGUID,
                                               String destinationElementGUID,
                                               String qualifiedName,
                                               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

destinationElementGUID - unique identifier of the destination

qualifiedName - unique identifier for this relationship

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:

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 assetManagerGUID,
                                 String assetManagerName,
                                 String lineageMappingGUID,
                                 String qualifiedName,
                                 String description,
                                 Date effectiveFrom,
                                 Date effectiveTo,
                                 boolean forLineage,
                                 boolean forDuplicateProcessing,
                                 Date effectiveTime,
                                 String methodName)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Remove the lineage mapping between two elements.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

lineageMappingGUID - unique identifier of the process call relationship

qualifiedName - unique identifier for this 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

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 assetManagerGUID,
                                String assetManagerName,
                                String lineageMappingGUID,
                                boolean forLineage,
                                boolean forDuplicateProcessing,
                                Date effectiveTime,
                                String methodName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Remove the lineage mapping between two elements.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software server capability representing the caller

assetManagerName - unique name of software server capability representing the caller

lineageMappingGUID - unique identifier of the lineage mapping relationship

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<LineageMappingElement> getDestinationLineageMappings(String userId,
                                                                 String sourceElementGUID,
                                                                 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

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 mapping 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)

getSourceLineageMappings

public List<LineageMappingElement> getSourceLineageMappings(String userId,
                                                            String destinationElementGUID,
                                                            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

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 mapping 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)