com.bea.apps.groupspace.search.controls
Interface CommunitySearchControl

All Known Subinterfaces:
GsKeywordSearchControl

public interface CommunitySearchControl

This base interface contains methods that may be used by GroupSpace and non-GroupSpace communities.

Instantiate the control in a page flow as follows:


@Control
CommunitySearchControlBean gsKeywordSearchControl;


Nested Class Summary
static interface CommunitySearchControl.CommunitySearchParams
          Scope the search
 
Method Summary
 com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.communities.CommunityMembership> findAllMemberships()
          Find all memberships of this community
 com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.communities.CommunityMembership> findAllMemberships(com.bea.netuix.application.definition.CommunityDefinition cdef)
          Find all memberships of the named community
 com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.portlet.GenericURL> getEligibleToJoinCommunities(com.bea.netuix.application.communities.MemberMembershipCriteria criteria)
          Find all GroupSpace communites that I don't belong to, but am eligible to join.
 com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.communities.CommunityMembership> getMembershipsForCapability(com.bea.netuix.application.communities.MembershipCapability msc)
          Get the Set of CommunityMemberships having this MembershipCapability
 com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.portlet.GenericURL> getMyCommunityURLs(com.bea.netuix.application.communities.MemberMembershipCriteria criteria)
          Find all communities of which this user is a member.
 com.bea.p13n.pagination.SortableFilterablePagedResult<String> getMyCommunityURLsAsString(com.bea.netuix.application.communities.MemberMembershipCriteria criteria)
          Find all communities of which I'm a member.
 com.bea.netuix.application.communities.notifications.CommunityMembershipsEnumerator getUsernamesForCapability(com.bea.netuix.application.communities.MembershipCapability msc)
          Get the list of usernames of memberships in this community having this MembershipCapability.
 

Method Detail

getUsernamesForCapability

com.bea.netuix.application.communities.notifications.CommunityMembershipsEnumerator getUsernamesForCapability(com.bea.netuix.application.communities.MembershipCapability msc)
                                                                                                              throws Exception
Get the list of usernames of memberships in this community having this MembershipCapability.

Parameters
msc -
Throws
Exception

getMembershipsForCapability

com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.communities.CommunityMembership> getMembershipsForCapability(com.bea.netuix.application.communities.MembershipCapability msc)
                                                                                                                                              throws Exception
Get the Set of CommunityMemberships having this MembershipCapability

Throws
Exception

findAllMemberships

com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.communities.CommunityMembership> findAllMemberships()
                                                                                                                                     throws Exception
Find all memberships of this community

Throws
Exception

findAllMemberships

com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.communities.CommunityMembership> findAllMemberships(com.bea.netuix.application.definition.CommunityDefinition cdef)
                                                                                                                                     throws Exception
Find all memberships of the named community

Throws
Exception

getMyCommunityURLs

com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.portlet.GenericURL> getMyCommunityURLs(com.bea.netuix.application.communities.MemberMembershipCriteria criteria)
                                                                                                     throws Exception
Find all communities of which this user is a member. Return a set of community GenericURLs

Throws
Exception

getEligibleToJoinCommunities

com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.portlet.GenericURL> getEligibleToJoinCommunities(com.bea.netuix.application.communities.MemberMembershipCriteria criteria)
                                                                                                               throws Exception
Find all GroupSpace communites that I don't belong to, but am eligible to join. Return null if there are none. Throw an exception if anonymous user tries to use this.

Throws
Exception

getMyCommunityURLsAsString

com.bea.p13n.pagination.SortableFilterablePagedResult<String> getMyCommunityURLsAsString(com.bea.netuix.application.communities.MemberMembershipCriteria criteria)
                                                                                         throws Exception
Find all communities of which I'm a member. Return a set of community GenericURLs

Throws
Exception


Copyright © 2006 BEA Systems, Inc. All Rights Reserved