com.atlassian.crowd.search.query.membership
Class MembershipQuery<T>

java.lang.Object
  com.atlassian.crowd.search.query.membership.MembershipQuery<T>

All Implemented Interfaces:

Query<T>

Direct Known Subclasses:

GroupMembershipQuery, GroupMembersOfGroupQuery, UserMembershipQuery, UserMembersOfGroupQuery

public class MembershipQuery<T>
extends java.lang.Object
implements Query<T>

Constructor Summary

MembershipQuery(java.lang.Class<T> returnType, boolean findChildren, EntityDescriptor entityToMatch, java.lang.String entityNameToMatch, EntityDescriptor entityToReturn, int startIndex, int maxResults)

MembershipQuery(MembershipQuery<T> query, int startIndex, int maxResults)

MembershipQuery(MembershipQuery query, java.lang.Class<T> returnType)

Method Summary

boolean	equals(java.lang.Object o)
java.lang.String	getEntityNameToMatch()
EntityDescriptor	getEntityToMatch()
EntityDescriptor	getEntityToReturn()
int	getMaxResults() The maximum number of elements to return.
java.lang.Class<T>	getReturnType() The type of elements to return.
SearchRestriction	getSearchRestriction() Restrictions to apply to the query.
int	getStartIndex() The index of the first element to return.
int	hashCode()
boolean	isFindChildren()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MembershipQuery

public MembershipQuery(java.lang.Class<T> returnType,
                       boolean findChildren,
                       EntityDescriptor entityToMatch,
                       java.lang.String entityNameToMatch,
                       EntityDescriptor entityToReturn,
                       int startIndex,
                       int maxResults)

MembershipQuery

public MembershipQuery(MembershipQuery<T> query,
                       int startIndex,
                       int maxResults)

MembershipQuery

public MembershipQuery(MembershipQuery query,
                       java.lang.Class<T> returnType)

Method Detail

getEntityToReturn

public EntityDescriptor getEntityToReturn()

getEntityToMatch

public EntityDescriptor getEntityToMatch()

isFindChildren

public boolean isFindChildren()

getEntityNameToMatch

public java.lang.String getEntityNameToMatch()

getStartIndex

public int getStartIndex()

Description copied from interface: Query

The index of the first element to return.

Specified by:

getStartIndex in interface Query<T>

Returns:

a positive index value.

getMaxResults

public int getMaxResults()

Description copied from interface: Query

The maximum number of elements to return.

Specified by:

getMaxResults in interface Query<T>

Returns:

a number of elements.

getReturnType

public java.lang.Class<T> getReturnType()

Description copied from interface: Query

The type of elements to return.

Specified by:

getReturnType in interface Query<T>

Returns:

the expected type of elements to be returned by the search.

getSearchRestriction

public SearchRestriction getSearchRestriction()

Description copied from interface: Query

Restrictions to apply to the query. Typically finding users of a given name, etc.

Specified by:

getSearchRestriction in interface Query<T>

Returns:

the search resctiction to apply to this query.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object