Package org.odpi.openmetadata.frameworks.governanceaction.client

Interface GovernanceActionProcessInterface

All Known Implementing Classes:

GovernanceContextClient, GovernanceContextClient, GovernanceContextClientBase, OpenGovernanceClient, OpenGovernanceClient, OpenGovernanceClient, OpenGovernanceClient, OpenGovernanceClientBase, OpenGovernanceServiceClient, OpenGovernanceServiceClient

public interface GovernanceActionProcessInterface

GovernanceActionProcessInterface maintains Governance Action Processes and their Governance Action Process Steps.

Method Summary

Modifier and Type	Method	Description
String	createGovernanceActionProcess(String userId, GovernanceActionProcessProperties processProperties, ProcessStatus initialStatus)	Create a new metadata element to represent a governance action process.
String	createGovernanceActionProcessStep(String userId, GovernanceActionProcessStepProperties processStepProperties)	Create a new metadata element to represent a governance action process step.
List<GovernanceActionProcessElement>	findGovernanceActionProcesses(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of governance action process metadata elements that contain the search string.
List<GovernanceActionProcessStepElement>	findGovernanceActionProcessSteps(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of governance action process step metadata elements that contain the search string.
FirstGovernanceActionProcessStepElement	getFirstActionProcessStep(String userId, String processGUID)	Return the governance action process step that is the first step in a governance action process.
GovernanceActionProcessElement	getGovernanceActionProcessByGUID(String userId, String processGUID)	Retrieve the governance action process metadata element with the supplied unique identifier.
List<GovernanceActionProcessElement>	getGovernanceActionProcessesByName(String userId, String name, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of governance action process metadata elements with a matching qualified or display name.
GovernanceActionProcessGraph	getGovernanceActionProcessGraph(String userId, String processGUID, Date effectiveTime)	Retrieve the governance action process metadata element with the supplied unique identifier along with its process flow implementation.
GovernanceActionProcessStepElement	getGovernanceActionProcessStepByGUID(String userId, String processStepGUID)	Retrieve the governance action process step metadata element with the supplied unique identifier.
List<GovernanceActionProcessStepElement>	getGovernanceActionProcessStepsByName(String userId, String name, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of governance action process step metadata elements with a matching qualified or display name.
List<NextGovernanceActionProcessStepElement>	getNextGovernanceActionProcessSteps(String userId, String processStepGUID, int startFrom, int pageSize)	Return the list of next process step defined for the governance action process.
void	publishGovernanceActionProcess(String userId, String processGUID)	Update the zones for the asset so that it becomes visible to consumers.
void	removeFirstActionProcessStep(String userId, String processGUID)	Remove the link between a governance process and that governance action process step that defines its first step.
void	removeGovernanceActionProcess(String userId, String processGUID)	Remove the metadata element representing a governance action process.
void	removeGovernanceActionProcessStep(String userId, String processStepGUID)	Remove the metadata element representing a governance action process step.
void	removeNextActionProcessStep(String userId, String processStepLinkGUID)	Remove a follow-on step from a governance action process.
void	setupFirstActionProcessStep(String userId, String processGUID, String processStepGUID, String guard)	Set up a link between a governance action process and a governance action process step.
String	setupNextActionProcessStep(String userId, String currentActionProcessStepGUID, String nextActionProcessStepGUID, String guard, boolean mandatoryGuard)	Add a link between two governance action process steps to show that one follows on from the other when a governance action process is executing.
void	updateGovernanceActionProcess(String userId, String processGUID, boolean isMergeUpdate, ProcessStatus processStatus, GovernanceActionProcessProperties processProperties)	Update the metadata element representing a governance action process.
void	updateGovernanceActionProcessStep(String userId, String processStepGUID, boolean isMergeUpdate, GovernanceActionProcessStepProperties processStepProperties)	Update the metadata element representing a governance action process step.
void	updateNextActionProcessStep(String userId, String nextProcessStepLinkGUID, String guard, boolean mandatoryGuard)	Update the properties of the link between two governance action process steps that shows that one follows on from the other when a governance action process is executing.
void	withdrawGovernanceActionProcess(String userId, String processGUID)	Update the zones for the asset so that it is no longer visible to consumers.

Method Details

createGovernanceActionProcess

String createGovernanceActionProcess(String userId,
 GovernanceActionProcessProperties processProperties,
 ProcessStatus initialStatus)
                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a governance action process.

Parameters:

userId - calling user

processProperties - properties about the process to store

initialStatus - status value for the new process (default = ACTIVE)

Returns:

unique identifier of the new process

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateGovernanceActionProcess

void updateGovernanceActionProcess(String userId,
 String processGUID,
 boolean isMergeUpdate,
 ProcessStatus processStatus,
 GovernanceActionProcessProperties processProperties)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a governance action process.

Parameters:

userId - calling user

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

processStatus - new status for the process

processProperties - new properties for the metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

publishGovernanceActionProcess

void publishGovernanceActionProcess(String userId,
 String processGUID)
                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the zones for the asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Governance Engine OMAS).

Parameters:

userId - calling user

processGUID - unique identifier of the metadata element to publish

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

withdrawGovernanceActionProcess

void withdrawGovernanceActionProcess(String userId,
 String processGUID)
                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the zones for the asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Governance Engine OMAS. This is the setting when the process is first created).

Parameters:

userId - calling user

processGUID - unique identifier of the metadata element to withdraw

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeGovernanceActionProcess

void removeGovernanceActionProcess(String userId,
 String processGUID)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a governance action process.

Parameters:

userId - calling user

processGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findGovernanceActionProcesses

List<GovernanceActionProcessElement> findGovernanceActionProcesses(String userId,
 String searchString,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action process metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective date/time for query

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)

getGovernanceActionProcessesByName

List<GovernanceActionProcessElement> getGovernanceActionProcessesByName(String userId,
 String name,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action process metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective date/time for query

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)

getGovernanceActionProcessByGUID

GovernanceActionProcessElement getGovernanceActionProcessByGUID(String userId,
 String processGUID)
                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance action process metadata element with the supplied unique identifier.

Parameters:

userId - calling user

processGUID - unique identifier of the requested metadata element

Returns:

requested metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getGovernanceActionProcessGraph

GovernanceActionProcessGraph getGovernanceActionProcessGraph(String userId,
 String processGUID,
 Date effectiveTime)
                                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance action process metadata element with the supplied unique identifier along with its process flow implementation. This includes the process steps and the links between them

Parameters:

userId - calling user

processGUID - unique identifier of the requested metadata element

effectiveTime - effective date/time for query

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)

createGovernanceActionProcessStep

String createGovernanceActionProcessStep(String userId,
 GovernanceActionProcessStepProperties processStepProperties)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a governance action process step.

Parameters:

userId - calling user

processStepProperties - properties about the process to store

Returns:

unique identifier of the new governance action process step

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)

