|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public void setSearchSingleTeamspace(java.lang.String teamspaceId)
setSearchEntireObjectStore()
.
Calling one of these two methods disables the other search mode.teamspaceId
- Required. The teamspace to search in.public boolean isSearchSingleTeamspace()
public java.lang.String getSingleTeamspaceId()
setSearchSingleTeamspace
.public void setSearchEntireObjectStore()
setSearchSingleTeamspace()
.
Calling one of these two methods disables the other search mode.public boolean isSearchEntireObjectStore()
public void setTeamspaceTemplateOption(int templateOption)
public int getTeamspaceTemplateOption()
setTeamspaceTemplateOption
.public void setProvideTeamspaceContext(boolean requested)
requested
- If true, teamspace context is returned in the query
results.public boolean isProvideTeamspaceContext()
public void setTeamspaceRequestProperties(java.lang.String[] teamspaceRequestProps)
public java.lang.String[] getTeamspaceRequestProperties()
setTeamspaceRequestProperties
.
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |