ItemTrackingManager.Session

Retrieves the current state of the item tracking session.
The state indicates the current execution status of the item tracking algorithm and can be one of the following:

• STOPPED: The algorithm is stopped, and all internal variables are reset.
• STARTED: The algorithm is actively running and processing item tracking events.
• PAUSED: The algorithm is temporarily paused, preserving its internal state.

This method is useful for determining the current operational state of the session and making decisions about transitioning between states (e.g., starting, stopping, or pausing the algorithm).

Pauses the item tracking algorithm without clearing its internal state.
This method transitions the algorithm from the STARTED state to the PAUSED state.
In the PAUSED state:

• The algorithm stops processing item tracking events temporarily.
• Registered event listeners are not triggered.
• Internal variables and state are preserved, allowing the algorithm to resume without reinitialization.

Preconditions:

• The algorithm must be in the STARTED state.

Postconditions:

• If successful, the algorithm transitions to the PAUSED state.
• If unsuccessful, an error code is returned, and the state of the algorithm remains unchanged.

Releases the current item tracking session, making it unavailable for further use.
After calling this method:

• All methods that control the algorithm execution (start(), stop(), and pause()) will fail.
• The session will no longer be valid, and any attempt to interact with it will result in undefined behavior or errors.

This method is essential for proper resource management. It ensures that the session is cleaned up and resources are freed when the session is no longer needed. Failing to release the session may lead to resource leaks or prevent other applications from creating new sessions. Usage example:

 ItemTrackingManager manager = new ItemTrackingManager();
 ItemTrackingManager.Session session = manager.createSession();

 if (session != null) {
     session.start();
     // Perform item tracking operations...
     session.release(); // Ensure the session is released when done.
 }
 

Starts the item tracking algorithm.
This method transitions the algorithm from the STOPPED or PAUSED state to the STARTED state, enabling real-time item tracking.
Preconditions:

• The algorithm must be in the STOPPED or PAUSED state.

Postconditions:

• If successful, the algorithm will be in the STARTED state, and registered event listeners will begin receiving notifications for item tracking events.
• If unsuccessful, an error code will be returned, and the state of the algorithm will remain unchanged.

Stops the item tracking algorithm and clears its internal state.
This method transitions the algorithm from the STARTED or PAUSED state to the STOPPED state, resetting all internal variables.
Preconditions:

• The algorithm must be in the STARTED or PAUSED state.

Postconditions:

• If successful, the algorithm will be in the STOPPED state, and all internal variables will be reset to their initial state.
• If unsuccessful, an error code will be returned, and the state of the algorithm will remain unchanged.