Package org.odpi.openmetadata.accessservices.digitalservice.api

Interface BusinessCapabilityManagement

public interface BusinessCapabilityManagement

BusinessCapabilityManagement supports the maintenance, linking and reporting associated with business capabilities. Business capabilities can be modelled at any level of granularity. They provide business context to reports and measurements associated with the open metadata ecosystem and the data and technology it represents.

Method Summary

Modifier and Type	Method	Description
void	clearOrganizationalCapability(String userId, String externalSourceGUID, String externalSourceName, String businessCapabilityGUID, String teamGUID)	Remove a relationship between a business capability and a team.
void	clearSupportingDigitalService(String userId, String externalSourceGUID, String externalSourceName, String businessCapabilityGUID, String digitalServiceGUID)	Remove a relationship between a business capability and a team.
String	createBusinessCapability(String userId, String externalSourceGUID, String externalSourceName, BusinessCapabilityProperties businessCapabilityProperties)	Create a new metadata element to represent the business capability.
String	createBusinessCapabilityFromTemplate(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, TemplateProperties templateProperties)	Create a new metadata element to represent a business capability using an existing metadata element as a template.
List<BusinessCapabilityElement>	findBusinessCapabilities(String userId, String searchString, int startFrom, int pageSize)	Retrieve the list of metadata elements that contain the search string.
List<BusinessCapabilityElement>	getBusinessCapabilities(String userId, int startFrom, int pageSize)	Retrieve the list of business capabilities.
List<BusinessCapabilityElement>	getBusinessCapabilitiesByName(String userId, String name, int startFrom, int pageSize)	Retrieve the list of metadata elements with a matching qualified or display name.
BusinessCapabilityElement	getBusinessCapabilityByGUID(String userId, String businessCapabilityGUID)	Retrieve the business capability metadata element with the supplied unique identifier.
List<RelatedElement>	getDigitalSupport(String userId, String businessCapabilityGUID, int startFrom, int pageSize)	Return information about the digital services supporting a business capability.
List<RelatedElement>	getOrganizationalCapability(String userId, String businessCapabilityGUID, int startFrom, int pageSize)	Return information about the teams supporting a business capability.
void	removeBusinessCapability(String userId, String externalSourceGUID, String externalSourceName, String businessCapabilityGUID)	Remove the metadata element representing a business capability.
void	setupOrganizationalCapability(String userId, String externalSourceGUID, String externalSourceName, String businessCapabilityGUID, OrganizationalCapabilityProperties properties, String teamGUID)	Create a relationship between a business capability and a team to show that the support provided by the team for the business capability.
void	setupSupportingDigitalService(String userId, String externalSourceGUID, String externalSourceName, String businessCapabilityGUID, DigitalSupportProperties properties, String digitalServiceGUID)	Create a relationship between a business capability and a team to show that the support provided by the team for the business capability.
void	updateBusinessCapability(String userId, String externalSourceGUID, String externalSourceName, String businessCapabilityGUID, boolean isMergeUpdate, BusinessCapabilityProperties businessCapabilityProperties)	Update the metadata element representing a business capability.

Method Details

createBusinessCapability

String createBusinessCapability(String userId,
 String externalSourceGUID,
 String externalSourceName,
 BusinessCapabilityProperties businessCapabilityProperties)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent the business capability.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

businessCapabilityProperties - properties to store

Returns:

unique identifier of the new 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)

createBusinessCapabilityFromTemplate

String createBusinessCapabilityFromTemplate(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String templateGUID,
 TemplateProperties templateProperties)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a new metadata element to represent a business capability using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new business capability.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new 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)

updateBusinessCapability

void updateBusinessCapability(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String businessCapabilityGUID,
 boolean isMergeUpdate,
 BusinessCapabilityProperties businessCapabilityProperties)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Update the metadata element representing a business capability.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

businessCapabilityGUID - unique identifier of the metadata element to update

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

businessCapabilityProperties - new properties for this 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)

setupOrganizationalCapability

void setupOrganizationalCapability(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String businessCapabilityGUID,
 OrganizationalCapabilityProperties properties,
 String teamGUID)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a relationship between a business capability and a team to show that the support provided by the team for the business capability.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

businessCapabilityGUID - unique identifier of the business capability

properties - describes the scope of responsibility that the team has in the business capability

teamGUID - unique identifier of the team

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)

clearOrganizationalCapability

void clearOrganizationalCapability(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String businessCapabilityGUID,
 String teamGUID)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a relationship between a business capability and a team.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

businessCapabilityGUID - unique identifier of the business capability

teamGUID - unique identifier of the team

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)

setupSupportingDigitalService

void setupSupportingDigitalService(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String businessCapabilityGUID,
 DigitalSupportProperties properties,
 String digitalServiceGUID)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create a relationship between a business capability and a team to show that the support provided by the team for the business capability.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

businessCapabilityGUID - unique identifier of the business capability

properties - describes the scope of responsibility that the team has in the business capability

digitalServiceGUID - unique identifier of the digital service

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)

clearSupportingDigitalService

void clearSupportingDigitalService(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String businessCapabilityGUID,
 String digitalServiceGUID)
                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove a relationship between a business capability and a team.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

businessCapabilityGUID - unique identifier of the business capability

digitalServiceGUID - unique identifier of the digital service

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)

removeBusinessCapability

void removeBusinessCapability(String userId,
 String externalSourceGUID,
 String externalSourceName,
 String businessCapabilityGUID)
                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Remove the metadata element representing a business capability. This will delete all anchored elements such as comments.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of software capability representing the caller

externalSourceName - unique name of software capability representing the caller

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

findBusinessCapabilities

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

Retrieve the list of 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)

getBusinessCapabilitiesByName

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

Retrieve the list of 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)

getBusinessCapabilities

List<BusinessCapabilityElement> getBusinessCapabilities(String userId,
 int startFrom,
 int pageSize)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the list of business capabilities.

Parameters:

userId - calling user

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)

getOrganizationalCapability

List<RelatedElement> getOrganizationalCapability(String userId,
 String businessCapabilityGUID,
 int startFrom,
 int pageSize)
                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the teams supporting a business capability.

Parameters:

userId - calling user

businessCapabilityGUID - unique identifier for the business capability

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of matching actor profiles (hopefully only one)

Throws:

InvalidParameterException - name or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getDigitalSupport

List<RelatedElement> getDigitalSupport(String userId,
 String businessCapabilityGUID,
 int startFrom,
 int pageSize)
                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Return information about the digital services supporting a business capability.

Parameters:

userId - calling user

businessCapabilityGUID - unique identifier for the business capability

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return.

Returns:

list of matching actor profiles (hopefully only one)

Throws:

InvalidParameterException - name or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getBusinessCapabilityByGUID

BusinessCapabilityElement getBusinessCapabilityByGUID(String userId,
 String businessCapabilityGUID)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Retrieve the business capability metadata element with the supplied unique identifier.

Parameters:

userId - calling user

businessCapabilityGUID - unique identifier of the requested metadata element

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)