|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.netuix.servlets.manager.communities.invitations.notification.NotificationInvitationHelper
public class NotificationInvitationHelper
A helper class paired with the NotificationInviter to help get community information out of notifications sent by the NotificationInviter. Because notifications are sent directly to WLS users (which have to authenticate to receive the notifications) it is not necessary to generate validation text for invitations sent over notifications.
The overview of community functionality contains a description of the community framework.
NotificationInviter
Field Summary | |
---|---|
static String |
NOTIFICATION_NAME
The name of the notifications sent by the NotificationInviter implementation. |
static String |
NOTIFICATION_NAMESPACE
The namespace of the notifications sent by the NotificationInviter implementation. |
Method Summary | |
---|---|
CommunityDefinition |
getCommunityDefinition()
Returns the CommunityDefinition for the community the invitation if for. |
CommunityDefinitionId |
getCommunityDefinitionId()
Retrieves the community definition ID from the invitation. |
CommunityURI |
getCommunityURI()
Retrieves the community URI from the invitation. |
Date |
getExpirationDate()
Retrieves the expiration date for the invitation. |
static NotificationInvitationHelper |
getNotificationInvitationHelper(Notification invitation,
javax.servlet.http.HttpServletRequest request)
Used to get a NotificationInvitationHelper instance from a Notification sent by the NotificationInviter implementation. |
static ArrayList<NotificationInvitationHelper> |
getNotificationInvitationHelpers(javax.servlet.http.HttpServletRequest request)
Used to get all NotificationInvitationHelper instances appropriate for the specified request. |
GenericURL |
getRegistrationPageUrl(javax.servlet.http.HttpServletResponse response)
Gets a URL to the community registration page. |
String |
getSendingUsername()
Retrieves the user from whom the invitation was sent, if a user sent the invitation. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String NOTIFICATION_NAMESPACE
public static final String NOTIFICATION_NAME
Method Detail |
---|
public static ArrayList<NotificationInvitationHelper> getNotificationInvitationHelpers(javax.servlet.http.HttpServletRequest request)
request
- the HttpServletRequest
public static NotificationInvitationHelper getNotificationInvitationHelper(Notification invitation, javax.servlet.http.HttpServletRequest request)
null
will be returned. If the notification is for an invitation which
has been consumed, the notification will be marked for consumption (to be consumed
at the end of the page render cycle) and null
will be returned.
invitation
- the Notification-based invitation object to create a helper for.request
- the HttpServletRequest
NotificationInvitationHelper
if appropriate for the
specified notification, null
otherwise.public CommunityURI getCommunityURI()
public CommunityDefinitionId getCommunityDefinitionId()
public String getSendingUsername()
null
if not available.public Date getExpirationDate()
public CommunityDefinition getCommunityDefinition()
public GenericURL getRegistrationPageUrl(javax.servlet.http.HttpServletResponse response)
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |