Collaboration API Documentation

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

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

public interface TeamspaceScopeCapableQuery

Contains methods to specify the teamspace scope of a query -- either within the scope of a single teamspace, in any teamspace in the object store, or (non-collaboration objects) not in any teamspace.


Method Summary
 java.lang.String getSingleTeamspaceId()
          Returns the teamspace to search that was specified with setSearchSingleTeamspace.
 java.lang.String[] getTeamspaceRequestProperties()
          Returns the teamspace properties specified with setTeamspaceRequestProperties.
 int getTeamspaceTemplateOption()
          Returns the option specified with setTeamspaceTemplateOption.
 boolean isProvideTeamspaceContext()
          Indicates if teamspace context is requested.
 boolean isSearchEntireObjectStore()
          Indicates if the entire object store search mode is in effect.
 boolean isSearchSingleTeamspace()
          Indicates if the single teamspace search mode is in effect.
 void setProvideTeamspaceContext(boolean requested)
          Requests that teamspace context be returned for any objects that are part of a teamspace.
 void setSearchEntireObjectStore()
          Specifies that objects anywhere in the object store will be searched.
 void setSearchSingleTeamspace(java.lang.String teamspaceId)
          Specifies that only objects within a single teamspace will be searched.
 void setTeamspaceRequestProperties(java.lang.String[] teamspaceRequestProps)
          Specifies properties to be returned as part of the teamspace context.
 void setTeamspaceTemplateOption(int templateOption)
          Specifies how teamspace templates are handled in the query.
 

Method Detail

setSearchSingleTeamspace

public void setSearchSingleTeamspace(java.lang.String teamspaceId)
Specifies that only objects within a single teamspace will be searched. This is mutually exclusive with the method setSearchEntireObjectStore(). Calling one of these two methods disables the other search mode.
Parameters:
teamspaceId - Required. The teamspace to search in.

isSearchSingleTeamspace

public boolean isSearchSingleTeamspace()
Indicates if the single teamspace search mode is in effect.

getSingleTeamspaceId

public java.lang.String getSingleTeamspaceId()
Returns the teamspace to search that was specified with setSearchSingleTeamspace.

setSearchEntireObjectStore

public void setSearchEntireObjectStore()
Specifies that objects anywhere in the object store will be searched. This is mutually exclusive with the method setSearchSingleTeamspace(). Calling one of these two methods disables the other search mode.

isSearchEntireObjectStore

public boolean isSearchEntireObjectStore()
Indicates if the entire object store search mode is in effect.

setTeamspaceTemplateOption

public void setTeamspaceTemplateOption(int templateOption)
Specifies how teamspace templates are handled in the query. The default is TEAMSPACE_TEMPLATE_IGNORE. This option has no effect if not searching the entire object store.

getTeamspaceTemplateOption

public int getTeamspaceTemplateOption()
Returns the option specified with setTeamspaceTemplateOption.

setProvideTeamspaceContext

public void setProvideTeamspaceContext(boolean requested)
Requests that teamspace context be returned for any objects that are part of a teamspace. This option has no effect if not searching the entire object store.
Parameters:
requested - If true, teamspace context is returned in the query results.

isProvideTeamspaceContext

public boolean isProvideTeamspaceContext()
Indicates if teamspace context is requested.

setTeamspaceRequestProperties

public void setTeamspaceRequestProperties(java.lang.String[] teamspaceRequestProps)
Specifies properties to be returned as part of the teamspace context. If specified, the properties will be returned inside a <properties> element of a <teamspace> element. This option has no effect if not searching the entire object store.

getTeamspaceRequestProperties

public java.lang.String[] getTeamspaceRequestProperties()
Returns the teamspace properties specified with setTeamspaceRequestProperties.

Collaboration API Documentation

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