public abstract class ScenarioEvent
extends java.lang.Object
implements java.io.Serializable
Modifier and Type | Class and Description |
---|---|
protected static class |
ScenarioEvent.ProfileToolsSingleton
Static inner class useful to retrieve
ProfileTools
component from the global nucleus only once. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Constructor and Description |
---|
ScenarioEvent()
Initializes the
profileId , profile ,
sessionId and parentSessionId properties
of this message when this message is fired in context of HTTP request. |
Modifier and Type | Method and Description |
---|---|
protected java.lang.String |
appendBaseToString(java.lang.StringBuffer pBuf)
Returns readable string appending the contents of this Message with
the parameter
pBuf passed. |
java.lang.String |
getId()
The id of this message
|
java.lang.String |
getParentSessionId()
Returns the parent session id.
|
RepositoryItem |
getProfile()
The profile of the user owning the objects referred to by this event.
|
java.lang.String |
getProfileId()
Returns the profile id of the user associated with the request when
this message is sent in the context of an HTTP request.
|
ProfileTools |
getProfileTools()
Returns ProfileTools to retrieve the profile item.
|
java.lang.String |
getSessionId()
Returns the current session id associated with the request when
this message is sent in the context of an HTTP request.
|
java.lang.String |
getSiteId()
Returns the site id associated with the event
|
java.lang.String |
getType()
Returns the JMS type of this event.
|
RepositoryItem |
lookUpProfile()
Retrieves the profile corresponding to the
profileId
of this message. |
void |
setId(java.lang.String pId) |
void |
setParentSessionId(java.lang.String pParentSessionId)
Sets the parent session id.
|
void |
setProfile(RepositoryItem pProfile)
Sets the profile property.
|
void |
setProfileId(java.lang.String pProfileId)
Sets the profile id.
|
void |
setSessionId(java.lang.String pSessionId)
Sets the session id
|
void |
setSiteId(java.lang.String pSiteId)
The site id associated with the event
|
public ScenarioEvent()
profileId
, profile
,
sessionId
and parentSessionId
properties
of this message when this message is fired in context of HTTP request.public java.lang.String getType()
public void setId(java.lang.String pId)
public java.lang.String getId()
public void setProfile(RepositoryItem pProfile)
profileId
property based on the pProfile
passed.public RepositoryItem getProfile()
profileId
is looked up from ProfileAdapterRepository
using the lookUpProfile()
.public java.lang.String getParentSessionId()
public void setParentSessionId(java.lang.String pParentSessionId)
public java.lang.String getSessionId()
public void setSessionId(java.lang.String pSessionId)
public java.lang.String getProfileId()
public void setProfileId(java.lang.String pProfileId)
profile
property
to null.public void setSiteId(java.lang.String pSiteId)
pSite
- site id to setpublic java.lang.String getSiteId()
public RepositoryItem lookUpProfile()
profileId
of this message. If profileId
is null or any error
happens while retrieving the profile null is returned.public ProfileTools getProfileTools()
ProfileToolsSingleton.sProfileTools
to get the
ProfileToolsprotected java.lang.String appendBaseToString(java.lang.StringBuffer pBuf)
pBuf
passed. This may be used by sub-classes
of this class to append the contents of this base class to the sub-class's
String form.