Interface GovernanceActionTypeInterface
- All Known Implementing Classes:
GovernanceContextClient
,GovernanceContextClient
,GovernanceContextClientBase
,OpenGovernanceClient
,OpenGovernanceClient
,OpenGovernanceClient
,OpenGovernanceClient
,OpenGovernanceClient
,OpenGovernanceClient
,OpenGovernanceClient
,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 TypeMethodDescriptioncreateGovernanceActionType
(String userId, GovernanceActionTypeProperties properties) Create a new metadata element to represent a governance action type.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.getGovernanceActionTypeByGUID
(String userId, String governanceActionTypeGUID) Retrieve the governance action type metadata element with the supplied unique identifier.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 userproperties
- properties about the governance action type to store- Returns:
- unique identifier of the new governance action type
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 usergovernanceActionTypeGUID
- unique identifier of the metadata element to updateisMergeUpdate
- 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 invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 usergovernanceActionTypeGUID
- unique identifier of the metadata element to remove- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 usersearchString
- string to find in the propertiesstartFrom
- paging start pointpageSize
- maximum results that can be returnedeffectiveTime
- effective date/time for query- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 username
- name to search forstartFrom
- paging start pointpageSize
- maximum results that can be returnedeffectiveTime
- effective date/time for query- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- 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 usergovernanceActionTypeGUID
- unique identifier of the governance action type- Returns:
- requested metadata element
- Throws:
InvalidParameterException
- one of the parameters is invalidUserNotAuthorizedException
- the user is not authorized to issue this requestPropertyServerException
- there is a problem reported in the open metadata server(s)
-