Interface ManageSubjectAreas
-
public interface ManageSubjectAreasSubject areas group data into topic areas. This makes it easier to manage common definitions such as glossary terms, reference data and governance definitions that are specific to a certain type of data. The SubjectArea classification can be added to digital services and digital products.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddSubjectAreaMemberClassification(String userId, String elementGUID, SubjectAreaClassificationProperties properties)Add a subject area classification to a referenceable element.voiddeleteSubjectAreaMemberClassification(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 digital services, digital products, glossaries, reference data sets and quality definitions.SubjectAreaElementgetSubjectAreaByName(String userId, String subjectAreaName)Return information about a specific subject area.List<SubjectAreaElement>getSubjectAreas(String userId, int domainIdentifier, int startFrom, int pageSize)Return information about the defined subject areas.
-
-
-
Method Detail
-
getSubjectAreaByName
SubjectAreaElement getSubjectAreaByName(String userId, String subjectAreaName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Return information about a specific subject area.- Parameters:
userId- calling usersubjectAreaName- unique name for the subject area- Returns:
- properties of the subject area
- Throws:
InvalidParameterException- qualifiedName or userId is nullPropertyServerException- problem accessing property serverUserNotAuthorizedException- security access problem
-
getSubjectAreas
List<SubjectAreaElement> getSubjectAreas(String userId, int domainIdentifier, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Return information about the defined subject areas.- Parameters:
userId- calling userdomainIdentifier- identifier for the desired governance domain - if 0 then all subject areas are returnedstartFrom- paging start pointpageSize- maximum results that can be returned- Returns:
- properties of the subject areas
- Throws:
InvalidParameterException- qualifiedName or userId is nullPropertyServerException- problem accessing property serverUserNotAuthorizedException- 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 userelementGUID- unique identifier for the elementproperties- identifier for a subject area- Throws:
InvalidParameterException- qualifiedName or userId is null; qualifiedName is not uniquePropertyServerException- problem accessing property serverUserNotAuthorizedException- 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 userelementGUID- unique identifier for the element- Throws:
InvalidParameterException- guid or userId is null; guid is not knownPropertyServerException- problem accessing property serverUserNotAuthorizedException- 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 digital services, digital products, glossaries, reference data sets and quality definitions.- Parameters:
userId- calling usersubjectAreaName- unique identifier for the subject areastartFrom- paging start pointpageSize- maximum results that can be returned- Returns:
- properties of the subject area members
- Throws:
InvalidParameterException- qualifiedName or userId is nullPropertyServerException- problem accessing property serverUserNotAuthorizedException- security access problem
-
-