```
public interface DigitalServicesInterface
```
The DigitalServicesInterface supports the management of digital services. The DigitalRolesInterface supports the appointment of digital service managers. The BusinessCapabilityManagement associates business capabilities with the digital services.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`clearDigitalServiceDependency(String userId, String digitalServiceGUID, String dependentDigitalServiceGUID)`	Remove the dependency link between two digital services.
`void`	`clearDigitalServiceOperator(String userId, String digitalServiceGUID, String organizationGUID)`	Remove the dependency link between two digital services.
`String`	`createDigitalService(String userId, DigitalServiceProperties properties, DigitalServiceStatus initialStatus)`	Create a new digital service.
`List<DigitalServiceElement>`	`findDigitalServices(String userId, String searchString, int startFrom, int pageSize)`	Retrieve the list of metadata elements that contain the search string.
`List<RelatedElement>`	`getDependentDigitalServices(String userId, String digitalServiceGUID, int startFrom, int pageSize)`	Return information about the dependent digital services.
`DigitalServiceElement`	`getDigitalServiceByGUID(String userId, String digitalServiceGUID)`	Retrieve the digital service metadata element with the supplied unique identifier.
`List<RelatedElement>`	`getDigitalServiceDependencies(String userId, String digitalServiceGUID, int startFrom, int pageSize)`	Return information about the digital services that this digital service is dependent on.
`List<DigitalServiceElement>`	`getDigitalServices(String userId, int startFrom, int pageSize)`	Retrieve the list of digital services.
`List<DigitalServiceElement>`	`getDigitalServicesByName(String userId, String name, int startFrom, int pageSize)`	Retrieve the list of metadata elements with a matching qualified or display name.
`List<RelatedElement>`	`getSupportedBusinessCapabilities(String userId, String digitalServiceGUID, int startFrom, int pageSize)`	Return information about the business capabilities supported by a digital service.
`List<RelatedElement>`	`getSupportedDigitalProducts(String userId, String digitalServiceGUID, int startFrom, int pageSize)`	Return information about the digital products supported by a digital service.
`void`	`removeDigitalService(String userId, String digitalServiceGUID)`	Delete a specific digital service.
`void`	`setDigitalServiceStatus(String userId, String digitalServiceGUID, DigitalServiceStatus newStatus)`	Update the status of a digital service
`void`	`setupDigitalServiceDependency(String userId, String digitalServiceGUID, String dependentDigitalServiceGUID, DigitalServiceDependencyProperties properties)`	Create a link to show that a digital service supports the requirements of another digital service.
`void`	`setupDigitalServiceOperator(String userId, String digitalServiceGUID, String organizationGUID, DigitalServiceDependencyProperties properties)`	Create a link to show that an organization has responsibility in operating a digital service.
`void`	`updateDigitalService(String userId, String digitalServiceGUID, boolean isMergeUpdate, DigitalServiceProperties properties)`	Update an existing digital service.

Method Detail

createDigitalService

String createDigitalService(String userId,
                            DigitalServiceProperties properties,
                            DigitalServiceStatus initialStatus)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Create a new digital service.

Parameters:: userId - calling user; properties - properties of the digital service; initialStatus - what is the initial status for the digital service - default value is DRAFT
Returns:: unique identifier of the digital service
Throws:: InvalidParameterException - one of the properties is null or invalid; PropertyServerException - problem accessing the metadata service; UserNotAuthorizedException - security access problem

updateDigitalService

void updateDigitalService(String userId,
                          String digitalServiceGUID,
                          boolean isMergeUpdate,
                          DigitalServiceProperties properties)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Update an existing digital service.

Parameters:: userId - calling user; digitalServiceGUID - unique identifier of the digital service to update; isMergeUpdate - are unspecified properties unchanged (true) or removed?; properties - properties to update
Throws:: InvalidParameterException - one of the properties is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

setDigitalServiceStatus

