|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This is a specialized query to search for Emails and EmailSubparts (attachments)
at the same time. This is similar to using the MixedTypesQuery interface and
including these two types of objects. The results come back in a mixed type
query format. <qryresultrow>
elements reference each Email
or EmailSubpart that matches the query. It is returned in this format because
of the possibility that a particular Email might be returned because it matches
the query or it is being provided only as context for an EmailSubpart that matches
the query. To be consistent, all object elements are located outside the
<objectset>
element and the <qryresultrow>
elements
reference the actual matching objects.
This interface provides the additional functionality of searching for EmailSubpart
objects based on properties of their parent Email objects (setEmailPropertyCriteria()
).
You can also choose to search only for Email objects or only for EmailSubpart
objects. If you search only for EmailSubpart objects you can still search
based on properties of the parent Email objects.
If you search only for Email objects, you have essentially the same features
available through the general SingleCollaborationTypeQuery
interface.
You may still choose to use this interface in that case for code consistency
issues.
Fields inherited from interface com.filenet.bso.api.collaboration.query.CollaborationQuery |
TEAMSPACE_TEMPLATE_FILTER, TEAMSPACE_TEMPLATE_IGNORE, TEAMSPACE_TEMPLATE_RETURN, VERSION_CONTROL_ALL, VERSION_CONTROL_ALLCHECKEDIN, VERSION_CONTROL_ALLMAJOR, VERSION_CONTROL_CURRENT, VERSION_CONTROL_RELEASED |
Method Summary | |
PropertyCriteriaNode |
getEmailPropertyCriteria()
Returns the criteria specified with setEmailPropertyCriteria() . |
java.lang.String[] |
getEmailRequestProperties()
Returns the properties specified with setEmailRequestProperties() . |
java.lang.String[] |
getSubpartRequestProperties()
Returns the properties specified with setSubpartRequestProperties() . |
boolean |
isIncludeEmails()
Indicates if Email objects are included in the query. |
boolean |
isIncludeSubparts()
Indicates if EmailSubpart objects are included in the query. |
boolean |
isProvideParentEmailContext()
Indicates if parent Email context is requested. |
void |
setEmailPropertyCriteria(PropertyCriteriaNode node)
Species some property based search criteria for email objects. |
void |
setEmailRequestProperties(java.lang.String[] requestProps)
Specifies what properties are to be returned for Email objects. |
void |
setIncludeEmails(boolean include)
Specifies if Email objects are included in the query. |
void |
setIncludeSubparts(boolean include)
Specifies if EmailSubpart objects are included in the query. |
void |
setProvideParentEmailContext(boolean provide)
Requests that context be returned for the parent Email of each EmailSubpart. |
void |
setSubpartRequestProperties(java.lang.String[] requestProps)
Specifies what properties are to be returned for EmailSubpart objects. |
Methods inherited from interface com.filenet.bso.api.collaboration.query.CollaborationQuery |
execute, getMaximumResults, getObjectStoreId, getOrdering, getPropertyCriteria, getUserID, setMaximumResults, setObjectStoreId, setOrdering, setPropertyCriteria, setUserID |
Methods inherited from interface com.filenet.bso.api.collaboration.query.ContentCapableQuery |
getContentCriteria, isRankResults, isSearchContent, setContentCriteria, setRankResults, setSearchContent |
Methods inherited from interface com.filenet.bso.api.collaboration.query.TeamspaceScopeCapableQuery |
getSingleTeamspaceId, getTeamspaceRequestProperties, getTeamspaceTemplateOption, isProvideTeamspaceContext, isSearchEntireObjectStore, isSearchSingleTeamspace, setProvideTeamspaceContext, setSearchEntireObjectStore, setSearchSingleTeamspace, setTeamspaceRequestProperties, setTeamspaceTemplateOption |
Method Detail |
public void setIncludeEmails(boolean include)
public boolean isIncludeEmails()
public void setIncludeSubparts(boolean include)
public boolean isIncludeSubparts()
public void setEmailRequestProperties(java.lang.String[] requestProps)
public java.lang.String[] getEmailRequestProperties()
setEmailRequestProperties()
.public void setSubpartRequestProperties(java.lang.String[] requestProps)
public java.lang.String[] getSubpartRequestProperties()
setSubpartRequestProperties()
.public void setEmailPropertyCriteria(PropertyCriteriaNode node)
Species some property based search criteria for email objects. This applies
either to Email objects themselves, that otherwise match the search criteria,
or the parent Emails of EmailSubpart objects. For example, a content based
search criteria, specified with setContentCriteria()
, may match
a certain number of Email and EmailSubpart objects.
An Email specific criteria specified with this method further
filters those matching Email objects. It filters EmailSubpart objects however,
based on their parent Email objects. It is possible to match an EmailSubpart
object, because it matched both content criteria and this criteria, even
though the Email object itself didn't match the content criteria.
The main property based search criteria, specified with setPropertyCriteria()
,
applies to both Email and EmailSubpart objects. To be useful you would
want to use only properties common to both kinds of objects -- DateCreated
,
etc.
This method allows you to search for EmailSubpart objects, based on the properties of their parent Email objects.
If searching only for Email objects, specifying a criteria with this method
and a criteria with setPropertyCriteria()
is the same as specifying
both criteria ANDed together.
public PropertyCriteriaNode getEmailPropertyCriteria()
setEmailPropertyCriteria()
.public void setProvideParentEmailContext(boolean provide)
public boolean isProvideParentEmailContext()
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |