Collaboration API Documentation

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

All Known Subinterfaces:
MeetingsQuery, PollsQuery

public interface DependentObjectsCapableQuery

An interface that allows dependent objects to contribute to the query. A dependent object is some object subsidiary to the main objects being searched. The exact type of object is different for different main objects. For example, the dependent object of a Poll object is the PollResponse object. Through this interface you can retrieve dependent objects as a context for each main object. You can also specify additional property-based search criteria for the main objects based on the dependent objects that belong to those main objects. This second search criteria can optionally be ORred with the main criteria (the default is for the two sets of criteria to be ANDed). Any content-based search criteria is still ANDed with one or both property-based search criteria.


Method Summary
 PropertyCriteriaNode getDependentObjectPropertyCriteria()
          Gets the property based search criteria specified with setDependentObjectPropertyCriteria().
 java.lang.String[] getDependentObjectRequestProperties()
          Returns the properties specified with setDependentObjectRequestProperties().
 boolean isDependentObjectPropertyCriteriaOrredWithMain()
          Indicates if property based search criteria for dependent objects and main objects are ORred together, as specified with setDependentObjectPropertyCriteriaOrredWithMain().
 boolean isProvideDependentObjects()
          Indicates if dependent object information is to be returned as specified with setProvideDependentObjects().
 void setDependentObjectPropertyCriteria(PropertyCriteriaNode node)
          Specifies a property-based search criteria controlling what main objects to return, based on the dependent objects that match this criteria.
 void setDependentObjectPropertyCriteriaOrredWithMain(boolean orred)
          Specifies whether the property-based search criteria that is applied to dependent objects is ORred or ANDed with the main object criteria.
 void setDependentObjectRequestProperties(java.lang.String[] requestProps)
          Requests properties to return for each dependent object.
 void setProvideDependentObjects(boolean provide)
          Specifies whether to return dependent object information for each main object.
 

Method Detail

setProvideDependentObjects

public void setProvideDependentObjects(boolean provide)
Specifies whether to return dependent object information for each main object.

isProvideDependentObjects

public boolean isProvideDependentObjects()
Indicates if dependent object information is to be returned as specified with setProvideDependentObjects().

setDependentObjectRequestProperties

public void setDependentObjectRequestProperties(java.lang.String[] requestProps)
Requests properties to return for each dependent object.

getDependentObjectRequestProperties

public java.lang.String[] getDependentObjectRequestProperties()
Returns the properties specified with setDependentObjectRequestProperties().

setDependentObjectPropertyCriteria

public void setDependentObjectPropertyCriteria(PropertyCriteriaNode node)
Specifies a property-based search criteria controlling what main objects to return, based on the dependent objects that match this criteria. The main criteria, specified with CollaborationQuery.setPropertyCriteria(), is applied to the main objects themselves. This criteria is applied to the dependent objects and causes the main objects to be returned that have dependent objects that match this criteria. This criteria can be either ANDed or ORred with the main criteria as determined by setDependentObjectPropertyCriteriaOrredWithMain().

getDependentObjectPropertyCriteria

public PropertyCriteriaNode getDependentObjectPropertyCriteria()
Gets the property based search criteria specified with setDependentObjectPropertyCriteria().

setDependentObjectPropertyCriteriaOrredWithMain

public void setDependentObjectPropertyCriteriaOrredWithMain(boolean orred)
Specifies whether the property-based search criteria that is applied to dependent objects is ORred or ANDed with the main object criteria. By default, the two criterias will be ANDed together unless this method is called with true. Any content-based search criteria specified with ContentCapableQuery.setContentCriteria() is still ANDed with the overall search criteria. This method allows the two property-based search criterias to be ORred together before ANDing with the overall search criteria.

isDependentObjectPropertyCriteriaOrredWithMain

public boolean isDependentObjectPropertyCriteriaOrredWithMain()
Indicates if property based search criteria for dependent objects and main objects are ORred together, as specified with setDependentObjectPropertyCriteriaOrredWithMain().

Collaboration API Documentation

Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.