de.hybris.platform.b2b.punchout.services

Interface PunchOutSessionService

All Known Implementing Classes:

DefaultPunchOutSessionService

public interface PunchOutSessionService

This service handles the basic operations on PunchOutService instances.

Method Summary

Modifier and Type	Method and Description
void	activate(PunchOutSession punchOutSession) Activates a PunchOutSession for the current user session.
PunchOutSession	getCurrentPunchOutSession() Retrieves the currently loaded PunchOutSession.
java.lang.String	getCurrentPunchOutSessionId() Gets the currently active punchOut session.
PunchOutSession	loadPunchOutSession(java.lang.String punchOutSessionId) Loads and activates a PunchOutSession by its ID.
StoredPunchOutSessionModel	loadStoredPunchOutSessionModel(java.lang.String punchOutSessionId) Loads a given StoredPunchOutSessionModel by sid.
void	saveCurrentPunchoutSession() Saves current StoredPunchOutSessionModel in the db.
void	setCurrentCartFromPunchOutSetup(java.lang.String punchOutSessionId) Set the cart for the current session using the cart saved in a given punch out session.

Method Detail

saveCurrentPunchoutSession

void saveCurrentPunchoutSession()

Saves current StoredPunchOutSessionModel in the db.

loadStoredPunchOutSessionModel

StoredPunchOutSessionModel loadStoredPunchOutSessionModel(java.lang.String punchOutSessionId)

Loads a given StoredPunchOutSessionModel by sid.

Parameters:

punchOutSessionId - The sid to search.

Returns:

The StoredPunchOutSessionModel, or null if stored session does not exists.

activate

void activate(PunchOutSession punchOutSession)

Activates a PunchOutSession for the current user session.

Parameters:

punchOutSession - the new punchOut session

loadPunchOutSession

PunchOutSession loadPunchOutSession(java.lang.String punchOutSessionId)

Loads and activates a PunchOutSession by its ID.

Parameters:

punchOutSessionId - the punchOut session ID

Returns:

the newly loaded session

Throws:

PunchOutSessionNotFoundException - when the session is not found

setCurrentCartFromPunchOutSetup

void setCurrentCartFromPunchOutSetup(java.lang.String punchOutSessionId)

Set the cart for the current session using the cart saved in a given punch out session. This is necessary as the punchOut provider may use different sessions for sequential calls (e.g.: edit setup request and edit seamless login).
Notice that this should only be called after punch out user is authenticated.

Parameters:

punchOutSessionId - The punch out session ID.

getCurrentPunchOutSession

PunchOutSession getCurrentPunchOutSession()

Retrieves the currently loaded PunchOutSession.

Returns:

the punchOut session or null if none has been loaded yet

getCurrentPunchOutSessionId

java.lang.String getCurrentPunchOutSessionId()

Gets the currently active punchOut session.

Returns:

the active punchOut session ID