Thor.API.Operations

Interface DataCollectionOperationsIntf

All Superinterfaces:

tcUtilityOperationsIntf

public interface DataCollectionOperationsIntf
extends tcUtilityOperationsIntf

Method Summary

Modifier and Type	Method and Description
void	finalizeDataCollectionSession(java.lang.String sessionID) Finalizes the data collection session.
java.lang.String	getCurrentDataCollectionSession() Gets the sessionID of the current session.
java.lang.String	getDataCollectionStatus(java.lang.String sessionID) Gets the status of the data collection session
void	performDataCollectionForSession(java.lang.String sessionID) Performs the data collection in the current session.
void	startDataCollection(java.lang.String sessionID, java.util.Map entities) Starts a new data collection session with the passed session ID.

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Method Detail

startDataCollection

void startDataCollection(java.lang.String sessionID,
                         java.util.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

java.lang.String getDataCollectionStatus(java.lang.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

java.lang.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(java.lang.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(java.lang.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