Package org.odpi.openmetadata.viewservices.timekeeper.server

Class TimeKeeperRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.timekeeper.server.TimeKeeperRESTServices
public class TimeKeeperRESTServices extends TokenController
The TimeKeeperRESTServices provides the server-side implementation of the Time Keeper Open Metadata View Service (OMVS). This interface provides access to context events.

  • Constructor Details

    • TimeKeeperRESTServices

      public TimeKeeperRESTServices()
      Default constructor

  • Method Details

    • createContextEvent

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

    • createContextEventFromTemplate

      public GUIDResponse createContextEventFromTemplate(String serverName, String urlMarker, TemplateRequestBody requestBody)
      Create a new metadata element to represent a contextEvent 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
      urlMarker - view service URL marker
      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 a problem reported in the open metadata server(s)

    • updateContextEvent

      public BooleanResponse updateContextEvent(String serverName, String urlMarker, String contextEventGUID, UpdateElementRequestBody requestBody)
      Update the properties of a contextEvent.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      contextEventGUID - unique identifier of the contextEvent (returned from create)
      requestBody - properties for the new element.
      Returns:
      boolean or InvalidParameterException one of the parameters is invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkDependentContextEvents

      public VoidResponse linkDependentContextEvents(String serverName, String urlMarker, String parentContextEventGUID, String childContextEventGUID, NewRelationshipRequestBody requestBody)
      Connect two context events to show that one is dependent on another.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      parentContextEventGUID - unique identifier of the parent context event.
      childContextEventGUID - unique identifier of the child context event.
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachDependentContextEvents

      public VoidResponse detachDependentContextEvents(String serverName, String urlMarker, String parentContextEventGUID, String childContextEventGUID, DeleteRelationshipRequestBody requestBody)
      Detach two dependent context events from one another.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      parentContextEventGUID - unique identifier of the parent context event.
      childContextEventGUID - unique identifier of the child context event.
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkRelatedContextEvents

      public VoidResponse linkRelatedContextEvents(String serverName, String urlMarker, String contextEventOneGUID, String contextEventTwoGUID, NewRelationshipRequestBody requestBody)
      Connect two context events to show that one is related to the other.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contextEventOneGUID - unique identifier of the context event at end 1
      contextEventTwoGUID - unique identifier of the context event at end 2
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachRelatedContextEvents

      public VoidResponse detachRelatedContextEvents(String serverName, String urlMarker, String contextEventOneGUID, String contextEventTwoGUID, DeleteRelationshipRequestBody requestBody)
      Detach two context events that are related to one another.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contextEventOneGUID - unique identifier of the context event at end 1
      contextEventTwoGUID - unique identifier of the context event at end 2
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkContextEventEvidence

      public VoidResponse linkContextEventEvidence(String serverName, String urlMarker, String contextEventGUID, String evidenceGUID, NewRelationshipRequestBody requestBody)
      Connect a context event to an element that provides evidence that this context event is real.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contextEventGUID - unique identifier of the context event
      evidenceGUID - unique identifier of the element representing the evidence
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachContextEventEvidence

      public VoidResponse detachContextEventEvidence(String serverName, String urlMarker, String contextEventGUID, String evidenceGUID, DeleteRelationshipRequestBody requestBody)
      Detach a context event from an element that provides evidence that this context event is real.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contextEventGUID - unique identifier of the context event
      evidenceGUID - unique identifier of the element representing the evidence
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkContextEventImpact

      public VoidResponse linkContextEventImpact(String serverName, String urlMarker, String contextEventGUID, String impactedElementGUID, NewRelationshipRequestBody requestBody)
      Connect a context event to an element that is impacted by this event.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contextEventGUID - unique identifier of the context event
      impactedElementGUID - unique identifier of the element that is impacted by the event
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachContextEventImpact

      public VoidResponse detachContextEventImpact(String serverName, String urlMarker, String contextEventGUID, String impactedElementGUID, DeleteRelationshipRequestBody requestBody)
      Detach a context event from an element that is impacted by the event.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contextEventGUID - unique identifier of the context event
      impactedElementGUID - unique identifier of the element that is impacted by the event
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkContextEventTimelineEffect

      public VoidResponse linkContextEventTimelineEffect(String serverName, String urlMarker, String timelineAffectedElementGUID, String contextEventGUID, NewRelationshipRequestBody requestBody)
      Connect a context event to an element whose data is impacted by this event.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      timelineAffectedElementGUID - unique identifier of the element whose data is impacted by the context event
      contextEventGUID - unique identifier of the context event
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachContextEventTimelineEffect

      public VoidResponse detachContextEventTimelineEffect(String serverName, String urlMarker, String timelineAffectedElementGUID, String contextEventGUID, DeleteRelationshipRequestBody requestBody)
      Detach a context event from an element whose data is impacted by the event.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      timelineAffectedElementGUID - unique identifier of the element whose data is impacted by the context event
      contextEventGUID - unique identifier of the context event
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteContextEvent

      public VoidResponse deleteContextEvent(String serverName, String urlMarker, String contextEventGUID, DeleteElementRequestBody requestBody)
      Delete a contextEvent.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      contextEventGUID - 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getContextEventsByName

      public OpenMetadataRootElementsResponse getContextEventsByName(String serverName, String urlMarker, FilterRequestBody requestBody)
      Retrieve the list of contextEvent metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      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 a problem reported in the open metadata server(s)

    • getContextEventByGUID

      public OpenMetadataRootElementResponse getContextEventByGUID(String serverName, String urlMarker, String contextEventGUID, GetRequestBody requestBody)
      Retrieve the list of contextEvent metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      contextEventGUID - 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 a problem reported in the open metadata server(s)

    • findContextEvents

      public OpenMetadataRootElementsResponse findContextEvents(String serverName, String urlMarker, SearchStringRequestBody requestBody)
      Retrieve the list of contextEvent metadata elements that contain the search string.
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      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 a problem reported in the open metadata server(s)