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

Interface GovernanceActionTypeInterface

All Known Implementing Classes:

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

public interface GovernanceActionTypeInterface

GovernanceActionTypeInterface maintains Governance Action Types. These are templates for requesting calls to a governance engine.

Method Summary

Modifier and Type	Method	Description
String	createGovernanceActionType(String userId, GovernanceActionTypeProperties properties)	Create a new metadata element to represent a governance action type.
List<GovernanceActionTypeElement>	findGovernanceActionTypes(String userId, String searchString, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of governance action type metadata elements that contain the search string.
GovernanceActionTypeElement	getGovernanceActionTypeByGUID(String userId, String governanceActionTypeGUID)	Retrieve the governance action type metadata element with the supplied unique identifier.
List<GovernanceActionTypeElement>	getGovernanceActionTypesByName(String userId, String name, int startFrom, int pageSize, Date effectiveTime)	Retrieve the list of governance action type metadata elements with a matching qualified or display name.
void	removeGovernanceActionType(String userId, String governanceActionTypeGUID)	Remove the metadata element representing a governance action type.
void	updateGovernanceActionType(String userId, String governanceActionTypeGUID, boolean isMergeUpdate, GovernanceActionTypeProperties properties)	Update the metadata element representing a governance action type.

Method Details

createGovernanceActionType

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

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

Parameters:

userId - calling user

properties - properties about the governance action type 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 governanceActionTypeGUID,
 boolean isMergeUpdate,
 GovernanceActionTypeProperties properties)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a governance action type.

Parameters:

userId - calling user

governanceActionTypeGUID - unique identifier of the metadata element to update

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

properties - 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 governanceActionTypeGUID)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a governance action type.

Parameters:

userId - calling user

governanceActionTypeGUID - 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,
 Date effectiveTime)
                                                     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

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)

getGovernanceActionTypesByName

List<GovernanceActionTypeElement> getGovernanceActionTypesByName(String userId,
 String name,
 int startFrom,
 int pageSize,
 Date effectiveTime)
                                                          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

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)

getGovernanceActionTypeByGUID

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

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

Parameters:

userId - calling user

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