Package org.odpi.openmetadata.viewservices.subjectarea.server

Class SubjectAreaRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.subjectarea.server.SubjectAreaRESTServices
public class SubjectAreaRESTServices extends TokenController
The SubjectAreaRESTServices provides the server-side implementation of the Subject Area Open Metadata View Service (OMVS). This interface provides access to data fields, data structures and data classes.

  • Constructor Details

    • SubjectAreaRESTServices

      public SubjectAreaRESTServices()
      Default constructor

  • Method Details

    • createSubjectArea

      public GUIDResponse createSubjectArea(String serverName, NewElementRequestBody requestBody)
      Create a data structure.
      Parameters:
      serverName - name of called server.
      requestBody - properties for the data structure.
      Returns:
      unique identifier of the newly created element InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createSubjectAreaFromTemplate

      public GUIDResponse createSubjectAreaFromTemplate(String serverName, TemplateRequestBody requestBody)
      Create a new metadata element to represent a data structure using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new element.
      Parameters:
      serverName - calling user
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateSubjectArea

      public VoidResponse updateSubjectArea(String serverName, String subjectAreaGUID, UpdateElementRequestBody requestBody)
      Update the properties of a data structure.
      Parameters:
      serverName - name of called server.
      subjectAreaGUID - unique identifier of the data structure (returned from create)
      requestBody - properties for the new element.
      Returns:
      void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkSubjectAreas

      public VoidResponse linkSubjectAreas(String serverName, String subjectAreaGUID, String nestedSubjectAreaGUID, NewRelationshipRequestBody requestBody)
      Attach a data field to a data structure.
      Parameters:
      serverName - name of called server
      subjectAreaGUID - unique identifier of the parent subject area.
      nestedSubjectAreaGUID - unique identifier of the nested subject area.
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachSubjectAreas

      public VoidResponse detachSubjectAreas(String serverName, String subjectAreaGUID, String dataFieldGUID, DeleteRequestBody requestBody)
      Detach a data field from a data structure.
      Parameters:
      serverName - name of called server
      subjectAreaGUID - unique identifier of the parent data structure.
      dataFieldGUID - unique identifier of the nested data field.
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteSubjectArea

      public VoidResponse deleteSubjectArea(String serverName, String subjectAreaGUID, DeleteRequestBody requestBody)
      Delete a data structure.
      Parameters:
      serverName - name of called server
      subjectAreaGUID - unique identifier of the element to delete
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getSubjectAreasByName

      public OpenMetadataRootElementsResponse getSubjectAreasByName(String serverName, FilterRequestBody requestBody)
      Retrieve the list of data structure metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getSubjectAreaByGUID

      public OpenMetadataRootElementResponse getSubjectAreaByGUID(String serverName, String subjectAreaGUID, GetRequestBody requestBody)
      Retrieve the list of data structure metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      subjectAreaGUID - unique identifier of the required element
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findSubjectAreas

      public OpenMetadataRootElementsResponse findSubjectAreas(String serverName, SearchStringRequestBody requestBody)
      Retrieve the list of data structure metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)