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

Interface RightsManagementInterface

public interface RightsManagementInterface

The RightsManagementInterface supports the management of the types of licenses (terms and conditions) associated with elements.

Method Summary

Modifier and Type	Method	Description
String	createLicenseType(String userId, LicenseTypeProperties properties, GovernanceDefinitionStatus initialStatus)	Create a description of the license type.
void	deleteLicenseType(String userId, String licenseGUID)	Delete the properties of the license type.
List<RelatedElement>	getLicensedElements(String userId, String licenseGUID, int startFrom, int pageSize)	Return information about the elements linked to a license.
List<LicenseElement>	getLicenses(String userId, String elementGUID, int startFrom, int pageSize)	Return information about the licenses linked to an element.
LicenseTypeElement	getLicenseTypeByDocId(String userId, String documentIdentifier)	Retrieve the license type by its assigned unique document identifier.
List<LicenseTypeElement>	getLicenseTypeByDomainId(String userId, int domainIdentifier, int startFrom, int pageSize)	Retrieve all the license type definitions for a specific governance domain.
LicenseTypeElement	getLicenseTypeByGUID(String userId, String licenseGUID)	Retrieve the license type by the unique identifier assigned by this service when it was created.
List<LicenseTypeElement>	getLicenseTypesByTitle(String userId, String title, int startFrom, int pageSize)	Retrieve all the license types for a particular title.
String	licenseElement(String userId, String elementGUID, String licenseTypeGUID, LicenseProperties properties)	Link an element to a license type and include details of the license in the relationship properties.
void	setLicenseTypeStatus(String userId, String licenseTypeGUID, GovernanceDefinitionStatus newStatus)	Update the status of a license type.
void	unlicenseElement(String userId, String licenseGUID)	Remove the license for an element.
void	updateLicense(String userId, String licenseGUID, boolean isMergeUpdate, LicenseProperties properties)	Update the properties of a license.
void	updateLicenseType(String userId, String licenseGUID, boolean isMergeUpdate, LicenseTypeProperties properties)	Update the properties of the license type.

Method Detail

createLicenseType

String createLicenseType(String userId,
                         LicenseTypeProperties properties,
                         GovernanceDefinitionStatus initialStatus)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException

Create a description of the license type.

Parameters:

userId - calling user

properties - license properties

initialStatus - what is the initial status for the license 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

updateLicenseType

void updateLicenseType(String userId,
                       String licenseGUID,
                       boolean isMergeUpdate,
                       LicenseTypeProperties properties)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

Update the properties of the license type.

Parameters:

userId - calling user

licenseGUID - identifier of the governance definition to change

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

properties - license properties

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

setLicenseTypeStatus

void setLicenseTypeStatus(String userId,
                          String licenseTypeGUID,
                          GovernanceDefinitionStatus newStatus)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Update the status of a license type.

Parameters:

userId - calling user

licenseTypeGUID - identifier of the governance definition to change

newStatus - new status

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteLicenseType

void deleteLicenseType(String userId,
                       String licenseGUID)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

Delete the properties of the license type.

Parameters:

userId - calling user

licenseGUID - identifier of the governance definition to delete

Throws:

InvalidParameterException - guid or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getLicenseTypeByGUID

LicenseTypeElement getLicenseTypeByGUID(String userId,
                                        String licenseGUID)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

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

Parameters:

userId - calling user

licenseGUID - identifier of the governance definition to retrieve

Returns:

properties of the license type

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getLicenseTypeByDocId

LicenseTypeElement getLicenseTypeByDocId(String userId,
                                         String documentIdentifier)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException

Retrieve the license type by its assigned unique document identifier.

Parameters:

userId - calling user

documentIdentifier - identifier to search for

Returns:

properties of the matching license type

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getLicenseTypesByTitle

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

Retrieve all the license 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 roles (null if no matching elements)

Throws:

InvalidParameterException - title or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getLicenseTypeByDomainId

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

Retrieve all the license 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 license type definitions

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

licenseElement

String licenseElement(String userId,
                      String elementGUID,
                      String licenseTypeGUID,
                      LicenseProperties properties)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

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

Parameters:

userId - calling user

elementGUID - unique identifier of the element being licensed

licenseTypeGUID - unique identifier for the license type

properties - the properties of the license

Returns:

unique identifier of the new relationship

Throws:

InvalidParameterException - one of the properties is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateLicense

void updateLicense(String userId,
                   String licenseGUID,
                   boolean isMergeUpdate,
                   LicenseProperties properties)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   PropertyServerException

Update the properties of a license.

Parameters:

userId - calling user

licenseGUID - unique identifier for the license relationship

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

properties - the properties of the license

Throws:

InvalidParameterException - one of the properties is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlicenseElement

void unlicenseElement(String userId,
                      String licenseGUID)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException

Remove the license for an element.

Parameters:

userId - calling user

licenseGUID - unique identifier for the license relationship

Throws:

InvalidParameterException - one of the properties is invalid

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getLicensedElements

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

Return information about the elements linked to a license.

Parameters:

userId - calling user

licenseGUID - unique identifier for the license relationship

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

properties of the subject area

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getLicenses

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

Return information about the licenses linked to an element.

Parameters:

userId - calling user

elementGUID - unique identifier for the license relationship

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

properties of the subject area

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem