Collaboration API Documentation

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

All Superinterfaces:
CollaborationQuery, ContentCapableQuery, TeamspaceScopeCapableQuery, VersionCapableQuery

public interface MixedTypesQuery
extends CollaborationQuery, ContentCapableQuery, VersionCapableQuery, TeamspaceScopeCapableQuery

An interface to query for multiple types of objects.


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
 java.lang.String[] getCollaborationParentDocumentDefaultRequestProperties()
          Returns the properties specified with setCollaborationParentDocumentDefaultRequestProperties().
 java.lang.String[] getCollaborationParentFolderDefaultRequestProperties()
          Returns the properties specified with setCollaborationParentFolderDefaultRequestProperties().
 java.lang.String[] getCollaborationParentTypeRequestProperties(int collabType)
          Returns the properties specified with setCollaborationParentTypeSpecifics().
 int[] getCollaborationParentTypesWithSpecifics()
          Returns all the collaboration types for which details have been specified.
 java.lang.String[] getCollaborationTypeRequestProperties(int collabType)
          Returns the properties that were specified with setCollaborationTypeRequestProperties().
 java.lang.String[] getCustomObjectDefaultRequestProperties()
          Returns the properties that were specified with setCustomObjectDefaultRequestProperties().
 java.lang.String[] getDocumentDefaultRequestProperties()
          Returns the properties that were specified with setDocumentDefaultRequestProperties().
 java.lang.String[] getFolderDefaultRequestProperties()
          Returns the properties that were specified with setFolderDefaultRequestProperties().
 int[] getIncludedCollaborationTypes()
          Returns all the collaboration types that are included in the search.
 java.lang.String[] getNormalDocumentRequestProperties()
          Returns the properties specified with setNormalDocumentRequestProperties().
 boolean hasCollaborationParentTypeSpecifics(int collabType)
          Indicates if details have been specified for this collaboration type.
 boolean isIncludeCollaborationType(int collabType)
          Indicates if a collaboration type is included in the search.
 boolean isIncludeNormalDocuments()
          Indicates if non-collaboration documents are included in the search.
 boolean isProvideCollaborationParentContext()
          Indicates if collaboration parent context was requested by calling setProvideCollaborationParentContext.
 void removeCollaborationParentTypeSpecifics(int collabType)
          Removes the details for a collaboration type that was previously set using setCollaborationParentTypeSpecifics.
 void setCollaborationParentDocumentDefaultRequestProperties(java.lang.String[] requestProps)
          Specifies default properties to return for collaboration parents that are documents.
 void setCollaborationParentFolderDefaultRequestProperties(java.lang.String[] requestProps)
          Specifies default properties to return for collaboration parents that are folders.
 void setCollaborationParentTypeSpecifics(int collabType, java.lang.String[] requestProps)
          Specifies details for returning context of a collaboration parent that is a specific collaboration type.
 void setCollaborationTypeRequestProperties(int collabType, java.lang.String[] requestProps)
           
 void setCustomObjectDefaultRequestProperties(java.lang.String[] requestProps)
          Specifies in general what properties are to be returned for objects that are custom objects.
 void setDocumentDefaultRequestProperties(java.lang.String[] requestProps)
          Specifies in general what properties are to be returned for objects that are documents.
 void setFolderDefaultRequestProperties(java.lang.String[] requestProps)
          Specifies in general what properties are to be returned for objects that are folders.
 void setIncludeCollaborationType(int collabType, boolean include)
          Includes or does not include a collaboration type of object in the search.
 void setIncludeNormalDocuments(boolean include)
          Includes non-collaboration documents in the search.
 void setNormalDocumentRequestProperties(java.lang.String[] requestProps)
          Specifies a specific set of properties to return for non-collaboration types of documents.
 void setProvideCollaborationParentContext(boolean provide)
          Requests that context of an object's collaboration parent be returned for those collaboration objects that have a collaboration parent.
 
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.VersionCapableQuery
getVersionControl, setVersionControl
 
Methods inherited from interface com.filenet.bso.api.collaboration.query.TeamspaceScopeCapableQuery
getSingleTeamspaceId, getTeamspaceRequestProperties, getTeamspaceTemplateOption, isProvideTeamspaceContext, isSearchEntireObjectStore, isSearchSingleTeamspace, setProvideTeamspaceContext, setSearchEntireObjectStore, setSearchSingleTeamspace, setTeamspaceRequestProperties, setTeamspaceTemplateOption
 

Method Detail

setDocumentDefaultRequestProperties

public void setDocumentDefaultRequestProperties(java.lang.String[] requestProps)
Specifies in general what properties are to be returned for objects that are documents. Properties for specific types of objects can be specified with other methods.

getDocumentDefaultRequestProperties

public java.lang.String[] getDocumentDefaultRequestProperties()
Returns the properties that were specified with setDocumentDefaultRequestProperties().

setFolderDefaultRequestProperties

public void setFolderDefaultRequestProperties(java.lang.String[] requestProps)
Specifies in general what properties are to be returned for objects that are folders. Properties for specific types of objects can be specified with other methods. Currently when searching for multiple types of objects, a few collaboration objects that are folders can be included in the search if they have a proxy document, a document that represents that folder. You could also search for folders if only searching for collaboration types of objects that are folders.

getFolderDefaultRequestProperties

public java.lang.String[] getFolderDefaultRequestProperties()
Returns the properties that were specified with setFolderDefaultRequestProperties().

setCustomObjectDefaultRequestProperties

