|
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 |
public interface InviterInvoker
This control is used to invite members to join the associated community through notification invitations.
You must add at least one invitee and set the details of the invitation before sending the invitation.
This control must be called within a context of a ServletRequest or an exception will be thrown.
Field Summary | |
---|---|
static String |
INVITATION_PROPERTY_MESSAGE_BODY Represents the custom attribute name of the "invitationMessageBody" that is placed in the details of the invitation. |
static String |
INVITATION_PROPERTY_MESSAGE_FROM_NAME Represents the custom attribute name of the "messageFromName" that is placed in the details of the invitation. |
Method Summary | |
---|---|
void |
addExternal(Collection<String> addresses) This method is intended to handle sending of invitations using external messaging architectures (i.e. |
void |
addExternal(Map<String,Set<String>> addressesAndCapabilities) This method is intended to handle sending of invitations using external messaging architectures (i.e. |
void |
addExternal(String address) Adds an address to the list of invitees. |
void |
addExternal(String address, Collection<String> capabilities) Adds an address to the list of invitees with the provided capabilities. |
void |
addUser(String username) Adds a user to the list of invitees. |
void |
addUser(String username, Set<String> capabilities) This will add the provided user to the collection of invitees. |
void |
addUsers(Collection<String> usernames) Add a collection of domain users to the list of invitees. |
void |
addUsers(Map<String,Set<String>> usersAndCapabilities) Adds the provided users (along with the provided set of capabilities) |
void |
sendInvitation(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) Sends the invitation to the set of invitees. |
void |
setCommunityDefinitionId(CommunityDefinitionId cdefId) Sets the community definition id for this control. |
void |
setInvitationExpiration(Timestamp ts) Sets the expiration date/time of the invitation. |
void |
setInvitationFromName(String messageFromName) Sets the name of the person that the invitation is set from. |
void |
setInvitationMessage(String messageBody) Sets the message body of the invitation. |
void |
setInvitationSelfDestruct(boolean selfDestructFlag) Determines whether the invitation will be destroyed upon consumption of the invitation. |
void |
setPortalAndDesktopPath(String portalPath, String desktopPath) Sets the portal path and desktop path. |
Field Detail |
---|
static final String INVITATION_PROPERTY_MESSAGE_BODY
static final String INVITATION_PROPERTY_MESSAGE_FROM_NAME
Method Detail |
---|
void setCommunityDefinitionId(CommunityDefinitionId cdefId)
This will be used to retrieve the community context when the invitation is sent.
cdefId
- The community definition id to use when retrieving the community context.void setPortalAndDesktopPath(String portalPath, String desktopPath)
This will be used to retrieve the community context when the invitation is sent.
portalPath
- The portalPath used to retrieve the community contextdesktopPath
- The desktopPath used to retrieve the community context.void addUser(String username, Set<String> capabilities) throws IllegalArgumentException
It is assumed that a valid domain username is provided as no validation will be performed.
username
- The username to addcapabilities
- A collection of valid membership capability names that will be applied to the user.IllegalArgumentException
- If any of the membership capabilities do not exist.void addUser(String username)
It is assumed that a valid domain username is provided as no validation will be performed.
username
- - A wls usernamevoid addUsers(Collection<String> usernames) throws IllegalArgumentException
It is assumed that a valid domain username is provided as no validation will be performed.
usernames
- - A collection of usernames of users to invite.IllegalArgumentException
void addExternal(Collection<String> addresses) throws IllegalOperationException
This method will throw an IllegalOperationException if it is not supported.
addresses
-IllegalOperationException
void addExternal(String address) throws IllegalOperationException
address
- - Some external address (email, yim, etc).IllegalOperationException
void addExternal(String address, Collection<String> capabilities) throws IllegalOperationException, IllegalArgumentException
address
- - Some external address (email, yim, etc).capabilities
- - The collection of membership capabilities.IllegalArgumentException
- If an invalid membership capability was provided.IllegalOperationException
void addExternal(Map<String,Set<String>> addressesAndCapabilities) throws IllegalOperationException, IllegalArgumentException
This method will throw an IllegalOperationException if it is not supported.
addressesAndCapabilities
- The map of usernames and associated capabilities.IllegalOperationException
- If this method is not supported by the implementation.IllegalArgumentException
- If an invalid membership capability was provided.void addUsers(Map<String,Set<String>> usersAndCapabilities) throws IllegalArgumentException
The structure of the map must represent the domain username as the key, along with the collection of membership capabilities (in string format) as the value.
For example:
Key Capabilities --------------------------------------------- johndoe creator owner janedoe visitorusersAndCapabilities
- The map containing the usernames and capabilitiesIllegalArgumentException
- If any of the membership capability names are invalid.void setInvitationMessage(String messageBody)
messageBody
- - The body of the message.void setInvitationFromName(String messageFromName)
messageFromName
- - The name of the person sending the invitation.void setInvitationExpiration(Timestamp ts)
ts
- Timestamp representing the expiration of the invitation.void setInvitationSelfDestruct(boolean selfDestructFlag)
Defaults to true.
selfDestructFlag
-void sendInvitation(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response) throws NetuixException
NetuixException
|
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.