void setDigitalServiceStatus(String userId,
                             String digitalServiceGUID,
                             DigitalServiceStatus newStatus)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Update the status of a digital service

Parameters:: userId - calling user; digitalServiceGUID - unique identifier; newStatus - new status
Throws:: InvalidParameterException - guid, status or userId is null; guid is not known; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

removeDigitalService

void removeDigitalService(String userId,
                          String digitalServiceGUID)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Delete a specific digital service.

Parameters:: userId - calling user; digitalServiceGUID - unique identifier of the digital service to remove
Throws:: InvalidParameterException - guid is null or not known; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

setupDigitalServiceDependency

void setupDigitalServiceDependency(String userId,
                                   String digitalServiceGUID,
                                   String dependentDigitalServiceGUID,
                                   DigitalServiceDependencyProperties properties)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Create a link to show that a digital service supports the requirements of another digital service. If the link already exists the properties are updated.

Parameters:: userId - calling user; digitalServiceGUID - unique identifier of the digital service; dependentDigitalServiceGUID - unique identifier of the supporting digital service; properties - description of how the supporting digital service provides support
Throws:: InvalidParameterException - one of the guids is null or not known; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

clearDigitalServiceDependency

void clearDigitalServiceDependency(String userId,
                                   String digitalServiceGUID,
                                   String dependentDigitalServiceGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Remove the dependency link between two digital services.

Parameters:: userId - calling user; digitalServiceGUID - unique identifier of the digital service; dependentDigitalServiceGUID - unique identifier of the supporting digital service
Throws:: InvalidParameterException - one of the guids is null or not known; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

setupDigitalServiceOperator
```
void setupDigitalServiceOperator(String userId,
                                 String digitalServiceGUID,
                                 String organizationGUID,
                                 DigitalServiceDependencyProperties properties)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
```
Create a link to show that an organization has responsibility in operating a digital service. If the link already exists the properties are updated.

Parameters:

userId - calling user

digitalServiceGUID - unique identifier of the digital service

organizationGUID - unique identifier of the organization operating the digital service

properties - description of the scope of responsibilities that the organization has in the operation of the digital service

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

clearDigitalServiceOperator

void clearDigitalServiceOperator(String userId,
                                 String digitalServiceGUID,
                                 String organizationGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Remove the dependency link between two digital services.

Parameters:: userId - calling user; digitalServiceGUID - unique identifier of the digital service; organizationGUID - unique identifier of the organization operating the digital service
Throws:: InvalidParameterException - one of the guids is null or not known; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

findDigitalServices

List<DigitalServiceElement> findDigitalServices(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)

getDigitalServicesByName

List<DigitalServiceElement> getDigitalServicesByName(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)

getDigitalServices

List<DigitalServiceElement> getDigitalServices(String userId,
                                               int startFrom,
                                               int pageSize)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Retrieve the list of digital services.

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)

getDependentDigitalServices

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

Return information about the dependent digital services.

Parameters:: userId - calling user; digitalServiceGUID - unique identifier for the digital service; 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

getDigitalServiceDependencies

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

Return information about the digital services that this digital service is dependent on.

Parameters:: userId - calling user; digitalServiceGUID - unique identifier for the digital service; 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

getSupportedBusinessCapabilities

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

Return information about the business capabilities supported by a digital service.

Parameters:: userId - calling user; digitalServiceGUID - unique identifier for the digital service; 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

getSupportedDigitalProducts

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

Return information about the digital products supported by a digital service.

Parameters:: userId - calling user; digitalServiceGUID - unique identifier for the digital service; 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

getDigitalServiceByGUID

DigitalServiceElement getDigitalServiceByGUID(String userId,
                                              String digitalServiceGUID)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Retrieve the digital service metadata element with the supplied unique identifier.

Parameters:: userId - calling user; digitalServiceGUID - 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)

Interface DigitalServicesInterface