MembershipCriteria (Oracle Fusion Middleware Java API for Oracle WebLogic Portal)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.bea.netuix.application.communities
Class MembershipCriteria

java.lang.Object
  com.bea.netuix.application.communities.MembershipCriteria

All Implemented Interfaces: SearchCriteria, Serializable

Direct Known Subclasses:: CommunityMembershipCriteria, MemberMembershipCriteria

public abstract class MembershipCriteria
extends Object
implements SearchCriteria
extends Object
implements SearchCriteria

The MembershipCriteria object is used to specify attributes used to find specific CommunityMembership objects. To use this object, construct a new instance, and call any of the set... methods to specify constraints on the search. Only constraints set using a set... method will be used during the search. All specified constraints are used in conjunction (AND rather than OR). Setting some constraints will automatically un-set others, so view the documentation for each set... method to understand the consequences.

For example, to specify a search criteria to find all disabled memberships in a community for users whose username begins with "A", the following would work:

 CommunityMembershipCriteria criteria = new CommunityMembershipCriteria(communityId);
 criteria.setUsername(FilterMethod.BEGINS_WITH, "A");
 criteria.setMembershipActive(false);

To specify a search criteria to find all accessible memberships for a particular member, the following would work:

 MemberMembershipCriteria criteria = new MemberMembershipCriteria(username);
 criteria.setMembershipAccessible(true);

The overview of community functionality contains a description of the community framework.

See Also: MemberMembershipCriteria, CommunityMembershipCriteria, Serialized Form

Field Summary
`static String`	`ORDER_BY_JOIN_DATE` Constant used to indicate the field used to order query results- used in the orderBy() method.
`static String`	`ORDER_BY_LAST_ACCESS_DATE` Constant used to indicate the field used to order query results- used in the orderBy() method.
`static String`	`ORDER_BY_MEMBER_ACTIVE` Constant used to indicate the field used to order query results- used in the orderBy() method.
`static String`	`ORDER_BY_MEMBER_EXTERNAL` Constant used to indicate the field used to order query results- used in the orderBy() method.
`static String`	`ORDER_BY_MEMBERSHIP_ACTIVE` Constant used to indicate the field used to order query results- used in the orderBy() method.
`static String`	`ORDER_BY_USERNAME` Constant used to indicate the field used to order query results- used in the orderBy() method.

Method Summary
`boolean`	`getAccessRecordedCriteria()` Retrieves the access recorded criteria for the search.
`CommunityDefinitionId`	`getCommunityIdCriteria()` Retrieves the community ID criteria for the search.
`Date`	`getJoinedAfterCriteria()` Retrieves the minimum time a membership was created criteria for the search.
`Date`	`getJoinedBeforeCriteria()` Retrieves the maximum time a membership was created criteria for the search.
`Date`	`getLastAccessAfterCriteria()` Retrieves the minimum time a membership was last accessed criteria for the search.
`Date`	`getLastAccessBeforeCriteria()` Retrieves the maximum time a membership was last accessed criteria for the search.
`boolean`	`getMemberActiveCriteria()` Retrieves the member active status criteria for the search.
`boolean`	`getMemberExternalCriteria()` Retrieves the member external status criteria for the search.
`CommunityMemberId`	`getMemberIdCriteria()` Retrieves the member ID criteria for the search.
`boolean`	`getMembershipAccessibleCriteria()` Retrieves the membership accessible status criteria for the search.
`boolean`	`getMembershipActiveCriteria()` Retrieves the membership active status criteria for the search.
`MembershipCapability`	`getMembershipCapabilityCriteria()` Retrieves the membership capability criteria for the search, or null if no membership capability criteria exists.
`boolean`	`getMembershipHasCapabilityCriteria()` Determines if a membership must have or must not have a particular capability (determinable through the getMembershipCapabilityCriteria() method) to be included.
`String`	`getSortOrderField()` Returns one of the ORDER_BY_ constants indicating what field results should be sorted by, or `null` if no sort order has been specified.
`String`	`getUsernameCriteria()` Retrieves the username pattern criteria for the search.
`FilterMethod`	`getUsernameFilterMethod()` Retrieves the username filter method for the username search.
`String`	`getWebAppNameCriteria()` Retrieves the web app name criteria for the search.
`int`	`hashCode()`
`boolean`	`isAccessRecordedCriteria()` Determines if the membership having an access recorded is a criteria for the search.
`boolean`	`isCommunityIdCriteria()` Determines if Community ID is a criteria for the search.
`boolean`	`isJoinedAfterCriteria()` Determines if the time a membership was created after is a criteria for the search.
`boolean`	`isJoinedBeforeCriteria()` Determines if the time a membership was created before is a criteria for the search.
`boolean`	`isLastAccessAfterCriteria()` Determines if the time a membership was last accessed after is a criteria for the search.
`boolean`	`isLastAccessBeforeCriteria()` Determines if the time a membership was last accessed before is a criteria for the search.
`boolean`	`isMemberActiveCriteria()` Determines if member active status is a criteria for the search.
`boolean`	`isMemberExternalCriteria()` Determines if member external status is a criteria for the search.
`boolean`	`isMemberIdCriteria()` Determines if member ID is a criteria for the search.
`boolean`	`isMembershipAccessibleCriteria()` Determines if membership accessibility status is a criteria for the search.
`boolean`	`isMembershipActiveCriteria()` Determines if membership active status is a criteria for the search.
`boolean`	`isMembershipCapabilityCriteria()` Determines if a membership capability is a criteria for the search.
`boolean`	`isSortOrderAscending()` Returns `true` if the sort order for results is ascending, `false` if the sort order is descending.
`boolean`	`isUsernameCriteria()` Determines if username is a criteria for the search.
`boolean`	`isWebAppNameCriteria()` Determines if web app name is a criteria for the search.
`void`	`orderBy(String field, boolean ascending)` Used to specify the order for results to be returned.
`void`	`setAccessRecorded(boolean accessRecorded)` Specifies the last access date status a membership must have to be included.
`void`	`setJoinedAfter(Date joinedAfter)` Specifies the minimum join date a membership can have to be included.
`void`	`setJoinedBefore(Date joinedBefore)` Specifies the maximum join date a membership can have to be included.
`void`	`setLastAccessAfter(Date lastAccessAfter)` Specifies the minimum last access date a membership can have to be included.
`void`	`setLastAccessBefore(Date lastAccessBefore)` Specifies the maximum last access date a membership can have to be included.
`void`	`setMembershipAccessible(boolean accessible)` Specifies the that the membership accessibility status CommunityMembership must match to be included.
`void`	`setMembershipActive(boolean active)` Specifies the membership active status a CommunityMembership must match to be included.
`void`	`setMembershipCapability(MembershipCapability capability, boolean hasCapability)` Specifies a membership capability a membership must have or must not have to be included.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Field Detail