|
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 |
java.lang.Object com.bea.netuix.application.communities.MembershipCriteria
public abstract class MembershipCriteria
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.
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.
MemberMembershipCriteria
,
CommunityMembershipCriteria
,
Serialized FormField 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 |
---|
public static final String ORDER_BY_USERNAME
public static final String ORDER_BY_MEMBER_ACTIVE
public static final String ORDER_BY_MEMBER_EXTERNAL
public static final String ORDER_BY_MEMBERSHIP_ACTIVE
public static final String ORDER_BY_LAST_ACCESS_DATE
public static final String ORDER_BY_JOIN_DATE
Method Detail |
---|
public void orderBy(String field, boolean ascending)
field
- one of the ORDER_BY_ constants indicating which field to order
results by, or null
if no sorting is to be used.ascending
- if true
, results will be ordered in an ascending
manner, otherwise they will be ordered in a descending manner.
IllegalArgumentException
- if the field
argument is not one
of the ORDER_BY_ constants or null
.public String getSortOrderField()
null
if no sort order has been specified.
null
if no sort order has been specified.public boolean isSortOrderAscending()
true
if the sort order for results is ascending,
false
if the sort order is descending. Sorting is done only if the
getSortOrderField()
method does not return null.
true
if the sort order for results is ascending,
false
if the sort order is descending.public void setMembershipActive(boolean active)
active
- if true
, only memberships whose membership status is active
will be included;
if false
, only memberships whose membership status is NOT active
will be included.public void setMembershipAccessible(boolean accessible)
accessible
- if true
, only memberships which are accessible (where
both member and membership status is active) will be included;
if false
, only memberships which are not accessible (where either
member or membership status is disabled) will be included.public void setMembershipCapability(MembershipCapability capability, boolean hasCapability)
capability
- the MembershipCapability to filter on. If null, no capability
filter is performed.hasCapability
- if true
, a membership must have the specified
capability to be included; if false
, a membership must NOT have
the specified capability to be included.public void setLastAccessBefore(Date lastAccessBefore)
lastAccessBefore
- the maximum last access date a membership may have to be
included. If null, there is no maximum last access date limit on search results.public void setLastAccessAfter(Date lastAccessAfter)
lastAccessAfter
- the minimum last access date a membership may have to be
included. If null, there is no minimum last access date limit on search results.public void setAccessRecorded(boolean accessRecorded)
accessRecorded
- if true
, only memberships for which a last access
date has been recorded will be included; if false
, only memberships
with no access date recorded will be included.public void setJoinedBefore(Date joinedBefore)
joinedBefore
- the maximum join date a membership may have to be
included. If null, there is no maximum join date limit on search results.public void setJoinedAfter(Date joinedAfter)
joinedAfter
- the minimum join date a membership may have to be
included. If null, there is no minimum join date limit on search results.public boolean isCommunityIdCriteria()
true
if community ID is a criteria to be used,
false
if not.public CommunityDefinitionId getCommunityIdCriteria()
null
if
community ID is not a criteria in the search.public boolean isMemberIdCriteria()
true
if member ID is a criteria to be used,
false
if not.public CommunityMemberId getMemberIdCriteria()
null
if
member ID is not a criteria in the search.public boolean isWebAppNameCriteria()
true
if web app name is a criteria to be used,
false
if not.public String getWebAppNameCriteria()
null
if
web app name is not a criteria in the search.public boolean isUsernameCriteria()
true
if username is a criteria to be used,
false
if not.public String getUsernameCriteria()
null
if
username is not a criteria in the search.public FilterMethod getUsernameFilterMethod()
null
if
username is not a criteria in the search.public boolean isMemberActiveCriteria()
true
if member active status is a criteria to be used,
false
if not.public boolean getMemberActiveCriteria()
false
is returned. To
determine whether the member active status is a criteria for the search,
use the isMemberActiveCriteria() method.public boolean isMemberExternalCriteria()
true
if member external status is a criteria to be used,
false
if not.public boolean getMemberExternalCriteria()
false
is returned. To
determine whether the member external status is a criteria for the search,
use the isMemberExternalCriteria() method.public boolean isMembershipActiveCriteria()
true
if membership active status is a criteria to be used,
false
if not.public boolean getMembershipActiveCriteria()
false
is returned. To
determine whether the membership active status is a criteria for the search,
use the isMembershipActiveCriteria() method.public boolean isMembershipAccessibleCriteria()
true
if membership accessibility status is a criteria to be used,
false
if not.public boolean getMembershipAccessibleCriteria()
false
is returned. To
determine whether the membership accessible status is a criteria for the search,
use the isMembershipAccessibleCriteria() method.public boolean isMembershipCapabilityCriteria()
true
if a membership having (or not having) a particular
capability is a criteria to be used, false
otherwise.public MembershipCapability getMembershipCapabilityCriteria()
public boolean getMembershipHasCapabilityCriteria()
true
if memberships must have the capability specified by the
getMembershipCapabilityCriteria() method in order to be included,
false
otherwise.public boolean isLastAccessBeforeCriteria()
true
if the time a membership was last accessed before is a
criteria to be used, false
if not.public Date getLastAccessBeforeCriteria()
null
if no maximum last access time is a criteria in the search.public boolean isLastAccessAfterCriteria()
true
if the time a membership was last accessed after is a
criteria to be used, false
if not.public Date getLastAccessAfterCriteria()
null
if no minimum last access time is a criteria in the search.public boolean isAccessRecordedCriteria()
true
if the membership having an access recorded is a criteria
for the search, false
if not.public boolean getAccessRecordedCriteria()
true
if memberships must have a recorded last access time to be
included in search results, false
otherwise.public boolean isJoinedBeforeCriteria()
true
if the time a membership was created before is a
criteria to be used, false
if not.public Date getJoinedBeforeCriteria()
null
if no maximum created time is a criteria in the search.public boolean isJoinedAfterCriteria()
true
if the time a membership was created after is a
criteria to be used, false
if not.public Date getJoinedAfterCriteria()
null
if no minimum created time is a criteria in the search.public int hashCode()
hashCode
in class Object
|
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 |