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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addSubjectAreaMemberClassification(String userId, String elementGUID, SubjectAreaClassificationProperties properties)`	Add a subject area classification to a referenceable element.
`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.
`void`	`deleteSubjectAreaMemberClassification(String userId, String elementGUID)`	Remove a subject area classification from a referenceable.
`List<ElementStub>`	`getMembersOfSubjectArea(String userId, String subjectAreaName, int startFrom, int pageSize)`	Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.
`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`	`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

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

addSubjectAreaMemberClassification

void addSubjectAreaMemberClassification(String userId,
                                        String elementGUID,
                                        SubjectAreaClassificationProperties properties)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException

Add a subject area classification to a referenceable element.

Parameters:: userId - calling user; elementGUID - unique identifier for the element; properties - identifier for a subject area
Throws:: InvalidParameterException - qualifiedName or userId is null; qualifiedName is not unique; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

deleteSubjectAreaMemberClassification

void deleteSubjectAreaMemberClassification(String userId,
                                           String elementGUID)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException

Remove a subject area classification from a referenceable.

Parameters:: userId - calling user; elementGUID - unique identifier for the element
Throws:: InvalidParameterException - guid or userId is null; guid is not known; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getMembersOfSubjectArea

List<ElementStub> getMembersOfSubjectArea(String userId,
                                          String subjectAreaName,
                                          int startFrom,
                                          int pageSize)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Return information about the contents of a subject area such as the glossaries, reference data sets and quality definitions.

Parameters:: userId - calling user; subjectAreaName - unique identifier for the subject area; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: properties of the subject area members
Throws:: InvalidParameterException - qualifiedName or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

Interface SubjectAreasInterface