atg.reporting.datacollection
Interface UserEventLogging

All Known Implementing Classes:

UserEventLoggingService

public interface UserEventLogging

Defines methods that perform logging methods about a user's life cycle through the system.

Field Summary

static java.lang.String

CLASS_VERSION

Method Summary

java.lang.Long	logEndSession(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) Generates a log entry indicating that a session was expired
java.lang.Long	logLogin(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) Generates a log entry indicating that a user logged into the system
java.lang.Long	logLogout(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) Generates a log entry indicating that a user logged out of the system
java.lang.Long	logNewSession(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) Generates a log entry indicating that a new session was created
java.lang.Long	logRegistration(java.lang.String pSessionId, java.lang.String pProfileId, boolean pMember) Generates a log entry indicating that a new user registered

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

logNewSession

java.lang.Long logNewSession(java.lang.String pSessionId,
                             java.lang.String pProfileId,
                             boolean pMember)
                             throws atg.reporting.datacollection.LoggingException

Generates a log entry indicating that a new session was created

Parameters:

pSessionId - the id of the new session

pProfileId - the id of the user who started the new session

pMember - true if the action is coming from a "member"

Throws:

LoggingException - if there was a problem while performing the log operation

logEndSession

java.lang.Long logEndSession(java.lang.String pSessionId,
                             java.lang.String pProfileId,
                             boolean pMember)
                             throws atg.reporting.datacollection.LoggingException

Generates a log entry indicating that a session was expired

Parameters:

pSessionId - the id of the expired session

pProfileId - the id of the user whose session expired

pMember - true if the action is coming from a "member"

Throws:

LoggingException - if there was a problem while performing the log operation

logLogin

java.lang.Long logLogin(java.lang.String pSessionId,
                        java.lang.String pProfileId,
                        boolean pMember)
                        throws atg.reporting.datacollection.LoggingException

Generates a log entry indicating that a user logged into the system

Parameters:

pSessionId - the id of the user's session

pProfileId - the id of the user who logged in

pMember - true if the action is coming from a "member"

Throws:

LoggingException - if there was a problem while performing the log operation

logRegistration

java.lang.Long logRegistration(java.lang.String pSessionId,
                               java.lang.String pProfileId,
                               boolean pMember)
                               throws atg.reporting.datacollection.LoggingException

Generates a log entry indicating that a new user registered

Parameters:

pSessionId - the id of the user's session

pProfileId - the id of the user who registered

pMember - true if the action is coming from a "member"

Throws:

LoggingException - if there was a problem while performing the log operation

logLogout

java.lang.Long logLogout(java.lang.String pSessionId,
                         java.lang.String pProfileId,
                         boolean pMember)
                         throws atg.reporting.datacollection.LoggingException

Generates a log entry indicating that a user logged out of the system

Parameters:

pSessionId - the id of the user's session

pProfileId - the id of the user who logged out

pMember - true if the action is coming from a "member"

Throws:

LoggingException - if there was a problem while performing the log operation