|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.bea.netuix.application.communities.invitations.email.formatting.JspEmailTextFormatter
public class JspEmailTextFormatter
EmailTextFormatter
class that uses a jsp for assembling the subject and body of an email invitation. <p/>The overview of community functionality contains a description of the community framework.
Field Summary | |
---|---|
static String |
INVITATION_DETAIL_CACHE_KEY |
Constructor Summary | |
---|---|
JspEmailTextFormatter(String jspSubjectURI, String jspBodyURI, Map<String,String> jspParams, String runAs) Constructor |
Method Summary | |
---|---|
void |
destroy() Called by EmailInviter implementations once they are completed using this EmailTextFormatter , giving the formatter an opportunity to do any necessary cleanup or to release resources obtained in init. |
EmailContent |
getBody(Invitee i) Get the email body text for the current Invitee |
EmailContent |
getSubject(Invitee i) Get the email subject text for the current Invitee |
void |
init(InvitationDetails invitationDetails, String invitationURL) Perform any one-time setup operations that need to be done such as obtaining resources that are needed during calls to getSubject and getBody |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String INVITATION_DETAIL_CACHE_KEY
Constructor Detail |
---|
public JspEmailTextFormatter(String jspSubjectURI, String jspBodyURI, Map<String,String> jspParams, String runAs)
jspSubjectURI
- the URI to the jsp that assembles the email subject textjspBodyURI
- the URI to the jsp that assembles the email body textjspParams
- Map
of request parameters to append to the jsp request. Can be null if no custom parameters need to be added.runAs
- optional user to run the jsp includes as, if the security restrictions have been place on the jsp's. Can be null if no security restrictions are in place.Method Detail |
---|
public void init(InvitationDetails invitationDetails, String invitationURL)
EmailTextFormatter
init
in interface EmailTextFormatter
invitationDetails
- the InvitationDetails
for this invitation operationinvitationURL
- the URL to the registration page or the community for this invitation operation. Email messages should include this URL so that recipients can navigate to the inviting community.public EmailContent getSubject(Invitee i) throws IOException
EmailTextFormatter
Invitee
getSubject
in interface EmailTextFormatter
i
- the current Invitee
IOException
public EmailContent getBody(Invitee i) throws IOException
EmailTextFormatter
Invitee
getBody
in interface EmailTextFormatter
i
- the current Invitee
IOException
public void destroy()
EmailTextFormatter
EmailInviter
implementations once they are completed using this EmailTextFormatter
, giving the formatter an opportunity to do any necessary cleanup or to release resources obtained in init.destroy
in interface EmailTextFormatter
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.