updateGovernanceActionProcessStep

void updateGovernanceActionProcessStep(String userId,
 String processStepGUID,
 boolean isMergeUpdate,
 GovernanceActionProcessStepProperties processStepProperties)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a governance action process step.

Parameters:

userId - calling user

processStepGUID - unique identifier of the metadata element to update

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

processStepProperties - new properties for the metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

removeGovernanceActionProcessStep

void removeGovernanceActionProcessStep(String userId,
 String processStepGUID)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a governance action process step.

Parameters:

userId - calling user

processStepGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findGovernanceActionProcessSteps

List<GovernanceActionProcessStepElement> findGovernanceActionProcessSteps(String userId,
 String searchString,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action process step metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective date/time for query

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)

getGovernanceActionProcessStepsByName

List<GovernanceActionProcessStepElement> getGovernanceActionProcessStepsByName(String userId,
 String name,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of governance action process step metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

userId - calling user

name - name to search for

startFrom - paging start point

pageSize - maximum results that can be returned

effectiveTime - effective date/time for query

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)

getGovernanceActionProcessStepByGUID

GovernanceActionProcessStepElement getGovernanceActionProcessStepByGUID(String userId,
 String processStepGUID)
                                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the governance action process step metadata element with the supplied unique identifier.

Parameters:

userId - calling user

processStepGUID - unique identifier of the governance action process step

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)

setupFirstActionProcessStep

void setupFirstActionProcessStep(String userId,
 String processGUID,
 String processStepGUID,
 String guard)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Set up a link between a governance action process and a governance action process step. This defines the first step in the process.

Parameters:

userId - calling user

processGUID - unique identifier of the governance action process

processStepGUID - unique identifier of the governance action process step

guard - optional guard for the first governance service to run

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)

getFirstActionProcessStep

FirstGovernanceActionProcessStepElement getFirstActionProcessStep(String userId,
 String processGUID)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the governance action process step that is the first step in a governance action process.

Parameters:

userId - calling user

processGUID - unique identifier of the governance action process

Returns:

properties of the first governance action process step

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)

removeFirstActionProcessStep

void removeFirstActionProcessStep(String userId,
 String processGUID)
                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the link between a governance process and that governance action process step that defines its first step.

Parameters:

userId - calling user

processGUID - unique identifier of the governance action 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)

setupNextActionProcessStep

String setupNextActionProcessStep(String userId,
 String currentActionProcessStepGUID,
 String nextActionProcessStepGUID,
 String guard,
 boolean mandatoryGuard)
                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Add a link between two governance action process steps to show that one follows on from the other when a governance action process is executing.

Parameters:

userId - calling user

currentActionProcessStepGUID - unique identifier of the governance action process step that defines the previous step in the governance action process

nextActionProcessStepGUID - unique identifier of the governance action process step that defines the next step in the governance action process

guard - guard required for this next step to proceed - or null for always run the next step.

mandatoryGuard - means that no next steps can run if this guard is not returned

Returns:

unique identifier of the new link

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)

updateNextActionProcessStep

void updateNextActionProcessStep(String userId,
 String nextProcessStepLinkGUID,
 String guard,
 boolean mandatoryGuard)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the properties of the link between two governance action process steps that shows that one follows on from the other when a governance action process is executing.

Parameters:

userId - calling user

nextProcessStepLinkGUID - unique identifier of the relationship between the governance action process steps

guard - guard required for this next step to proceed - or null for always run the next step.

mandatoryGuard - means that no next steps can run if this guard is not returned

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)

getNextGovernanceActionProcessSteps

List<NextGovernanceActionProcessStepElement> getNextGovernanceActionProcessSteps(String userId,
 String processStepGUID,
 int startFrom,
 int pageSize)
                                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return the list of next process step defined for the governance action process.

Parameters:

userId - calling user

processStepGUID - unique identifier of the current governance action process step

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

return the list of relationships and attached governance action process steps.

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)

removeNextActionProcessStep

void removeNextActionProcessStep(String userId,
 String processStepLinkGUID)
                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a follow-on step from a governance action process.

Parameters:

userId - calling user

processStepLinkGUID - unique identifier of the relationship between the governance action process steps

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)