Collaboration API Documentation

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

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

public interface CollaborationQuery


Field Summary
static int TEAMSPACE_TEMPLATE_FILTER
          Option to specify that objects are filtered out that are part of teamspaces that are templates.
static int TEAMSPACE_TEMPLATE_IGNORE
          Option to specify that teamspace template status is ignored, in other words it has no effect on the query results.
static int TEAMSPACE_TEMPLATE_RETURN
          Option to specify that teamspace template status is simply returned as part of the context of the query results.
static int VERSION_CONTROL_ALL
          Option to specify that all versions of documents that match the search criteria are to be returned.
static int VERSION_CONTROL_ALLCHECKEDIN
          Option to specify that all checked-in versions of documents are searched (all versions except reservations).
static int VERSION_CONTROL_ALLMAJOR
          Option to specify that all major versions of documents are searched.
static int VERSION_CONTROL_CURRENT
          Option to specify that only the current version of documents are to be searched.
static int VERSION_CONTROL_RELEASED
          Option to specify that only released versions of documents are to be searched.
 
Method Summary
 java.lang.String execute()
          Executes the query and returns XML that represents the results.
 int getMaximumResults()
          Returns the maximum specified with setMaximumResults().
 java.lang.String getObjectStoreId()
          Returns the object store to search.
 OrderBy[] getOrdering()
          Returns the ordering options specified with setOrdering().
 PropertyCriteriaNode getPropertyCriteria()
          Gets the property based search criteria specified with setPropertyCriteria().
 java.lang.String getUserID()
          Returns the user ID specified with setUserID().
 void setMaximumResults(int max)
          Specifies the maximum number of results to return from the query.
 void setObjectStoreId(java.lang.String objStoreId)
          Specifies what object store to search.
 void setOrdering(OrderBy[] ordering)
          Sets ordering options.
 void setPropertyCriteria(PropertyCriteriaNode node)
          Sets a property-based search criteria.
 void setUserID(java.lang.String userID)
          Specifies the current user ID.
 

Field Detail

VERSION_CONTROL_RELEASED

public static final int VERSION_CONTROL_RELEASED
Option to specify that only released versions of documents are to be searched. Note that it is possible that a document that otherwise matches the search criteria will not be returned because there are no released versions in the document series (only minor versions have been checked in).

VERSION_CONTROL_CURRENT

public static final int VERSION_CONTROL_CURRENT
Option to specify that only the current version of documents are to be searched. All document series have a current version unless the document has never been checked in. Note that it is possible for a current version to be a minor, non-released, version.

VERSION_CONTROL_ALL

public static final int VERSION_CONTROL_ALL
Option to specify that all versions of documents that match the search criteria are to be returned. This is the least restrictive and allows users to add their own search criteria to filter versions. For example, a user could return only versions with a major number greater than 3.

VERSION_CONTROL_ALLCHECKEDIN

public static final int VERSION_CONTROL_ALLCHECKEDIN
Option to specify that all checked-in versions of documents are searched (all versions except reservations).

VERSION_CONTROL_ALLMAJOR

public static final int VERSION_CONTROL_ALLMAJOR
Option to specify that all major versions of documents are searched. This is all versions whose minor version number is 0.

TEAMSPACE_TEMPLATE_IGNORE

public static final int TEAMSPACE_TEMPLATE_IGNORE
Option to specify that teamspace template status is ignored, in other words it has no effect on the query results. Objects are returned whether or not they are in a teamspace template.

TEAMSPACE_TEMPLATE_RETURN

public static final int TEAMSPACE_TEMPLATE_RETURN
Option to specify that teamspace template status is simply returned as part of the context of the query results. Objects will still be returned whether or not they are in a teamspace template but the teamspace context will include whether or not it is a template.

TEAMSPACE_TEMPLATE_FILTER

public static final int TEAMSPACE_TEMPLATE_FILTER
Option to specify that objects are filtered out that are part of teamspaces that are templates.
Method Detail

execute

public java.lang.String execute()
Executes the query and returns XML that represents the results.

setMaximumResults

public void setMaximumResults(int max)
Specifies the maximum number of results to return from the query.

getMaximumResults

public int getMaximumResults()
Returns the maximum specified with setMaximumResults().

setObjectStoreId

public void setObjectStoreId(java.lang.String objStoreId)
Specifies what object store to search.

getObjectStoreId

public java.lang.String getObjectStoreId()
Returns the object store to search.

setUserID

public void setUserID(java.lang.String userID)
Specifies the current user ID. This is an optional setting for most types of queries. An example of where this is significant is a query of polls. Whether a particular response is returned depends on whether responses are hidden for a particular poll (indicated by Poll.areResponsesHidden()) and whether the current user is the owner of the PollResponse.

getUserID

public java.lang.String getUserID()
Returns the user ID specified with setUserID().

setOrdering

public void setOrdering(OrderBy[] ordering)
Sets ordering options. Passed as an array of OrderBy objects. An object of this type is obtained through the CollaborationFactory method getOrderBy().

getOrdering

public OrderBy[] getOrdering()
Returns the ordering options specified with setOrdering().

setPropertyCriteria

public void setPropertyCriteria(PropertyCriteriaNode node)
Sets a property-based search criteria. This criteria is merged with the rest of the criteria implied by other options that have been set. The criteria can be a single comparison operation or a tree of and/or operations, potentially nested to multiple levels. The nodes that form this criteria are obtained from the CollaborationFactory method getPropertyCriteriaNode().

getPropertyCriteria

public PropertyCriteriaNode getPropertyCriteria()
Gets the property based search criteria specified with setPropertyCriteria().

Collaboration API Documentation

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