Collaboration API Documentation

com.filenet.bso.api.collaboration.query
Interface ContentCapableQuery

All Known Subinterfaces:
EmailsQuery, ForumsQuery, MeetingsQuery, MixedTypesQuery, NormalDocumentsQuery, PollsQuery, ReplyPostingsQuery, SingleCollaborationTypeQuery, TeamspacesQuery, TopicPostingsQuery

public interface ContentCapableQuery

Contains methods related to content based searching.


Method Summary
 ContentCriteriaNode getContentCriteria()
          Returns the search criteria specified using setContentCriteria().
 boolean isRankResults()
          Indicates if results are to be ranked.
 boolean isSearchContent()
          Indicates if content based searching is enabled.
 void setContentCriteria(ContentCriteriaNode node)
          Sets the content based search criteria.
 void setRankResults(boolean rank)
          Setting this option enables the results to be ranked.
 void setSearchContent(boolean enable)
          Enables or disables content based search.
 

Method Detail

setSearchContent

public void setSearchContent(boolean enable)
Enables or disables content based search. If enabled, other options must be specified such as setContentCriteria() before the query is considered complete.
Parameters:
enable - If true, content searching is enabled, otherwise it is disabled.

isSearchContent

public boolean isSearchContent()
Indicates if content based searching is enabled.

setRankResults

public void setRankResults(boolean rank)
Setting this option enables the results to be ranked. A rank value will be returned in the results and the results will be ordered according to rank. This ordering takes precedence over any property based order options specified. This option has no effect unless content based searching is enabled in general with setSearchContent(true).

isRankResults

public boolean isRankResults()
Indicates if results are to be ranked.

setContentCriteria

public void setContentCriteria(ContentCriteriaNode node)
Sets the content based search criteria. This criteria will be merged in with the rest of the criteria implied by other options that have been set. Currently the criteria is only a single node, consisting of a CONTAINS or FREETEXT condition. In the future this may support a hierarchy of and/or operators and verity modifiers (e.g. Near, Phrase), that would be appropriate for a designer application to generate. The node passed to this method is obtained from the factory method CollaborationQuery.getContentCriteriaNode(). This option has no effect unless content based searching is enabled in general with setSearchContent(true).

getContentCriteria

public ContentCriteriaNode getContentCriteria()
Returns the search criteria specified using setContentCriteria().

Collaboration API Documentation

Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.