com.filenet.bso.api.collaboration.query
Interface SingleCollaborationTypeQuery
- All Superinterfaces:
- CollaborationQuery, ContentCapableQuery, HomogeneousQuery, TeamspaceScopeCapableQuery, VersionCapableQuery
- All Known Subinterfaces:
- ForumsQuery, MeetingsQuery, PollsQuery, ReplyPostingsQuery, TopicPostingsQuery
- public interface SingleCollaborationTypeQuery
- extends CollaborationQuery, HomogeneousQuery, TeamspaceScopeCapableQuery, ContentCapableQuery, VersionCapableQuery
A base interface to query for a single type of collaboration object. This
interface is extended for specific collaboration types, for example
PollsQuery
or TasksQuery
. If a specific interface
is not defined to deal with a specific type of collaboration object, the
query object returned by the CollaborationFactory
will be a
generic implementation of SingleCollaborationTypeQuery
. Some
of the methods of this interface will not be supported depending on the
capabilities of the collaboration type being searched.
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.TeamspaceScopeCapableQuery |
getSingleTeamspaceId, getTeamspaceRequestProperties, getTeamspaceTemplateOption, isProvideTeamspaceContext, isSearchEntireObjectStore, isSearchSingleTeamspace, setProvideTeamspaceContext, setSearchEntireObjectStore, setSearchSingleTeamspace, setTeamspaceRequestProperties, setTeamspaceTemplateOption |
getCollaborationType
public int getCollaborationType()
- Returns the type of collaboration object being searched. The collaboration
type is fixed when the CollaborationFactory method returns the query object.
This method allows the type to be discovered later.
setProvideCollaborationParentContext
public void setProvideCollaborationParentContext(boolean provide)
- Requests that context of an object's collaboration parent be returned.
Examples of objects that have a collaboration parent are
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
.
setCollaborationParentRequestProperties
public void setCollaborationParentRequestProperties(java.lang.String[] props)
- Specifies what properties to return for collaboration parent objects.
This doesn't mean that context for a parent object won't be returned if
this is not specified. It 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.
This setting has no effect unless collaboration parent context is enabled
by calling
setProvideCollaborationParentContext(true)
.
getCollaborationParentRequestProperties
public java.lang.String[] getCollaborationParentRequestProperties()
- Returns the properties specified with
setCollaborationParentRequestProperties()
.
Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.