Package Thor.API.Operations

Interface DataCollectionOperationsIntf

All Superinterfaces:
tcUtilityOperationsIntf
public interface DataCollectionOperationsIntf extends tcUtilityOperationsIntf

  • Method Details

    • startDataCollection

      void startDataCollection(String sessionID, Map entities) throws tcAPIException, tcAPIException
      Starts a new data collection session with the passed session ID. For initiating a new data collection session, current session should be FINALIZED
      Parameters:
      sessionID - The sessionID of the new data collection session
      entities - A Map of entityName ==> java.util.Date that gives the entity name a sinceDate for each entity.
      Throws:
      tcAPIException

    • getDataCollectionStatus

      String getDataCollectionStatus(String sessionID) throws tcAPIException, tcAPIException
      Gets the status of the data collection session
      Parameters:
      sessionID - The sessionID of the session. This should be the current session.
      Returns:
      A string indicating the status of the data collection session. The valid status values are: INITIATED IN PROGRESS COMPLETED FAILED FINALIZED
      Throws:
      tcAPIException

    • getCurrentDataCollectionSession

      String getCurrentDataCollectionSession() throws tcAPIException, tcAPIException
      Gets the sessionID of the current session.
      Returns:
      A string that is the sessionID of the current data collection session
      Throws:
      tcAPIException

    • finalizeDataCollectionSession

      void finalizeDataCollectionSession(String sessionID) throws tcAPIException, tcAPIException
      Finalizes the data collection session.
      Parameters:
      sessionID - The sessionID of the session. The sessionID that is passed should be the current sessionID.
      Throws:
      tcAPIException

    • performDataCollectionForSession

      void performDataCollectionForSession(String sessionID) throws tcAPIException, tcAPIException
      Performs the data collection in the current session.
      Parameters:
      sessionID - The sessionID of the session. The sessionID that is passed should be the current sessionID.
      Throws:
      tcAPIException