Package org.odpi.openmetadata.accessservices.governanceprogram.api

Interface CertificationManagementInterface

public interface CertificationManagementInterface

The CertificationManagementInterface provides the ability to manage the certification types that can be associated with elements.

Method Summary

Modifier and Type	Method	Description
String	certifyElement(String userId, String elementGUID, String certificationTypeGUID, CertificationProperties properties)	Link an element to a certification type and include details of the certification in the relationship properties.
String	createCertificationType(String userId, CertificationTypeProperties properties, GovernanceDefinitionStatus initialStatus)	Create a description of the certification type.
void	decertifyElement(String userId, String certificationGUID)	Remove the certification for an element.
void	deleteCertificationType(String userId, String certificationTypeGUID)	Delete the properties of the certification type.
List<RelatedElement>	getCertifications(String userId, String elementGUID, int startFrom, int pageSize)	Return information about the certifications linked to an element.
CertificationTypeElement	getCertificationTypeByDocId(String userId, String documentIdentifier)	Retrieve the certification type by its assigned unique document identifier.
List<CertificationTypeElement>	getCertificationTypeByDomainId(String userId, int domainIdentifier, int startFrom, int pageSize)	Retrieve all the certification type definitions for a specific governance domain.
CertificationTypeElement	getCertificationTypeByGUID(String userId, String certificationTypeGUID)	Retrieve the certification type by the unique identifier assigned by this service when it was created.
List<CertificationTypeElement>	getCertificationTypesByTitle(String userId, String title, int startFrom, int pageSize)	Retrieve all the certification types for a particular title.
List<RelatedElement>	getCertifiedElements(String userId, String certificationTypeGUID, int startFrom, int pageSize)	Return information about the elements linked to a certification.
void	updateCertification(String userId, String certificationGUID, boolean isMergeUpdate, CertificationProperties properties)	Update the properties of a certification.
void	updateCertificationType(String userId, String certificationTypeGUID, boolean isMergeUpdate, CertificationTypeProperties properties)	Update the properties of the certification type.

Method Detail

createCertificationType

String createCertificationType(String userId,
                               CertificationTypeProperties properties,
                               GovernanceDefinitionStatus initialStatus)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Create a description of the certification type.

Parameters:

userId - calling user

properties - certification properties

initialStatus - what is the initial status for the certification type - default value is DRAFT

Returns:

unique identifier of new definition

Throws:

InvalidParameterException - documentIdentifier or userId is null; documentIdentifier is not unique

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateCertificationType

void updateCertificationType(String userId,
                             String certificationTypeGUID,
                             boolean isMergeUpdate,
                             CertificationTypeProperties properties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Update the properties of the certification type.

Parameters:

userId - calling user

certificationTypeGUID - identifier of the governance definition to change

isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?

properties - certification properties

Throws:

InvalidParameterException - guid, documentIdentifier or userId is null; documentIdentifier is not unique

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteCertificationType

void deleteCertificationType(String userId,
                             String certificationTypeGUID)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Delete the properties of the certification type.

Parameters:

userId - calling user

certificationTypeGUID - identifier of the governance definition to delete

Throws:

InvalidParameterException - guid or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getCertificationTypeByGUID

CertificationTypeElement getCertificationTypeByGUID(String userId,
                                                    String certificationTypeGUID)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException

Retrieve the certification type by the unique identifier assigned by this service when it was created.

Parameters:

userId - calling user

certificationTypeGUID - identifier of the governance definition to retrieve

Returns:

properties of the certification type

Throws:

InvalidParameterException - guid or userId is null; guid is not recognized

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getCertificationTypeByDocId

CertificationTypeElement getCertificationTypeByDocId(String userId,
                                                     String documentIdentifier)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Retrieve the certification type by its assigned unique document identifier.

Parameters:

userId - calling user

documentIdentifier - identifier to search for

Returns:

properties of the matching certification type

Throws:

InvalidParameterException - documentIdentifier or userId is null; documentIdentifier is not recognized

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getCertificationTypesByTitle

List<CertificationTypeElement> getCertificationTypesByTitle(String userId,
                                                            String title,
                                                            int startFrom,
                                                            int pageSize)
                                                     throws UserNotAuthorizedException,
                                                            InvalidParameterException,
                                                            PropertyServerException

Retrieve all the certification types for a particular title. The title can include regEx wildcards.

Parameters:

userId - calling user

title - identifier of role

startFrom - where to start from in the list of definitions

pageSize - max number of results to return in one call

Returns:

list of matching certification types (null if no matching elements)

Throws:

InvalidParameterException - title or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getCertificationTypeByDomainId

List<CertificationTypeElement> getCertificationTypeByDomainId(String userId,
                                                              int domainIdentifier,
                                                              int startFrom,
                                                              int pageSize)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

Retrieve all the certification type definitions for a specific governance domain.

Parameters:

userId - calling user

domainIdentifier - identifier to search for

startFrom - where to start from in the list of definitions

pageSize - max number of results to return in one call

Returns:

properties of the matching certification type definitions

Throws:

InvalidParameterException - domainIdentifier or userId is null; domainIdentifier is not recognized

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

certifyElement

String certifyElement(String userId,
                      String elementGUID,
                      String certificationTypeGUID,
                      CertificationProperties properties)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Link an element to a certification type and include details of the certification in the relationship properties.

Parameters:

userId - calling user

elementGUID - unique identifier of the element being certified

certificationTypeGUID - unique identifier for the certification type

properties - the properties of the certification

Returns:

unique identifier of the new relationship

Throws:

InvalidParameterException - one of the properties is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateCertification

void updateCertification(String userId,
                         String certificationGUID,
                         boolean isMergeUpdate,
                         CertificationProperties properties)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException

Update the properties of a certification.

Parameters:

userId - calling user

certificationGUID - unique identifier of the certification relationship being updated

isMergeUpdate - should the supplied properties overlay the existing properties or replace them

properties - the properties of the certification

Throws:

InvalidParameterException - one of the properties is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

decertifyElement

void decertifyElement(String userId,
                      String certificationGUID)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Remove the certification for an element.

Parameters:

userId - calling user

certificationGUID - unique identifier of the certification relationship

Throws:

InvalidParameterException - one of the properties is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getCertifiedElements

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

Return information about the elements linked to a certification.

Parameters:

userId - calling user

certificationTypeGUID - unique identifier for the certification type

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

properties of the certification

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getCertifications

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

Return information about the certifications linked to an element.

Parameters:

userId - calling user

elementGUID - unique identifier for the certification

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

properties of the certification

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem