atg.scenario.dms
Class SlotItemRequestMessage

java.lang.Object
  extended by atg.nucleus.dms.DASMessage
      extended by atg.scenario.dms.SlotItemRequestMessage
All Implemented Interfaces:
java.io.Serializable

public class SlotItemRequestMessage
extends DASMessage

This message is sent by a Slot whose generation mode is active, when items are to be rendered from the slot and it has insufficient items to satisfy the renderer. The purpose of the message is to request topic subscribers to place new content in the slot.

The slotName parameter of the message identifies the Nucleus path of the slot that is requesting content.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Constructor Summary
SlotItemRequestMessage()
           
 
Method Summary
 java.lang.String getSiteId()
          Gets the siteId property
 java.lang.String getSlotName()
          Name of slot requesting content.
 void setSiteId(java.lang.String pSiteId)
          Set the siteId property
protected  void setSiteIdFromSiteContext()
           
 void setSlotName(java.lang.String pSlotName)
          Set name of slot requesting content.
 java.lang.String toString()
          Returns the String representation of the SlotItemRequestMessage.
 
Methods inherited from class atg.nucleus.dms.DASMessage
limitSize, toStringProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string

Constructor Detail

SlotItemRequestMessage

public SlotItemRequestMessage()
Method Detail

getSlotName

public java.lang.String getSlotName()
Name of slot requesting content. If slot is request- or session-scoped, this is a correspondingly scoped name , not an absolute Nucleus path.


setSlotName

public void setSlotName(java.lang.String pSlotName)
Set name of slot requesting content.


setSiteId

public void setSiteId(java.lang.String pSiteId)
Set the siteId property

Parameters:
pSiteId - - The Site Id to set

getSiteId

public java.lang.String getSiteId()
Gets the siteId property


setSiteIdFromSiteContext

protected void setSiteIdFromSiteContext()

toString

public java.lang.String toString()
Returns the String representation of the SlotItemRequestMessage.

Overrides:
toString in class DASMessage