public void setCustomObjectDefaultRequestProperties(java.lang.String[] requestProps)
Specifies in general what properties are to be returned for objects that are custom objects. Properties for specific types of objects can be specified with other methods. Currently the only way you could search for custom objects is to only search for collaboration types that are custom objects.

getCustomObjectDefaultRequestProperties

public java.lang.String[] getCustomObjectDefaultRequestProperties()
Returns the properties that were specified with setCustomObjectDefaultRequestProperties().

setIncludeNormalDocuments

public void setIncludeNormalDocuments(boolean include)
Includes non-collaboration documents in the search.

isIncludeNormalDocuments

public boolean isIncludeNormalDocuments()
Indicates if non-collaboration documents are included in the search.

setNormalDocumentRequestProperties

public void setNormalDocumentRequestProperties(java.lang.String[] requestProps)
Specifies a specific set of properties to return for non-collaboration types of documents.

getNormalDocumentRequestProperties

public java.lang.String[] getNormalDocumentRequestProperties()
Returns the properties specified with setNormalDocumentRequestProperties().

setIncludeCollaborationType

public void setIncludeCollaborationType(int collabType,
                                        boolean include)
Includes or does not include a collaboration type of object in the search. Currently all the collaboration types must be of the same base type -- Folder, Document or CustomObject -- except a few Folder types can be included that have a proxy Document object. Also, when searching for Folders (that don't have a proxy document) or CustomObjects, non-collaboration documents cannot be included in the search.

isIncludeCollaborationType

public boolean isIncludeCollaborationType(int collabType)
Indicates if a collaboration type is included in the search.

getIncludedCollaborationTypes

public int[] getIncludedCollaborationTypes()
Returns all the collaboration types that are included in the search.

setCollaborationTypeRequestProperties

public void setCollaborationTypeRequestProperties(int collabType,
                                                  java.lang.String[] requestProps)

getCollaborationTypeRequestProperties

public java.lang.String[] getCollaborationTypeRequestProperties(int collabType)
Returns the properties that were specified with setCollaborationTypeRequestProperties().

setProvideCollaborationParentContext

public void setProvideCollaborationParentContext(boolean provide)
Requests that context of an object's collaboration parent be returned for those collaboration objects that have a collaboration parent. This includes objects like a Posting, whose collaboration parent is the Topic, and an Email Attachment, whose collaboration parent is the Email.
Parameters:
provide - True to request that collaboration parent context be returned, false otherwise.

isProvideCollaborationParentContext

public boolean isProvideCollaborationParentContext()
Indicates if collaboration parent context was requested by calling setProvideCollaborationParentContext.

setCollaborationParentFolderDefaultRequestProperties

public void setCollaborationParentFolderDefaultRequestProperties(java.lang.String[] requestProps)
Specifies default properties to return for collaboration parents that are folders. This doesn't mean that context for a parent folder won't be returned if this is not specified and a queried object's collaboration parent is a folder. This simply specifies what properties are requested as part of that context. If specified, these properties will be returned in a <properties> element of the element for that collaboration parent folder object. These properties will be used for any collaboration parent that is a folder unless more specific properties are specified by calling setCollaborationParentTypeSpecifics(). This setting has no effect if not searching for any collaboration types that can have a parent folder object.

getCollaborationParentFolderDefaultRequestProperties

public java.lang.String[] getCollaborationParentFolderDefaultRequestProperties()
Returns the properties specified with setCollaborationParentFolderDefaultRequestProperties().

setCollaborationParentDocumentDefaultRequestProperties

public void setCollaborationParentDocumentDefaultRequestProperties(java.lang.String[] requestProps)
Specifies default properties to return for collaboration parents that are documents. This doesn't mean that context for a parent document won't be returned if this is not specified and a queried object's collaboration parent is a document. This simply specifies what properties are requested as part of that context. If specified, these properties will be returned in a <properties> element of the element for that collaboration parent document object. These properties will be used for any collaboration parent that is a document unless more specific properties are specified by calling setCollaborationParentTypeSpecifics(). This setting has no effect if not searching for any collaboration types that can have a parent document object.

getCollaborationParentDocumentDefaultRequestProperties

public java.lang.String[] getCollaborationParentDocumentDefaultRequestProperties()
Returns the properties specified with setCollaborationParentDocumentDefaultRequestProperties().

setCollaborationParentTypeSpecifics

public void setCollaborationParentTypeSpecifics(int collabType,
                                                java.lang.String[] requestProps)
Specifies details for returning context of a collaboration parent that is a specific collaboration type. Context for collaboration parent objects is still returned even if details aren't specified for a particular collaboration type or any collaboration types. This method just allows the context to be more finely configured for specific collaboration types.
Parameters:
collabType - The collaboration type.
requestProps - Properties to be returned for this collaboration parent object.

hasCollaborationParentTypeSpecifics

public boolean hasCollaborationParentTypeSpecifics(int collabType)
Indicates if details have been specified for this collaboration type.

getCollaborationParentTypesWithSpecifics

public int[] getCollaborationParentTypesWithSpecifics()
Returns all the collaboration types for which details have been specified.

getCollaborationParentTypeRequestProperties

public java.lang.String[] getCollaborationParentTypeRequestProperties(int collabType)
Returns the properties specified with setCollaborationParentTypeSpecifics().

removeCollaborationParentTypeSpecifics

public void removeCollaborationParentTypeSpecifics(int collabType)
Removes the details for a collaboration type that was previously set using setCollaborationParentTypeSpecifics.

Collaboration API Documentation

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