com.atlassian.jira.sharing.type
Class GroupShareQueryFactory

java.lang.Object
  extended by com.atlassian.jira.sharing.type.GroupShareQueryFactory
All Implemented Interfaces:
ShareQueryFactory<GroupShareTypeSearchParameter>

public class GroupShareQueryFactory
extends java.lang.Object
implements ShareQueryFactory<GroupShareTypeSearchParameter>

Since:
v3.13

Constructor Summary
GroupShareQueryFactory()
           
 
Method Summary
 org.apache.lucene.document.Field getField(SharedEntity entity, SharePermission permission)
          Get the Field we will later search for.
 org.apache.lucene.search.Query getQuery(ShareTypeSearchParameter searchParameter)
          Get the search query for all shares shares that match the passed parameter.
 org.apache.lucene.search.Query getQuery(ShareTypeSearchParameter searchParameter, com.opensymphony.user.User user)
          Get the search query for the shares that can be seen by the passed user for the passed parameter.
 org.apache.lucene.index.Term[] getTerms(com.opensymphony.user.User user)
          Get the search terms for the shares that can be seen by the passed user.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupShareQueryFactory

public GroupShareQueryFactory()
Method Detail

getQuery

public org.apache.lucene.search.Query getQuery(ShareTypeSearchParameter searchParameter,
                                               com.opensymphony.user.User user)
Description copied from interface: ShareQueryFactory
Get the search query for the shares that can be seen by the passed user for the passed parameter. Used when the user has specified something to search for.

Specified by:
getQuery in interface ShareQueryFactory<GroupShareTypeSearchParameter>
Parameters:
searchParameter - the parameters for the search.
user - the user to perform the search on behalf of.
Returns:
an array of Terms. It may be empty but never null.

getQuery

public org.apache.lucene.search.Query getQuery(ShareTypeSearchParameter searchParameter)
Description copied from interface: ShareQueryFactory
Get the search query for all shares shares that match the passed parameter. Used by the system to match all entities that match the parameter, for instance when deleting Group, Project or Role.

Specified by:
getQuery in interface ShareQueryFactory<GroupShareTypeSearchParameter>
Parameters:
searchParameter - the parameters for the search.
Returns:
an array of Terms. It may be empty but never null.

getTerms

public org.apache.lucene.index.Term[] getTerms(com.opensymphony.user.User user)
Description copied from interface: ShareQueryFactory
Get the search terms for the shares that can be seen by the passed user.

Specified by:
getTerms in interface ShareQueryFactory<GroupShareTypeSearchParameter>
Parameters:
user - the user to perform the search on behalf of.
Returns:
an array of Terms. It may be empty but never null.

getField

public org.apache.lucene.document.Field getField(SharedEntity entity,
                                                 SharePermission permission)
Description copied from interface: ShareQueryFactory
Get the Field we will later search for.

Specified by:
getField in interface ShareQueryFactory<GroupShareTypeSearchParameter>
Returns:
the field so we can add it to the index


Copyright © 2002-2010 Atlassian. All Rights Reserved.