|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.portal.alert.PortalMessage atg.portal.alert.GearMessage
public class GearMessage
This message bean extends the PortalMessage class for the purposes of adding properties common to all Gear alerts messages.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
Fields inherited from interface atg.portal.alert.AlertConstants |
---|
ALERT_ADMIN_ID, ALERT_CHANNEL_COMPONENT_NAME, ALERT_CHANNEL_DISPLAY_NAME, ALERT_CHANNEL_VIEW, ALERT_CHANNELS, ALERT_COMMUNITY_LEADER_TARGET, ALERT_COMMUNITY_TARGET, ALERT_CONTENT_URL, ALERT_CREATION_DATE, ALERT_DELETE_FLAG, ALERT_DISPLAY_STRING, ALERT_EMAIL_TEMPLATE, ALERT_END_DATE, ALERT_EVENT_TYPE, ALERT_FRAMEWORK_ID, ALERT_GEAR_ALERT_ITEM_DESCRIPTOR, ALERT_GEAR_COMMUNITIES_TARGET, ALERT_GEAR_DEF_VIEW, ALERT_GEAR_ID, ALERT_GROUP_VIEW, ALERT_ITEM_DESCRIPTOR, ALERT_LOGIN, ALERT_MESSAGE_BEAN, ALERT_MESSAGE_TYPE, ALERT_NAME, ALERT_NO, ALERT_NOTIFICATION_PREFERENCE, ALERT_NOTIFY_PREFERENCES, ALERT_OPT_IN_OUT, ALERT_ORGANIZATION_TARGET, ALERT_ORIGINATES, ALERT_PROFILE_VIEW, ALERT_PROPERTY_NAMES, ALERT_RESOURCE_BUNDLE, ALERT_ROLE_TARGET, ALERT_SOURCE_ID, ALERT_SOURCE_TYPE, ALERT_START_DATE, ALERT_TARGET_ID, ALERT_TARGET_TYPE, ALERT_USER_TARGET, ALERT_USER_VIEW, ALERT_VALUE, ALERT_YES, ALERT_YES_LOCKED, ALERT_YES_OPENED, COMMUNITY_ID, COMMUNITY_TYPE, COMMUNITY_VIEW, EMAIL_CHANNEL, EVENT_TYPE, GEAR_ID, GEAR_VIEW, ORG_TYPE, ROLE_TYPE, USER_TYPE, WEB_CHANNEL, WIRELESS_CHANNEL |
Constructor Summary | |
---|---|
GearMessage()
|
|
GearMessage(Environment pEnv,
java.lang.String pMessageType)
|
|
GearMessage(GearEnvironment pGearEnv,
java.lang.String pMessageType)
|
|
GearMessage(java.lang.String pGearId,
java.lang.String pCommunityId,
java.lang.String pProfileId,
java.lang.String pMessageType)
|
|
GearMessage(java.lang.String pSourceId,
java.lang.String pCommunityId,
java.lang.String pProfileId,
java.lang.String pMessageType,
java.util.Date pStartDate,
java.util.Date pEndDate,
java.util.Date pExpirationDate)
|
Method Summary | |
---|---|
java.lang.String |
getCommunityId()
Get the community item id |
java.lang.String |
getCommunityName()
Get the transient community name property. |
java.lang.String |
getCommunityName(java.util.Locale pLocale)
Get the transient community name property based on a locale. |
java.lang.String |
getGearId()
Get the gear item id |
java.lang.String |
getGearName()
Get the transient gear name property for the default locale. |
java.lang.String |
getGearName(java.util.Locale pLocale)
Get the transient gear name property based on a locale. |
java.lang.String |
getProfileDisplayName()
Get the profile display name |
java.lang.String |
getProfileId()
Get the profile item id |
void |
postFormatMessage(java.util.Locale pLocale)
This method should be called by any AlertHandler implementation after formatting and delivery of the alert message. |
void |
preFormatMessage(java.util.Locale pLocale)
Dynamically retrieve the CommunityName and GearName in a locale sensitive manner prior to the format and delivery of the alert message. |
void |
setCommunityId(java.lang.String pCommunityId)
Set the community item id |
void |
setCommunityName(java.lang.String pCommunityName)
Sets the transient community name property. |
void |
setGearId(java.lang.String pGearId)
Sets the gear item id |
void |
setGearName(java.lang.String pGearName)
Sets the transient gear name property. |
void |
setProfileDisplayName(java.lang.String pProfileDisplayName)
Sets the profile display name |
void |
setProfileId(java.lang.String pProfileId)
Sets the profile item id |
Methods inherited from class atg.portal.alert.PortalMessage |
---|
getCreationDate, getEndDate, getExpirationDate, getMessageType, getSourceId, getSourceType, getStartDate, setCreationDate, setEndDate, setExpirationDate, setMessageType, setSourceId, setSourceType, setStartDate |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public GearMessage()
public GearMessage(java.lang.String pGearId, java.lang.String pCommunityId, java.lang.String pProfileId, java.lang.String pMessageType)
public GearMessage(java.lang.String pSourceId, java.lang.String pCommunityId, java.lang.String pProfileId, java.lang.String pMessageType, java.util.Date pStartDate, java.util.Date pEndDate, java.util.Date pExpirationDate)
public GearMessage(GearEnvironment pGearEnv, java.lang.String pMessageType)
public GearMessage(Environment pEnv, java.lang.String pMessageType)
Method Detail |
---|
public java.lang.String getGearId()
public void setGearId(java.lang.String pGearId)
pGearId
- repository id of the Gear generating the messagepublic java.lang.String getGearName()
public java.lang.String getGearName(java.util.Locale pLocale) throws java.lang.Exception
java.lang.Exception
public void setGearName(java.lang.String pGearName)
pGearName
- name of the Gear generating the messagepublic java.lang.String getCommunityId()
public void setCommunityId(java.lang.String pCommunityId)
pCommunityId
- repository id of the Community where the gear
message originatedpublic java.lang.String getCommunityName()
public java.lang.String getCommunityName(java.util.Locale pLocale) throws java.lang.Exception
java.lang.Exception
public void setCommunityName(java.lang.String pCommunityName)
pCommunityName
- name of Community where the gear message originatedpublic java.lang.String getProfileId()
public void setProfileId(java.lang.String pProfileId)
pProfileId
- the repository id of the profilepublic java.lang.String getProfileDisplayName()
public void setProfileDisplayName(java.lang.String pProfileDisplayName)
pProfileDisplayName
- the display name of the profilepublic void preFormatMessage(java.util.Locale pLocale) throws java.lang.Exception
preFormatMessage
in class PortalMessage
pLocale
- the Locale that the request to receive alerts came from
java.lang.Exception
public void postFormatMessage(java.util.Locale pLocale) throws java.lang.Exception
postFormatMessage
in class PortalMessage
java.lang.Exception
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |