org.odpi.openmetadata.accessservices.governanceprogram.api

Interface SubjectAreasInterface

public interface SubjectAreasInterface

The SubjectAreasInterface is used by the governance team to define the subject area for topic related governance definitions.

Method Summary

Modifier and Type	Method and Description
String	createSubjectArea(String userId, SubjectAreaProperties properties) Create a definition of a subject area.
void	deleteSubjectArea(String userId, String subjectAreaGUID) Remove the definition of a subject area.
SubjectAreaElement	getSubjectAreaByGUID(String userId, String subjectAreaGUID) Return information about a specific subject area.
SubjectAreaElement	getSubjectAreaByName(String userId, String qualifiedName) Return information about a specific subject area.
SubjectAreaDefinition	getSubjectAreaDefinitionByGUID(String userId, String subjectAreaGUID) Return information about a specific subject area and its linked governance definitions.
List<SubjectAreaElement>	getSubjectAreasForDomain(String userId, int domainIdentifier, int startFrom, int pageSize) Return information about the defined subject areas.
void	linkSubjectAreasInHierarchy(String userId, String parentSubjectAreaGUID, String childSubjectAreaGUID) Link two related subject areas together as part of a hierarchy.
void	linkSubjectAreaToGovernanceDefinition(String userId, String subjectAreaGUID, String definitionGUID) Link a subject area to a governance definition that controls how the definitions in the subject area should be governed.
void	unlinkSubjectAreaFromGovernanceDefinition(String userId, String subjectAreaGUID, String definitionGUID) Remove the link between a subject area and a governance definition.
void	unlinkSubjectAreasInHierarchy(String userId, String parentSubjectAreaGUID, String childSubjectAreaGUID) Remove the link between two subject areas in the subject area hierarchy.
void	updateSubjectArea(String userId, String subjectAreaGUID, boolean isMergeUpdate, SubjectAreaProperties properties) Update the definition of a subject area.

Method Detail

createSubjectArea

String createSubjectArea(String userId,
                         SubjectAreaProperties properties)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException

Create a definition of a subject area.

Parameters:

userId - calling user

properties - properties for a subject area

Returns:

unique identifier of subject area

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

updateSubjectArea

void updateSubjectArea(String userId,
                       String subjectAreaGUID,
                       boolean isMergeUpdate,
                       SubjectAreaProperties properties)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

Update the definition of a subject area.

Parameters:

userId - calling user

subjectAreaGUID - unique identifier of subject area

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

properties - properties to change

Throws:

InvalidParameterException - guid, qualifiedName or userId is null; qualifiedName is not unique; guid is not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

deleteSubjectArea

void deleteSubjectArea(String userId,
                       String subjectAreaGUID)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException

Remove the definition of a subject area.

Parameters:

userId - calling user

subjectAreaGUID - unique identifier of subject area

Throws:

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

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

linkSubjectAreasInHierarchy

void linkSubjectAreasInHierarchy(String userId,
                                 String parentSubjectAreaGUID,
                                 String childSubjectAreaGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Link two related subject areas together as part of a hierarchy. A subject area can only have one parent but many child subject areas.

Parameters:

userId - calling user

parentSubjectAreaGUID - unique identifier of the parent subject area

childSubjectAreaGUID - unique identifier of the child subject area

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

unlinkSubjectAreasInHierarchy

void unlinkSubjectAreasInHierarchy(String userId,
                                   String parentSubjectAreaGUID,
                                   String childSubjectAreaGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException

Remove the link between two subject areas in the subject area hierarchy.

Parameters:

userId - calling user

parentSubjectAreaGUID - unique identifier of the parent subject area

childSubjectAreaGUID - unique identifier of the child subject area

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

linkSubjectAreaToGovernanceDefinition

void linkSubjectAreaToGovernanceDefinition(String userId,
                                           String subjectAreaGUID,
                                           String definitionGUID)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Link a subject area to a governance definition that controls how the definitions in the subject area should be governed.

Parameters:

userId - calling user

subjectAreaGUID - unique identifier of the subject area

definitionGUID - unique identifier of the governance definition

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

PropertyServerException

unlinkSubjectAreaFromGovernanceDefinition

void unlinkSubjectAreaFromGovernanceDefinition(String userId,
                                               String subjectAreaGUID,
                                               String definitionGUID)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException

Remove the link between a subject area and a governance definition.

Parameters:

userId - calling user

subjectAreaGUID - unique identifier of the subject area

definitionGUID - unique identifier of the governance definition

Throws:

InvalidParameterException - one of the guids is null or not known

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSubjectAreaByGUID

SubjectAreaElement getSubjectAreaByGUID(String userId,
                                        String subjectAreaGUID)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Return information about a specific subject area.

Parameters:

userId - calling user

subjectAreaGUID - unique identifier for the subject area

Returns:

properties of the subject area

Throws:

InvalidParameterException - subjectAreaGUID or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSubjectAreaByName

SubjectAreaElement getSubjectAreaByName(String userId,
                                        String qualifiedName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Return information about a specific subject area.

Parameters:

userId - calling user

qualifiedName - unique name for the subject area

Returns:

properties of the subject area

Throws:

InvalidParameterException - qualifiedName or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem

getSubjectAreasForDomain

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

Return information about the defined subject areas.

Parameters:

userId - calling user

domainIdentifier - identifier for the desired governance domain

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

getSubjectAreaDefinitionByGUID

SubjectAreaDefinition getSubjectAreaDefinitionByGUID(String userId,
                                                     String subjectAreaGUID)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Return information about a specific subject area and its linked governance definitions.

Parameters:

userId - calling user

subjectAreaGUID - unique identifier for the subject area

Returns:

properties of the subject area

Throws:

InvalidParameterException - subjectAreaGUID or userId is null

PropertyServerException - problem accessing property server

UserNotAuthorizedException - security access problem