org.odpi.openmetadata.accessservices.governanceengine.api

Interface GovernanceActionProcessInterface

public interface GovernanceActionProcessInterface

GovernanceActionProcessInterface maintains Governance Action Processes and their Governance Action Types.

Method Summary

Modifier and Type	Method and Description
String	createGovernanceActionProcess(String userId, GovernanceActionProcessProperties processProperties, ProcessStatus initialStatus) Create a new metadata element to represent a governance action process.
String	createGovernanceActionType(String userId, GovernanceActionTypeProperties actionTypeProperties) Create a new metadata element to represent a governance action type.
List<GovernanceActionProcessElement>	findGovernanceActionProcesses(String userId, String searchString, int startFrom, int pageSize) Retrieve the list of governance action process metadata elements that contain the search string.
List<GovernanceActionTypeElement>	findGovernanceActionTypes(String userId, String searchString, int startFrom, int pageSize) Retrieve the list of governance action type metadata elements that contain the search string.
GovernanceActionTypeElement	getFirstActionType(String userId, String processGUID) Return the governance action type 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) Retrieve the list of governance action process metadata elements with a matching qualified or display name.
GovernanceActionTypeElement	getGovernanceActionTypeByGUID(String userId, String actionTypeGUID) Retrieve the governance action type metadata element with the supplied unique identifier.
List<GovernanceActionTypeElement>	getGovernanceActionTypesByName(String userId, String name, int startFrom, int pageSize) Retrieve the list of governance action type metadata elements with a matching qualified or display name.
List<NextGovernanceActionTypeElement>	getNextGovernanceActionTypes(String userId, String actionTypeGUID, int startFrom, int pageSize) Return the lust of next action type 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	removeFirstActionType(String userId, String processGUID) Remove the link between a governance process and that governance action type that defines its first step.
void	removeGovernanceActionProcess(String userId, String processGUID) Remove the metadata element representing a governance action process.
void	removeGovernanceActionType(String userId, String actionTypeGUID) Remove the metadata element representing a governance action type.
void	removeNextActionType(String userId, String actionLinkGUID) Remove a follow on step from a governance action process.
void	setupFirstActionType(String userId, String processGUID, String actionTypeGUID, String guard) Set up a link between an governance action process and a governance action type.
String	setupNextActionType(String userId, String currentActionTypeGUID, String nextActionTypeGUID, String guard, boolean mandatoryGuard, boolean ignoreMultipleTriggers) Add a link between two governance action types 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	updateGovernanceActionType(String userId, String actionTypeGUID, boolean isMergeUpdate, GovernanceActionTypeProperties actionTypeProperties) Update the metadata element representing a governance action type.
void	updateNextActionType(String userId, String nextActionLinkGUID, String guard, boolean mandatoryGuard, boolean ignoreMultipleTriggers) Update the properties of the link between two governance action types 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 Detail

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 Asset Manager 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 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

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

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

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)

createGovernanceActionType

String createGovernanceActionType(String userId,
                                  GovernanceActionTypeProperties actionTypeProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

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

Parameters:

userId - calling user

actionTypeProperties - properties about the process to store

Returns:

unique identifier of the new governance action type

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)

updateGovernanceActionType

void updateGovernanceActionType(String userId,
                                String actionTypeGUID,
                                boolean isMergeUpdate,
                                GovernanceActionTypeProperties actionTypeProperties)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Update the metadata element representing a governance action type.

Parameters:

userId - calling user

actionTypeGUID - unique identifier of the metadata element to update

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

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

removeGovernanceActionType

void removeGovernanceActionType(String userId,
                                String actionTypeGUID)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Remove the metadata element representing a governance action type.

Parameters:

userId - calling user

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

findGovernanceActionTypes

List<GovernanceActionTypeElement> findGovernanceActionTypes(String userId,
                                                            String searchString,
                                                            int startFrom,
                                                            int pageSize)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

Retrieve the list of governance action type 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

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)

getGovernanceActionTypesByName

List<GovernanceActionTypeElement> getGovernanceActionTypesByName(String userId,
                                                                 String name,
                                                                 int startFrom,
                                                                 int pageSize)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 PropertyServerException

Retrieve the list of governance action type 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

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)

getGovernanceActionTypeByGUID

GovernanceActionTypeElement getGovernanceActionTypeByGUID(String userId,
                                                          String actionTypeGUID)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

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

Parameters:

userId - calling user

actionTypeGUID - unique identifier of the governance action type

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)

setupFirstActionType

void setupFirstActionType(String userId,
                          String processGUID,
                          String actionTypeGUID,
                          String guard)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

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

Parameters:

userId - calling user

processGUID - unique identifier of the governance action process

actionTypeGUID - unique identifier of the governance action type

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)

getFirstActionType

GovernanceActionTypeElement getFirstActionType(String userId,
                                               String processGUID)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Return the governance action type 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 governance action type

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)

removeFirstActionType

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

Remove the link between a governance process and that governance action type 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)

setupNextActionType

String setupNextActionType(String userId,
                           String currentActionTypeGUID,
                           String nextActionTypeGUID,
                           String guard,
                           boolean mandatoryGuard,
                           boolean ignoreMultipleTriggers)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

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

Parameters:

userId - calling user

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

nextActionTypeGUID - unique identifier of the governance action type 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

ignoreMultipleTriggers - prevent multiple instances of the next step to run (or not)

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)

updateNextActionType

void updateNextActionType(String userId,
                          String nextActionLinkGUID,
                          String guard,
                          boolean mandatoryGuard,
                          boolean ignoreMultipleTriggers)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

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

Parameters:

userId - calling user

nextActionLinkGUID - unique identifier of the relationship between the governance action types

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

ignoreMultipleTriggers - prevent multiple instances of the next step to run (or not)

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)

getNextGovernanceActionTypes

List<NextGovernanceActionTypeElement> getNextGovernanceActionTypes(String userId,
                                                                   String actionTypeGUID,
                                                                   int startFrom,
                                                                   int pageSize)
                                                            throws InvalidParameterException,
                                                                   UserNotAuthorizedException,
                                                                   PropertyServerException

Return the lust of next action type defined for the governance action process.

Parameters:

userId - calling user

actionTypeGUID - unique identifier of the current governance action type

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

return the list of relationships and attached governance action types.

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)

removeNextActionType

void removeNextActionType(String userId,
                          String actionLinkGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Remove a follow on step from a governance action process.

Parameters:

userId - calling user

actionLinkGUID - unique identifier of the relationship between the governance action types

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)