com.filenet.rm.api
Interface RMSearch
- public interface RMSearch
- extends com.filenet.wcm.api.Search
To execute an ad-hoc search, you must obtain an RMSearch
object.
To do so, call the getRMSearch
method
on the RMObjectStore
object that represents the object store
that is to be searched.
Field Summary
Modifier and Type | Field and Description |
---|---|
|
moAND_OPERATOR
Represents the logical
AND operator.
|
|
moOR_OPERATOR
Represents the logical
OR operator.
|
Fields inherited from interface com.filenet.wcm.api.Search |
---|
MERGE_TYPE_INTERSECTION, MERGE_TYPE_NONE, MERGE_TYPE_UNION |
Method Summary
Modifier and Type | Method and Description |
---|---|
|
executeSinglePagedContentXML(java.lang.String asContentSearchWhereClause,int retrievalBatchSize,boolean continuous)
Searches for a specified number of objects across one or more object stores by content,
and returns array that contains the IDs of the Record Manager objects meeting the
search criteria.
|
|
executeXML(java.lang.String asSearchRequestXML,java.lang.String asContentSearchRequestXML,java.lang.String asOperator)
Searches across one or more object stores by property values, by content, or both,
and returns an XML
String that contains a representation of the Record Manager objects
meeting the search criteria.
|
|
setWSIRetryCount(int inRetryCount)
|
|
singleObjectTypeExecuteXML(java.lang.String asSearchRequestXML,java.lang.String asContentSearchWhereClause,java.lang.String asOperator,int aiObjectType)
Searches for objects of a specified type across one or more object stores by property values,
by content, or both, and returns an XML
String that contains a representation of
the Record Manager objects meeting the search criteria.
|
Methods inherited from interface com.filenet.wcm.api.Search |
---|
executeXML, getChoiceLists, getClassDescriptions, getClassDescriptions, getPropertyDescriptions, getPropertyDescriptions, getPropertyDescriptions, getPropertyDescriptions, singleObjectTypeExecute, singleObjectTypeExecuteXML |
Field Detail
moOR_OPERATOR
- static final java.lang.String moOR_OPERATOR
moAND_OPERATOR
- static final java.lang.String moAND_OPERATOR
AND
operator.
Method Detail
executeXML
- java.lang.String executeXML(java.lang.String asSearchRequestXML,
- java.lang.String asContentSearchRequestXML,
- java.lang.String asOperator)
String
that contains a representation of the Record Manager objects
meeting the search criteria.
The asSearchRequestXML
and asContentSearchWhereClause
parameters
define the search criteria and scope as follows:
asSearchRequestXML | asContentSearchRequestXML | Searches |
---|---|---|
Contains a WHERE clause | null or empty | The metadata in a File Plan Object Store (FPOS). |
Contains a WHERE clause | Contains a WHERE clause. | The content in a Records Object Store (ROS). |
Contains object ID and aggregation properties | Contains a WHERE clause | The metadata in an FPOS and the content in an ROS. |
The method merges the results obtained from the FPOS
and ROS based on the values provided in the asOperator
parameter. You must specify this parameter if this method is to
return both metadata and content.
asSearchRequestXML
- A String
in XML format. If the method is to search the
metadata in the FPOS, this String
defines the search criteria. If the method is
to search the content only, this String
contains the ID and aggregation properties
that identify the objects to be searched. This parameter cannot be null
. asContentSearchRequestXML
- A String
in XML format that defines the
WHERE clause for searching content in a ROS. Set this parameter to null
if the method is to search only the metadata. asOperator
- A String
specifying either the moOR_OPERATOR or moAND_OPERATOR
operator to indicate the merge option for the metadata or content search on the FPOS and
the content search on the ROS. String
in XML format that contains a representation of the
objects that meet the search criteria. This String
is in XML format based
on the Search XML Schema provided by the Microsoft ADO RecordSet
object. singleObjectTypeExecuteXML
- java.lang.String singleObjectTypeExecuteXML( java.lang.String asSearchRequestXML,
- java.lang.String asContentSearchWhereClause,
- java.lang.String asOperator,
- int aiObjectType)
String
that contains a representation of
the Record Manager objects meeting the search criteria.
The aiObjectType
parameter indicates the type of object for which this method
is to search.
The asSearchRequestXML
and asContentSearchWhereClause
parameters
define the search criteria and scope as follows:
asSearchRequestXML | asContentSearchRequestXML | Searches |
---|---|---|
Contains a WHERE clause | null or empty | The metadata in a File Plan Object Store (FPOS). |
Contains a WHERE clause | Contains a WHERE clause. | The content in a Records Object Store (ROS). |
Contains object ID and aggregation properties | Contains a WHERE clause | The metadata in an FPOS and the content in an ROS. |
The method merges the results obtained from the FPOS
and ROS based on the values provided in the asOperator
parameter. You must specify this parameter if this method is to
return both metadata and content.
asSearchRequestXML
- A String
in XML format that defines the criteria for
searching metadata in a FPOS. If only content is to be searched,
this parameter contains properties, such as ID and aggregation, that identify the objects
to be searched. asContentSearchWhereClause
- A String
that defines the WHERE clause
for a content-based search in the ROS. asOperator
- A String
specifying either the moOR_OPERATOR or moAND_OPERATOR
operator to indicate the merge option for the metadata or content search on the FPOS and
the content search on the ROS. aiObjectType
- An int
value identifying the type of object to be searched. String
containing the list of objects that meet the specified search
criteria. The String
is in XML format based on the Search XML Schema provided
by the CE Java API. executeSinglePagedContentXML
- java.util.ArrayList executeSinglePagedContentXML( java.lang.String asContentSearchWhereClause,
- int retrievalBatchSize,
- boolean continuous)
The asContentSearchWhereClause
parameter defines the WHERE clause that
defines the criteria for a content-based search of a Records Object Store (ROS).
asContentSearchWhereClause
- A String
that defines the WHERE clause
for a content-based search in the ROS. retrievalBatchSize
- An int
value that specifies the maximum number of objects
that this method is to retrieve. continuous
- A boolean
value that indicates whether
this method is to continue an existing search or start a new search. Set to
true
to continue a search. Set to false
to begin a new
search. ArrayList
object that contains the IDs of the Record Manager
bjects meeting the search criteria. setWSIRetryCount
- void setWSIRetryCount(int inRetryCount)
OR
operator.