|
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.CommunityInvitationHelper
public class CommunityInvitationHelper
The CommunityInvitationHelper
object is used to access community invitation
functionality.
Method Summary | |
---|---|
InvitationStatus |
consume(Invitation invitation,
InvitationStatus status)
Convenience method for consuming an invitation. |
static CommunityInvitationHelper |
getCommunityInvitationHelper(javax.servlet.http.HttpServletRequest request)
A convenience method for returning the CommunityInvitationHelper object
associated with the specified Request. |
Invitation |
getInvitation(CommunityDefinitionId communityId,
String wlsUserName)
Retrieves an Invitation by communityId and wlsUserName. |
Invitation |
getInvitation(InviteeId inviteeId)
Retrieves an Invitation by InviteeId . |
Invitation |
getInvitation(String validationText)
Retrieves an Invitation for the supplied validation text, which
serves as a key to the invitation. |
SortableFilterablePagedResult<Invitation> |
getInvitations(InvitationSearchCriteria criteria,
int pageSize)
Gets all of the Invitations for the specified search criteria. |
void |
inviteToCommunity(InviteeIterator invitees,
InvitationDetails inviteDetails,
CommunityInviter[] inviters)
Invites a set of Invitees to a community, via a specified
set of communications methods. |
void |
removeInvitation(InviteeId inviteeId)
Deletes a single Invitation from the database. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public Invitation getInvitation(String validationText) throws RemoteException
Invitation
for the supplied validation text, which
serves as a key to the invitation. This method may be called even if no user
is currently authenticated in the request.
validationText
- the validation text to use when retrieving the invitation.
RemoteException
public InvitationStatus consume(Invitation invitation, InvitationStatus status) throws RemoteException, NotEntitledException
invitation
- the Invitation object to consume.status
- the status to set for the invitation.
NotEntitledException
- if no user is currently logged in.
RemoteException
public void inviteToCommunity(InviteeIterator invitees, InvitationDetails inviteDetails, CommunityInviter[] inviters) throws RemoteException, NotEntitledException
Invitees
to a community, via a specified
set of communications methods. This method is asynchronous- it will return
before the operation has been completed, as the operation may take a long time.
invitees
- an InviteeIterator
that can enumerate all users to inviteinviteDetails
- detailed information about the invitation to perform.inviters
- an array of CommunityInviters
which specifies the
various communications channel Inviters
the framework
should use to send the invitations.
NotEntitledException
- if no user is currently logged in.
RemoteException
public Invitation getInvitation(CommunityDefinitionId communityId, String wlsUserName) throws RemoteException, NotEntitledException
Invitation
by communityId and wlsUserName. This is
useful for cases where the Invitee
has an existing WLS username
and the Community is known. If there is more than one Invitation
for the specified user and community, the most recent Invitation
will be returned.
communityId
- The community to get invitations forwlsUserName
- The user to get invitations for.
NotEntitledException
- if no user is currently logged in.
RemoteException
public Invitation getInvitation(InviteeId inviteeId) throws RemoteException, NotEntitledException
Invitation
by InviteeId
. This is useful for
cases where a Communities application has access to the InviteeId
,
typically obtained from a custom CommunityInviter
implementation
after an invitation operation has completed.
inviteeId
- the invitee to get an invitation for.
NotEntitledException
- if no user is currently logged in.
RemoteException
public SortableFilterablePagedResult<Invitation> getInvitations(InvitationSearchCriteria criteria, int pageSize) throws RemoteException, NotEntitledException
Invitations
for the specified search criteria.
The returned PagedResult can be ordered by "USERNAME", "INVITE_ADDRESS", "STATUS", "DATE" and "FROM",
and can be filterd by "INVITE_ADDRESS", "STATUS", "DATE" and "FROM", using these filter methods:
criteria
- the criteria invitations must match to be returned.pageSize
- the number of invitations to return per page.
NotEntitledException
- if no user is currently logged in.
RemoteException
public void removeInvitation(InviteeId inviteeId) throws RemoteException, NotEntitledException
Invitation
from the database.
inviteeId
- the id of the invitation to delete
NotEntitledException
- if no user is currently logged in.
RemoteException
public static CommunityInvitationHelper getCommunityInvitationHelper(javax.servlet.http.HttpServletRequest request)
CommunityInvitationHelper
object
associated with the specified Request.
request
- the HttpServletRequest
.
CommunityInvitationHelper
object associated with the request.
|
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 |