|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICommunityMemberManager
Interface for the Communities Membership Manager. Implementations of this interface allow for management of Community Members including CRUD operations on Community Members, their memberships in specific Communities, capabilities within those Communities and association with MessagingAddresses for use by the Communities framework and Communities applications.
The overview of community functionality contains a description of the community framework.
CommunityContext
,
CommunityUserContext
Method Summary | |
---|---|
void |
activateMember(CustomizationContext customizationContext,
CommunityMemberId id)
Activates a disabled CommunityMember globally for all Communities. |
void |
activateMembership(CustomizationContext customizationContext,
CommunityMemberId mId,
CommunityDefinitionId cId)
Activates a CommunityMembership in the specified CommunityDefinition ,
making a disabled member able to use the community once again. |
void |
addMembershipCapability(CustomizationContext customizationContext,
CommunityMemberId mId,
CommunityDefinitionId cId,
MembershipCapability capability)
Adds a capability (owner, leader or manager) to the CommunityMembership
specified. |
void |
cleanupAllInactiveInvitations(CustomizationContext customizationContext)
Deletes all inactive status Invitations from the database |
void |
cleanupInactiveInvitations(CustomizationContext customizationContext,
CommunityDefinitionId communityId)
Deletes all inactive status Invitations from the database for
a specified Community. |
InvitationStatus |
consumeInvitation(CustomizationContext customizationContext,
InviteeId inviteeId,
InvitationStatus toStatus)
Consumes an Invitation that is in active status and moves it to
one of the inactive statuses. |
CommunityMember |
createMember(CustomizationContext customizationContext,
CommunityMember info)
Creates a new CommunityMember based on the contents of
the info parameter. |
CommunityMembership |
createMembership(CustomizationContext customizationContext,
CommunityMemberId mId,
CommunityDefinitionId cDefinitionId)
Creates a CommunityMembership for the specified CommunityMember
in the specified CommunityDefinition . |
CommunityMembership |
createMembership(CustomizationContext customizationContext,
CommunityMemberId mId,
Invitation invitation)
Creates a CommunityMembership based on an Invitation
that has been sent. |
void |
disableMember(CustomizationContext customizationContext,
CommunityMemberId id)
Disables a CommunityMember globally for all Communities. |
void |
disableMembership(CustomizationContext customizationContext,
CommunityMemberId mId,
CommunityDefinitionId cId)
Disables a CommunityMembership . |
SortableFilterablePagedResult<String> |
getAllCommunityAssociates(CustomizationContext context,
MemberCriteria criteria,
int pageSize)
Retrieves a paginated collection of all WLS user IDs of individuals belonging to the same communities the specified CommunityMember also belongs to. |
Collection<MessagingAddress> |
getAllMessagingAddresses(CustomizationContext customizationContext,
CommunityMember member)
Gets all of the MessagingAddresses associated with the specified
CommunityMember , as determined by User profile values that are
mapped to Communities MessagingAddresses . |
SortableFilterablePagedResult<CommunityMembership> |
getCommunityMemberships(CustomizationContext context,
MembershipCriteria criteria,
int pageSize)
Returns a paginated set of all CommunityMembership objects for the
specified member that meet the specified criteria. |
Invitation |
getInvitation(CustomizationContext customizationContext,
CommunityDefinitionId communityId,
String wlsUserName)
Retrieves an Invitation by communityId and wlsUserName. |
Invitation |
getInvitation(CustomizationContext customizationContext,
InviteeId inviteeId)
Retrieves an Invitation by InviteeId . |
Invitation |
getInvitation(CustomizationContext customizationContext,
String validationText)
Retrieves an Invitation by validation text. |
SortableFilterablePagedResult<Invitation> |
getInvitations(CustomizationContext customizationContext,
InvitationSearchCriteria invitationCriteria,
int pageSize)
Paginated search method for getting Invitations matching the supplied
InvitationSearchCriteria
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:
FilterMethod.BEGINS_WITH
FilterMethod.ENDS_WITH
FilterMethod.CONTAINS
FilterMethod.EQUALS
|
|
getInvitationsPage(
Callback method to support paging for getInvitations |
CommunityMember |
getMember(CustomizationContext customizationContext,
CommunityMemberId memberId)
Retrieves a CommunityMember object populated with
information for the CommunityMember specified by CommunityMemberId . |
CommunityMember |
getMember(CustomizationContext customizationContext,
String userId)
Retrieves a CommunityMember object populated with
information for the CommunityMember specified by id. |
CommunityMembership |
getMembership(CustomizationContext customizationContext,
CommunityMemberId mId,
CommunityDefinitionId cId)
Returns the CommunityMembership information for a CommunityMember ,
if they have a membership in the specified community. |
CommunityMembership |
getMembership(CustomizationContext customizationContext,
String username,
CommunityDefinitionId cId)
Returns the CommunityMembership information for a user
if they have a membership in the specified community. |
MessagingAddress |
getMessagingAddress(CustomizationContext customizationContext,
CommunityMember member,
MessagingAddressType addrType,
String mappingName)
Gets the MessagingAddress of a particular type and mapping name
for the specified CommunityMember . |
Collection<MessagingAddress> |
getMessagingAddresses(CustomizationContext customizationContext,
CommunityMember member,
MessagingAddressType addrType)
Gets all MessagingAddresses of a particular type for the specified
CommunityMember . |
MessagingAddress |
getPrimaryMessagingAddress(CustomizationContext customizationContext,
CommunityMember member,
MessagingAddressType addrType)
Gets the primary MessagingAddress of a particular type for the specified CommunityMember . |
void |
inviteToCommunity(CustomizationContext customizationContext,
InviteeIterator invitees,
InvitationDetails inviteDetails,
CommunityInviter[] inviters)
Invites a set of Invitees to a community, via a specified
set of communications methods. |
void |
removeInvitation(CustomizationContext customizationContext,
InviteeId inviteeId)
Deletes a single Invitation from the database. |
void |
removeMember(CustomizationContext customizationContext,
CommunityMemberId id)
Removes a CommunityMember globally for all Communities. |
void |
removeMembership(CustomizationContext customizationContext,
CommunityMemberId mId,
CommunityDefinitionId cId)
Deletes a CommunityMembership for a CommunityMember in a specified
CommunityDefinition . |
void |
removeMembershipCapability(CustomizationContext customizationContext,
CommunityMemberId mId,
CommunityDefinitionId cId,
MembershipCapability capability)
Removes a capability (owner, leader or manager) from the CommunityMembership
specified. |
void |
setMessagingAddress(CustomizationContext customizationContext,
CommunityMember member,
MessagingAddress m,
String mappingName)
Sets a MessagingAddress value into a mapped property in the User Profile
for this CommunityMember that is used as the mapped address for the
MessagingAddressType specified in the MessagingAddress . |
void |
setPrimaryMessagingAddress(CustomizationContext customizationContext,
CommunityMember member,
MessagingAddress m)
Sets a MessagingAddress value into a mapped property in the User Profile
for this CommunityMember that is used as the primary address for the
MessagingAddressType specified in the MessagingAddress . |
void |
synchronousInviteToCommunity(CustomizationContext customizationContext,
InviteeIterator invitees,
InvitationDetails inviteDetails,
CommunityInviter[] inviters)
Invites a set of Invitees to a community, via a specified
set of communications methods. |
long |
updateLastAccessDate(CustomizationContext customizationContext,
CommunityMembershipId membershipId)
Updates the last access date for the specified membership to the current time. |
Method Detail |
---|
CommunityMember createMember(CustomizationContext customizationContext, CommunityMember info) throws RemoteException, DuplicateObjectException
CommunityMember
based on the contents of
the info parameter.
customizationContext
- customization informationinfo
- a set of information on which to base the creation of the
new CommunityMember
CommunityMember
object populated with values
corresponding to the new CommunityMember
DuplicateObjectException
- if a member record already exists for the
WLS user specified in the CommunityMember
object.
RemoteException
CommunityMember getMember(CustomizationContext customizationContext, String userId) throws RemoteException
CommunityMember
object populated with
information for the CommunityMember
specified by id. If
deepInfo is set to true, CommunityMembership
information is also
retrieved and contained within the CommunityMember
return value.
customizationContext
- customization informationuserId
- the WLS user id of the CommunityMember
to look up
CommunityMember
object populated with information
for the specified CommunityMember
if they exist,
otherwise null.
RemoteException
CommunityMember getMember(CustomizationContext customizationContext, CommunityMemberId memberId) throws RemoteException
CommunityMember
object populated with
information for the CommunityMember
specified by CommunityMemberId
.
customizationContext
- customization informationmemberId
- the CommunityMemberId
of the user id of the
CommunityMember
to look up
CommunityMember
object populated with information
for the specified CommunityMember
if they exist,
otherwise null.
RemoteException
void disableMember(CustomizationContext customizationContext, CommunityMemberId id) throws ObjectNotFoundException, RemoteException
CommunityMember
globally for all Communities.
customizationContext
- customization informationid
- the id of the CommunityMember
to disable.
ObjectNotFoundException
- if the specified member does not exist in the
database.
RemoteException
void activateMember(CustomizationContext customizationContext, CommunityMemberId id) throws ObjectNotFoundException, RemoteException
CommunityMember
globally for all Communities.
customizationContext
- customization informationid
- the id of the CommunityMember
to activate.
ObjectNotFoundException
- if the specified member does not exist in the
database.
RemoteException
void removeMember(CustomizationContext customizationContext, CommunityMemberId id) throws ObjectNotFoundException, RemoteException
CommunityMember
globally for all Communities.
customizationContext
- customization informationid
- the id of the CommunityMember
to remove.
ObjectNotFoundException
- if the specified member does not exist in the
database.
RemoteException
CommunityMembership createMembership(CustomizationContext customizationContext, CommunityMemberId mId, CommunityDefinitionId cDefinitionId) throws IllegalArgumentException, DuplicateObjectException, RemoteException
CommunityMembership
for the specified CommunityMember
in the specified CommunityDefinition
.
customizationContext
- customization informationmId
- the id of the CommunityMember
cDefinitionId
- the id of the CommunityDefinition
CommunityMembership
object containing the new membership information.
IllegalArgumentException
- if the invitation does not have "sent" status
or if the invitation is not for the specified member.
DuplicateObjectException
- if a membership already exists for the specified
member and community.
RemoteException
CommunityMembership createMembership(CustomizationContext customizationContext, CommunityMemberId mId, Invitation invitation) throws DuplicateObjectException, RemoteException
CommunityMembership
based on an Invitation
that has been sent. The new membership is created based off of the
CommunityDefinition
referrenced by the Invitation
and
the CommunityMember
specifed by member id. Any MembershipCapabilities
in the Invitation
will additionally be added to the membership,
and the Invitation
will be set to the accepted
status.
customizationContext
- customization informationmId
- the id of the CommunityMember
to create the membership forinvitation
- an Invitation
to base the membership on
CommunityMembership
object containing the new membership information.
DuplicateObjectException
RemoteException
void removeMembership(CustomizationContext customizationContext, CommunityMemberId mId, CommunityDefinitionId cId) throws ObjectNotFoundException, RemoteException
CommunityMembership
for a CommunityMember
in a specified
CommunityDefinition
.
customizationContext
- customization informationmId
- the id of the CommunityMember
cId
- the id of the CommunityDefinition
RemoteException
ObjectNotFoundException
- if no membership for the specified community and member
exists.void disableMembership(CustomizationContext customizationContext, CommunityMemberId mId, CommunityDefinitionId cId) throws ObjectNotFoundException, RemoteException
CommunityMembership
.
customizationContext
- customization informationmId
- the id of the CommunityMember
cId
- the id of the CommunityDefinition
RemoteException
ObjectNotFoundException
- if no membership for the specified community
and member exists.void activateMembership(CustomizationContext customizationContext, CommunityMemberId mId, CommunityDefinitionId cId) throws RemoteException, ObjectNotFoundException
CommunityMembership
in the specified CommunityDefinition
,
making a disabled member able to use the community once again.
customizationContext
- customization informationmId
- the id of the CommunityMember
cId
- the id of the CommunityDefinition
RemoteException
ObjectNotFoundException
- if no membership for the specified community
and member exists.CommunityMembership getMembership(CustomizationContext customizationContext, CommunityMemberId mId, CommunityDefinitionId cId) throws RemoteException
CommunityMembership
information for a CommunityMember
,
if they have a membership in the specified community.
customizationContext
- customization informationmId
- the id of the CommunityMember
cId
- the id of the CommunityDefinition
CommunityMembership
object populated with membership information
for the specified CommunityMember
, if it exists, otherwise null.
RemoteException
CommunityMembership getMembership(CustomizationContext customizationContext, String username, CommunityDefinitionId cId) throws RemoteException
CommunityMembership
information for a user
if they have a membership in the specified community.
customizationContext
- customization informationusername
- the WLS username of the usercId
- the id of the CommunityDefinition
CommunityMembership
object populated with membership information
for the specified user, if it exists, otherwise null.
RemoteException
long updateLastAccessDate(CustomizationContext customizationContext, CommunityMembershipId membershipId) throws ObjectNotFoundException, RemoteException
customizationContext
- customization informationmembershipId
- the ID for the CommunityMembership
to update
ObjectNotFoundException
- if no membership can be found in the database
matching the specified membership ID.
RemoteException
SortableFilterablePagedResult<CommunityMembership> getCommunityMemberships(CustomizationContext context, MembershipCriteria criteria, int pageSize) throws RemoteException
CommunityMembership
objects for the
specified member that meet the specified criteria.
If the returned SortableFilterablePagedResult is re-filtered using the reFilter()
method, the filter specified is used in addition to the original filter criteria
specified in the MembershipCriteria object. If the filter criteria
specified in the reFilter() method conflicts with a criteria specified in the original
MembershipCriteria object, the newly specified filter criteria is used in
place of the original MembershipCriteria for that field only; all other
field criteria specified in the MembershipCriteria object will still be
used as filter criteria.
The returned PagedResult is sortable by "USERNAME", "MEMBER_IS_ACTIVE", "MEMBER_IS_EXTERNAL",
"MEMBERSHIP_IS_ACTIVE", "LAST_ACCESS_DATE" and "JOIN_DATE".
The returned PagedResult is filterable by "USERNAME", using these filter methods:
context
- the context for the search.criteria
- the criteria CommunityMemberships must match to be returned.
If a MemberMembershipCriteria object is used, memberships matching
the specified criteria for the specified member will be returned.
If a CommunityMembershipCriteria object is used, memberships matching
the specified criteria for the specified community will be returned.pageSize
- the number of membership objects to return per result page.
RemoteException
SortableFilterablePagedResult<String> getAllCommunityAssociates(CustomizationContext context, MemberCriteria criteria, int pageSize) throws RemoteException, ObjectNotFoundException
CommunityMember
also belongs to.
The returned PagedResult can be sorted and filtered "USERNAME" using filter methods:
context
- the context for the search.criteria
- the specification of the CommunityMember
to get
community associates of.pageSize
- the number of usernames to return per result page.
String
WLS user IDs which is the
merged community membership list for all communities the specified
CommunityMember
belongs to. A WLS user ID will only
be included once, even if the user has a membership in multiple communities
to which the specified CommunityMember
also belongs.
ObjectNotFoundException
- if the member specified in the criteria cannot be
found.
RemoteException
void addMembershipCapability(CustomizationContext customizationContext, CommunityMemberId mId, CommunityDefinitionId cId, MembershipCapability capability) throws RemoteException, IllegalArgumentException, ObjectNotFoundException
CommunityMembership
specified.
customizationContext
- customization informationmId
- the id of the CommunityMember
whose membership is to be modified.cId
- the id of the Community
for the membership.capability
- the capability to add to the membership, which is one of the
CommunityMembership.Capability
constants.
RemoteException
IllegalArgumentException
- if the capability specified is not valid.
ObjectNotFoundException
- if the specified community membership does not exist.void removeMembershipCapability(CustomizationContext customizationContext, CommunityMemberId mId, CommunityDefinitionId cId, MembershipCapability capability) throws RemoteException, IllegalArgumentException, ObjectNotFoundException
CommunityMembership
specified.
customizationContext
- customization informationmId
- the id of the CommunityMember
whose membership is to be modified.cId
- the id of the Community
for the membership.capability
- the capability to remove from the membership, which is one of the
CommunityMembership.Capability
constants.
RemoteException
IllegalArgumentException
- if the capability specified is not valid.
ObjectNotFoundException
- if the specified community membership does not exist.void setPrimaryMessagingAddress(CustomizationContext customizationContext, CommunityMember member, MessagingAddress m) throws RemoteException, ProfileNotFoundException, PropertyValidationException
MessagingAddress
value into a mapped property in the User Profile
for this CommunityMember
that is used as the primary address for the
MessagingAddressType
specified in the MessagingAddress
.
customizationContext
- customization informationmember
- the CommunityMember
to add the address to.m
- the MessagingAddress value to set
RemoteException
ProfileNotFoundException
PropertyValidationException
void setMessagingAddress(CustomizationContext customizationContext, CommunityMember member, MessagingAddress m, String mappingName) throws RemoteException, ProfileNotFoundException, PropertyValidationException
MessagingAddress
value into a mapped property in the User Profile
for this CommunityMember
that is used as the mapped address for the
MessagingAddressType
specified in the MessagingAddress
.
customizationContext
- customization informationmember
- the CommunityMember
to add the address to.m
- the MessagingAddress value to set
mappingName
- the name of the MessagingAddressMapping
to use to
set the MessagingAddress
RemoteException
ProfileNotFoundException
PropertyValidationException
MessagingAddress getPrimaryMessagingAddress(CustomizationContext customizationContext, CommunityMember member, MessagingAddressType addrType) throws RemoteException, ProfileNotFoundException
MessagingAddress
of a particular type for the specified CommunityMember
.
customizationContext
- customization informationmember
- the CommunityMember
addrType
- the type of MessagingAddress
MessagingAddress
of the specified type, if it exists, otherwise null.
Null is also returned if the specified member does not exist.
RemoteException
ProfileNotFoundException
MessagingAddress getMessagingAddress(CustomizationContext customizationContext, CommunityMember member, MessagingAddressType addrType, String mappingName) throws RemoteException, ProfileNotFoundException
MessagingAddress
of a particular type and mapping name
for the specified CommunityMember
.
customizationContext
- customization informationmember
- the CommunityMember
addrType
- the type of MessagingAddress
MessagingAddress
of the specified type, if it exists, otherwise null.
Null is also returned if the specified member does not exist.
RemoteException
ProfileNotFoundException
Collection<MessagingAddress> getMessagingAddresses(CustomizationContext customizationContext, CommunityMember member, MessagingAddressType addrType) throws RemoteException, ProfileNotFoundException
MessagingAddresses
of a particular type for the specified
CommunityMember
.
customizationContext
- customization informationmember
- the CommunityMember
addrType
- the type of MessagingAddress
.
Collection
of MessagingAddress
objects of the specified type
for the specified CommunityMember
, if they exist, otherwise an empty
Collection
.
RemoteException
ProfileNotFoundException
Collection<MessagingAddress> getAllMessagingAddresses(CustomizationContext customizationContext, CommunityMember member) throws RemoteException, ProfileNotFoundException
MessagingAddresses
associated with the specified
CommunityMember
, as determined by User profile values that are
mapped to Communities MessagingAddresses
.
customizationContext
- customization informationmember
- the CommunityMember
Collection
of all MessagingAddress
objects o
for the specified CommunityMember
, if they exist, otherwise an empty
Collection
.
RemoteException
ProfileNotFoundException
void inviteToCommunity(CustomizationContext customizationContext, InviteeIterator invitees, InvitationDetails inviteDetails, CommunityInviter[] inviters) throws RemoteException
Invitees
to a community, via a specified
set of communications methods. This method is asynchronous- it returns before the
invitations have been sent, allowing large batches of invitations to be sent
in the background without a thread blocking.
customizationContext
- customization informationinvitees
- an InviteeIterator
that can enumerate all users to inviteinviters
- an array of CommunityInviters
which specifies the
various communications channel Inviters
the framework
should use to send the invitations. The array may be empty, meaning that
invitations will be created but no mechanism will be used to inform the
invitee(s) that they have been invited.inviteDetails
- detailed information about the invitation to perform
RemoteException
void synchronousInviteToCommunity(CustomizationContext customizationContext, InviteeIterator invitees, InvitationDetails inviteDetails, CommunityInviter[] inviters) throws RemoteException
Invitees
to a community, via a specified
set of communications methods. This method is synchronous- it blocks until all
invitations have been sent. The inviteToCommunity
method is
asynchronous and will not block.
customizationContext
- customization informationinvitees
- an InviteeIterator
that can enumerate all users to inviteinviters
- an array of CommunityInviters
which specifies the
various communications channel Inviters
the framework
should use to send the invitations. The array may be empty, meaning that
invitations will be created but no mechanism will be used to inform the
invitee(s) that they have been invited.inviteDetails
- detailed information about the invitation to perform
RemoteException
Invitation getInvitation(CustomizationContext customizationContext, String validationText) throws RemoteException
Invitation
by validation text. This is useful for cases where the
Invitee
was an external user and does not yet have a WLS username, and
where the application supplied a unique validation text for each
Invitee
customizationContext
- customization informationvalidationText
-
RemoteException
Invitation getInvitation(CustomizationContext customizationContext, CommunityDefinitionId communityId, String wlsUserName) throws RemoteException
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.
customizationContext
- customization informationcommunityId
- wlsUserName
-
RemoteException
Invitation getInvitation(CustomizationContext customizationContext, InviteeId inviteeId) throws RemoteException
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.
customizationContext
- customization informationinviteeId
-
RemoteException
SortableFilterablePagedResult<Invitation> getInvitations(CustomizationContext customizationContext, InvitationSearchCriteria invitationCriteria, int pageSize) throws RemoteException
Invitations
matching the supplied
InvitationSearchCriteria
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:
customizationContext
- invitationCriteria
- pageSize
- size of pages for
SortableFilterablePagedResult
of Invitations
matching the InvitationSearchCriteria
RemoteException
getInvitationsPage( request) throws RemoteException
request
-
PageFetchResponse used by pagination framework
- Throws
RemoteException
InvitationStatus consumeInvitation(CustomizationContext customizationContext, InviteeId inviteeId, InvitationStatus toStatus) throws RemoteException
Invitation
that is in active status and moves it to
one of the inactive statuses. If the invitation was created with a
self_destruct flag marked true, this will additionally delete the
Invitation
record.
customizationContext
- customization informationinviteeId
- toStatus
-
InvitationStatus
that the system set the
Invitation
to. In the case of either expiration
or prior revocation, this will be the status returned instead
of the input status, so the caller should check to verify
the actual result of the operation.
RemoteException
void removeInvitation(CustomizationContext customizationContext, InviteeId inviteeId) throws RemoteException
Invitation
from the database.
customizationContext
- customization informationinviteeId
- the id of the invitation to delete
RemoteException
void cleanupInactiveInvitations(CustomizationContext customizationContext, CommunityDefinitionId communityId) throws RemoteException
Invitations
from the database for
a specified Community.
customizationContext
- customization informationcommunityId
-
RemoteException
void cleanupAllInactiveInvitations(CustomizationContext customizationContext) throws RemoteException
Invitations
from the database
customizationContext
- customization information
RemoteException
|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |