|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public void setDocumentDefaultRequestProperties(java.lang.String[] requestProps)
public java.lang.String[] getDocumentDefaultRequestProperties()
setDocumentDefaultRequestProperties()
.public void setFolderDefaultRequestProperties(java.lang.String[] requestProps)
public java.lang.String[] getFolderDefaultRequestProperties()
setFolderDefaultRequestProperties()
.public void setCustomObjectDefaultRequestProperties(java.lang.String[] requestProps)
public java.lang.String[] getCustomObjectDefaultRequestProperties()
setCustomObjectDefaultRequestProperties()
.public void setIncludeNormalDocuments(boolean include)
public boolean isIncludeNormalDocuments()
public void setNormalDocumentRequestProperties(java.lang.String[] requestProps)
public java.lang.String[] getNormalDocumentRequestProperties()
setNormalDocumentRequestProperties()
.public void setIncludeCollaborationType(int collabType, boolean include)
public boolean isIncludeCollaborationType(int collabType)
public int[] getIncludedCollaborationTypes()
public void setCollaborationTypeRequestProperties(int collabType, java.lang.String[] requestProps)
public java.lang.String[] getCollaborationTypeRequestProperties(int collabType)
setCollaborationTypeRequestProperties()
.public void setProvideCollaborationParentContext(boolean provide)
provide
- True to request that collaboration parent context be returned,
false otherwise.public boolean isProvideCollaborationParentContext()
setProvideCollaborationParentContext
.public void setCollaborationParentFolderDefaultRequestProperties(java.lang.String[] requestProps)
setCollaborationParentTypeSpecifics()
.
This setting has no effect if not searching for any collaboration types that
can have a parent folder object.public java.lang.String[] getCollaborationParentFolderDefaultRequestProperties()
setCollaborationParentFolderDefaultRequestProperties()
.public void setCollaborationParentDocumentDefaultRequestProperties(java.lang.String[] requestProps)
setCollaborationParentTypeSpecifics()
.
This setting has no effect if not searching for any collaboration types that
can have a parent document object.public java.lang.String[] getCollaborationParentDocumentDefaultRequestProperties()
setCollaborationParentDocumentDefaultRequestProperties()
.public void setCollaborationParentTypeSpecifics(int collabType, java.lang.String[] requestProps)
collabType
- The collaboration type.requestProps
- Properties to be returned for this collaboration parent
object.public boolean hasCollaborationParentTypeSpecifics(int collabType)
public int[] getCollaborationParentTypesWithSpecifics()
public java.lang.String[] getCollaborationParentTypeRequestProperties(int collabType)
setCollaborationParentTypeSpecifics()
.public void removeCollaborationParentTypeSpecifics(int collabType)
setCollaborationParentTypeSpecifics
.
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |