|
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 |
@ControlInterface public interface CommunityMemberControl
Control for Community member functionality. The method for creating a community membership is not exposed through this control, as creating a community membership should probably be done exclusively in a community registration page, for the currently authenticated user.
Method Summary | |
---|---|
void |
activateMember(CommunityMemberId id,
ResourceContext context)
Activates a disabled CommunityMember globally for all Communities. |
void |
activateMembership(CommunityMemberId mId,
CommunityDefinitionId cId,
ResourceContext context)
Activates a CommunityMembership in the specified CommunityDefinition ,
making a disabled member able to use the community once again. |
void |
addMembershipCapability(CommunityMemberId mId,
CommunityDefinitionId cId,
MembershipCapability capability,
ResourceContext context)
Adds a capability (owner, leader or manager) to the CommunityMembership
specified. |
void |
disableMember(CommunityMemberId id,
ResourceContext context)
Disables a CommunityMember globally for all Communities. |
void |
disableMembership(CommunityMemberId mId,
CommunityDefinitionId cId,
ResourceContext context)
Disables a CommunityMembership . |
SortableFilterablePagedResult<CommunityMembership> |
getCommunityMemberships(int pageSize,
CommunityDefinitionId communityId,
ResourceContext context)
Retrieves a paginated set of all memberships for the specified community. |
SortableFilterablePagedResult<CommunityMembership> |
getCommunityMemberships(int pageSize,
MembershipCriteria criteria,
ResourceContext context)
Retrieves a paginated set of all memberships matching the specified criteria. |
CommunityMember |
getMember(CommunityMemberId memberId,
ResourceContext context)
Retrieves a CommunityMember object populated with
information for the CommunityMember specified by CommunityMemberId . |
CommunityMember |
getMember(String userId,
ResourceContext context)
Retrieves a CommunityMember object populated with
information for the CommunityMember specified by id. |
CommunityMembership |
getMembership(CommunityMemberId mId,
CommunityDefinitionId cId,
ResourceContext context)
Returns the CommunityMembership information for a CommunityMember ,
if they have a membership in the specified community. |
CommunityMembership |
getMembership(String username,
CommunityDefinitionId cId,
ResourceContext context)
Returns the CommunityMembership information for a user
if they have a membership in the specified community. |
void |
removeCommunityMembership(CommunityMemberId communityMemberId,
CommunityDefinitionId communityDefinitionId,
ResourceContext context)
Removes a Community Membership |
void |
removeMember(CommunityMemberId id,
ResourceContext context)
Removes a CommunityMember globally for all Communities. |
void |
removeMembershipCapability(CommunityMemberId mId,
CommunityDefinitionId cId,
MembershipCapability capability,
ResourceContext context)
Removes a capability (owner, leader or manager) from the CommunityMembership
specified. |
Method Detail |
---|
SortableFilterablePagedResult<CommunityMembership> getCommunityMemberships(int pageSize, CommunityDefinitionId communityId, ResourceContext context) throws ToolsException
pageSize
- the number of memberships to return per pagecommunityId
- the definition ID of the community to get memberships for.context
- a resource context
ToolsException
SortableFilterablePagedResult<CommunityMembership> getCommunityMemberships(int pageSize, MembershipCriteria criteria, ResourceContext context) throws ToolsException
pageSize
- the number of memberships to return per pagecriteria
- an object specifiying search criteria for memberships to be returnedcontext
- a resource context
ToolsException
void removeCommunityMembership(CommunityMemberId communityMemberId, CommunityDefinitionId communityDefinitionId, ResourceContext context) throws ToolsException, ObjectNotFoundException
communityMemberId
- communityDefinitionId
- context
- the resource context
ObjectNotFoundException
ToolsException
CommunityMember getMember(String userId, ResourceContext context) throws ToolsException
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.
userId
- the WLS user id of the CommunityMember
to look upcontext
- the resource context
CommunityMember
object populated with information
for the specified CommunityMember
if they exist,
otherwise null
.
ToolsException
CommunityMember getMember(CommunityMemberId memberId, ResourceContext context) throws ToolsException
CommunityMember
object populated with
information for the CommunityMember
specified by CommunityMemberId
. If
deepInfo is set to true, CommunityMembership
information is also
retrieved and contained within the CommunityMember
return value.
memberId
- the CommunityMemberId
of the user id of the
CommunityMember
to look upcontext
- the resource context
CommunityMember
object populated with information
for the specified CommunityMember
if they exist,
otherwise null
.
ToolsException
void disableMember(CommunityMemberId id, ResourceContext context) throws ObjectNotFoundException, ToolsException
CommunityMember
globally for all Communities.
id
- the id of the CommunityMember
to disable.context
- the resource context
ObjectNotFoundException
- if the specified member does not exist in the
database.
ToolsException
void activateMember(CommunityMemberId id, ResourceContext context) throws ObjectNotFoundException, ToolsException
CommunityMember
globally for all Communities.
id
- the id of the CommunityMember
to activate.context
- the resource context
ObjectNotFoundException
- if the specified member does not exist in the
database.
ToolsException
void removeMember(CommunityMemberId id, ResourceContext context) throws ObjectNotFoundException, ToolsException
CommunityMember
globally for all Communities.
id
- the id of the CommunityMember
to remove.context
- the resource context
ObjectNotFoundException
- if the specified member does not exist in the
database.
ToolsException
void disableMembership(CommunityMemberId mId, CommunityDefinitionId cId, ResourceContext context) throws ObjectNotFoundException, ToolsException
CommunityMembership
.
mId
- the id of the CommunityMember
cId
- the id of the CommunityDefinition
context
- the resource context
ObjectNotFoundException
- if no membership for the specified community
and member exists.
ToolsException
void activateMembership(CommunityMemberId mId, CommunityDefinitionId cId, ResourceContext context) throws ObjectNotFoundException, ToolsException
CommunityMembership
in the specified CommunityDefinition
,
making a disabled member able to use the community once again.
mId
- the id of the CommunityMember
cId
- the id of the CommunityDefinition
context
- the resource context
ObjectNotFoundException
- if no membership for the specified community
and member exists.
ToolsException
CommunityMembership getMembership(CommunityMemberId mId, CommunityDefinitionId cId, ResourceContext context) throws ToolsException
CommunityMembership
information for a CommunityMember
,
if they have a membership in the specified community.
mId
- the id of the CommunityMember
cId
- the id of the CommunityDefinition
context
- the resource context
CommunityMembership
object populated with membership information
for the specified CommunityMember
, if it exists, otherwise null.
ToolsException
CommunityMembership getMembership(String username, CommunityDefinitionId cId, ResourceContext context) throws ToolsException
CommunityMembership
information for a user
if they have a membership in the specified community.
username
- the WLS username of the usercId
- the id of the CommunityDefinition
context
- the resource context
CommunityMembership
object populated with membership information
for the specified user, if it exists, otherwise null.
ToolsException
void addMembershipCapability(CommunityMemberId mId, CommunityDefinitionId cId, MembershipCapability capability, ResourceContext context) throws ToolsException, IllegalArgumentException, ObjectNotFoundException
CommunityMembership
specified.
mId
- 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.context
- the resource context
IllegalArgumentException
- if the capability specified is not valid.
ObjectNotFoundException
- if the specified community membership does not exist.
ToolsException
void removeMembershipCapability(CommunityMemberId mId, CommunityDefinitionId cId, MembershipCapability capability, ResourceContext context) throws ToolsException, IllegalArgumentException, ObjectNotFoundException
CommunityMembership
specified.
mId
- 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.context
- the resource context
IllegalArgumentException
- if the capability specified is not valid.
ObjectNotFoundException
- if the specified community membership does not exist.
ToolsException
|
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 |