com.filenet.rm.api
Interface RMConnector
- public interface RMConnector
RMConnector
interface
defines methods that you can use to query these repositories.
You can instantiate an RMConnector
object by calling the getConnector
method on an RMDriverManager
object. This method validates the registration ID and
returns the corresponding RMConnector
object.
ATTENTION The methods in this interface might be deprecated in a future release. Do not use these methods.
Specifying a URL
To communicate with a document repository and locate a document stored in the repository,
the Records Manager API provides the URL of a required document to the RMConnector
object. The URL is a String
that contains the information required to locate
the document including the repository type, repository name, server name, and document ID.
The URL is stored as a property of the RecordInfo
object during the
declaration process. The URL can then be retrieved from the RecordInfo
object
and parsed for any record-related operations.
The following example illustrates a URL that can be used for all methods except search-related
methods on an RMConnector
object:
<RMCONNECTOR_URL>
<REPOSITORY_TYPE>CE</REPOSITORY_TYPE>
<SERVER_NAME>http://fn-atlantic:8008/ApplicationEngine/xcmisasoap.dll</SERVER_NAME>
<REPOSITORY_NAME>FPOS</REPOSITORY_NAME>
<DOCUMENT_ID>C4A973F9-4F6B-4FCB-BE59-B1697497EC9C</DOCUMENT_ID>
<USER_ID>somals</USER_ID>
<PASSWORD>sood</PASSWORD>
</RMCONNECTOR_URL>
The following example illustrates a URL that can be used for search-related
methods on an RMConnector
object:
<RMCONNECTOR_SEARCH_URL>
<RMCONNECTOR_URL>
<REPOSITORY_TYPE>CE</REPOSITORY_TYPE>
<SERVER_NAME>http://fn-atlantic:8008/ApplicationEngine/xcmisasoap.dll</SERVER_NAME>
<REPOSITORY_NAME>FPOS</REPOSITORY_NAME>
<USER_ID>somals</USER_ID>
<PASSWORD>sood</PASSWORD>
</RMCONNECTOR_URL>
<RMCONNECTOR_URL>
<REPOSITORY_TYPE>CE</REPOSITORY_TYPE>
<SERVER_NAME>http://fn-pacific:8008/ApplicationEngine/xcmisasoap.dll</SERVER_NAME>
<REPOSITORY_NAME>PROTest</REPOSITORY_NAME>
<USER_ID>somals</USER_ID>
<PASSWORD>sood</PASSWORD>
</RMCONNECTOR_URL>
</RMCONNECTOR_SEARCH_URL>
Method Summary
Modifier and Type | Method and Description |
---|---|
|
canDeclare(java.lang.String asURL,java.lang.String[] asArrVersion)
Validates the eligibility of a document for the declaration operation.
|
|
copyDocument(java.lang.String asURL,java.lang.String asName,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACLs)
Creates a copy of a specified document with the specified property and permission values.
|
|
declareDocument(java.lang.String asURLDocument,RecordInfo aoRecordInfo,java.lang.String[] asArrVersion,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACLs)
Sets the required properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied.
|
|
declareDocument(java.lang.String asURLDocument,java.lang.String asURLRecord,java.lang.String[] asArrVersion,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACLs)
Sets the required properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied.
|
|
declareDocument(java.lang.String asURLDocument,java.lang.String asURLRecord,java.lang.String[] asArrVersion,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACLs,DocumentStore aoDocStore)
Sets the isRecord and RecordLink properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied.
|
|
deleteDocument(java.lang.String asURL)
Deletes the specified document from the records object store (ROS).
|
|
exportDocument(java.lang.String asArrURI,java.lang.String asParentXML)
Exports the documents identified by the URL in XML string format.
|
|
getAllVersions(java.lang.String asURL)
Retrieves all version numbers of the document specified by the URL.
|
|
getCurrentVersion(java.lang.String asURL)
Retrieves the current or latest version of the document that is specified by the URL.
|
|
getDeclareDocuments(java.lang.String asURL,java.lang.String[] asArrVersion)
Retrieves the documents that correspond to the documentID provided in the URL and the version supplied.
|
|
getDocumentContent(java.lang.String asURL)
Constructs a TransportInputStream that represents the content of
this Document.
|
|
getDocumentContentElements(java.lang.String asURL)
Returns an array that contains the object types for the content elements associated with this Document object.
|
|
getDocumentID(java.lang.String asURL,java.lang.String asVersion)
Retrieves the DocumentID of the specific version of the given document.
|
|
getDocumentProperties(java.lang.String asURL,java.lang.String[] asArrProps)
Returns property values for the specified document.
|
|
getRendition(java.lang.String asURL)
Retrieves a collection of documents (along with all the properties) that are published from this Document object version.
|
|
getRepositoryType(java.lang.String asURI)
Returns the Repository type where this instance of Connector points.
|
|
getSearchSQL(java.lang.String asContentSearchWhereClause)
Returns an XML document that represents the content query to be executed on the ROS.
|
|
search(java.lang.String asURL,java.lang.String asContentSearchRequestXML)
Performs the content-based search in the records object store (ROS) as identified by the URL parameters.
|
|
searchDocument(java.lang.String asURL,java.lang.String asSearchCriteriaVerity,java.lang.String asExecuteDataXML)
This method does the content-based search in the records object store (ROS) as identified by the URL parameters.
|
|
searchDocumentXML(java.lang.String asURL,java.lang.String asSearchCriteriaVerity,java.lang.String asExecuteDataXML)
Performs a content-based search in the records object store (ROS) as identified by the URL parameters.
|
|
synchronizeDocument(java.lang.String asURL,com.filenet.wcm.api.Properties asProps)
Synchronizes the document with the properties and the permissions provided by a user.
|
Method Detail
getDocumentProperties
- com.filenet.wcm.api.Properties getDocumentProperties( java.lang.String asURL,
- java.lang.String[] asArrProps)
- throws RMException
asURL
- A String
specifying the URL of the document
for which property values are to be returned.
For more information, see Specifying a URL.
The String
cannot be null
or empty. asArrProps
- A String
array specifying the names of the properties
for which values are to be returned. Set to null
to return values for
all the properties of the document. Properties
collection containing the property values for
the document. RMException
- If a Records Manager error occurs. copyDocument
- java.lang.String copyDocument(java.lang.String asURL,
- java.lang.String asName,
- com.filenet.wcm.api.Properties aoProps,
- com.filenet.wcm.api.Permissions aoACLs)
asURL
- A String
specifying the URL of the document to be copied.
The String
cannot be null
or empty.
For more information, see Specifying a URL. asName
- A String
specifying the name for the new Document
object. aoProps
- A Properties
collection containing any property values that
are to be overridden in the new Document
object. aoACLs
- A Permissions
collection containing the permission values
for the new Document
object. String
containing the ID of the new Document
object. deleteDocument
- void deleteDocument(java.lang.String asURL)
asURL
- A String
specifying the URL of the document to be deleted.
The String
cannot be null
or empty. searchDocumentXML
- java.lang.String searchDocumentXML( java.lang.String asURL,
- java.lang.String asSearchCriteriaVerity,
- java.lang.String asExecuteDataXML)
If the asExecuteDataXML parameter is non-null, the XML string is modified to support the runtime parameters that are in connection to the content-based search only. Similarly, the asSearchCriteriaVerity parameter is modified to add all the object stores provided in the given URL for a domain. Additionally, the asSearchCriteriaVerity parameter is modified to retrieve the documentID from the Document object (specified in the 'class' node of the 'from' tag of the supplied XML).
asURL
- A String
specifying the URL of the document
for which property values are to be returned.
For more information, see Specifying a URL.
The String
cannot be null
or empty. asSearchCriteriaVerity
- An XML String that represents the stored search XML to be executed on the ROS.
A NULL or an empty URL are not acceptable values. asExecuteDataXML
- An XML String representation of the values that a user provides at runtime prior to executing the search.
A NULL or an empty URL are not acceptable values. String
containing the search result in XML format. searchDocument
- java.util.List searchDocument(java.lang.String asURL,
- java.lang.String asSearchCriteriaVerity,
- java.lang.String asExecuteDataXML)
asURL
- A String
specifying the URL of the document
for which property values are to be returned.
For more information, see Specifying a URL.
The String
cannot be null
or empty. asSearchCriteriaVerity
- An XML String that represents the Stored search XML to be executed on the ROS. A NULL or an empty URL are not acceptable values. asExecuteDataXML
- An XML String representation of the values that a user provides at runtime prior to executing the search. The value of the parameter can be empty or null search
- java.lang.String search(java.lang.String asURL,
- java.lang.String asContentSearchRequestXML)
asURL
- A String
specifying the URL of the document
for which property values are to be returned.
For more information, see Specifying a URL.
The String
cannot be null
or empty. asContentSearchRequestXML
- An XML string that represents the search XML to be executed on the ROS for the content-based search. A NULL or an empty URL are not acceptable values. synchronizeDocument
- void synchronizeDocument(java.lang.String asURL,
- com.filenet.wcm.api.Properties asProps)
- throws RMException
asURL
- A String
specifying the URL of the document
for which property values are to be returned.
For more information, see Specifying a URL.
The String
cannot be null
or empty. asProps
- The Properties that need to be synchronized. RMException
- If a Records Manager error occurs. declareDocument
- void declareDocument(java.lang.String asURLDocument,
- java.lang.String asURLRecord,
- java.lang.String[] asArrVersion,
- com.filenet.wcm.api.Properties aoProps,
- com.filenet.wcm.api.Permissions aoACLs)
- throws RMException
asURLDocument
- The URL that specifies the document ID and other parameters such as the repository and server name to identify a document.
A NULL or an empty URL are not acceptable values. asURLRecord
- The URL that specifies the record ID and other parameters such as repository and server name to identify a record. asArrVersion
- The versions that needs to be declared as a single record. aoProps
- The properties that need to be synchronized aoACLs
- A Permissions collection specifying the security for the document. RMException
- If a Records Manager error occurs. declareDocument
- void declareDocument(java.lang.String asURLDocument,
- RecordInfo aoRecordInfo,
- java.lang.String[] asArrVersion,
- com.filenet.wcm.api.Properties aoProps,
- com.filenet.wcm.api.Permissions aoACLs)
- throws RMException
asURLDocument
- The URL that specifies the document ID and other parameters such as the repository and server name to identify a document.
A NULL or an empty URL are not acceptable values. aoRecordInfo
- RecordInfo Object asArrVersion
- The versions that needs to be declared as a single record. aoProps
- The properties that need to be synchronized aoACLs
- A Permissions collection specifying the security for the document. RMException
- If a Records Manager error occurs. declareDocument
- void declareDocument(java.lang.String asURLDocument,
- java.lang.String asURLRecord,
- java.lang.String[] asArrVersion,
- com.filenet.wcm.api.Properties aoProps,
- com.filenet.wcm.api.Permissions aoACLs,
- DocumentStore aoDocStore)
- throws RMException
asURLDocument
- The URL that specifies the documentID and the other parameters like Repository Name, Server Name to identify the document. A NULL or an empty URL are not acceptable values. asURLRecord
- The URL that specifies the record ID and other parameters such as the repository and server name to identify the
Record asArrVersion
- The versions that need to be declared as a single record. The URL must contain a single document ID in the URL, otherwise an RMException will be thrown. aoProps
- The properties that need to be synchronized. aoACLs
- A Permissions collection specifying the security for the document. aoDocStore
- The Wrapper on the DocumentStore Library .The DocumentStore represents a document repository, where documents are stored. RMException
- If a Records Manager error occurs. getDocumentContentElements
- int[] getDocumentContentElements( java.lang.String asURL)
asURL
- The URL that specifies the document ID and other parameters such as the repository and server name to identify a document.
A NULL or an empty URL are not acceptable values. getAllVersions
- java.lang.String[] getAllVersions( java.lang.String asURL)
- throws RMException
asURL
- A URL that specifies the document ID and other parameters such as the repository and server name to identify a document.
A NULL or an empty URL are not acceptable values. RMException
- If a Records Manager error occurs. getCurrentVersion
- java.lang.String getCurrentVersion( java.lang.String asURL)
- throws RMException
asURL
- A URL that specifies the document ID and other parameters such as the repository and server name to identify a document.
A NULL or an empty URL are not acceptable values. RMException
- If a Records Manager error occurs. getRendition
- java.util.List getRendition(java.lang.String asURL)
asURL
- The URL that specifies the document ID and other parameters such as the repository and server name to identify a document.
A NULL or an empty URL are not acceptable values. exportDocument
- java.lang.String exportDocument( java.lang.String asArrURI,
- java.lang.String asParentXML)
- throws RMException
asArrURI
- The URL that specifies the document ID and other parameters such as the repository and server name to identify a document. canDeclare
- boolean canDeclare(java.lang.String asURL,
- java.lang.String[] asArrVersion)
- throws RMException
asArrVersion
- The version numbers whose eligibility for declaration needs to be checked. asURL
- The URL that specifies the document ID and other parameters such as the repository and server name to identify a document.
A NULL or an empty URL are not acceptable values. RMException
- If a Records Manager error occurs. getDocumentID
- java.lang.String getDocumentID( java.lang.String asURL,
- java.lang.String asVersion)
- throws RMException
asURL
- The URL that specifies the document ID and other parameters such as the repository and server name to identify a document.
A NULL or an empty URL are not acceptable values. asVersion
- The version whose document ID needs to be retrieved RMException
- In case of any error an RMException will be thrown getDeclareDocuments
- java.util.List getDeclareDocuments( java.lang.String asURL,
- java.lang.String[] asArrVersion)
- throws RMException
asURL
- The URL that specifies the document ID and other parameters such as the repository and server name to identify a document.
A NULL or an empty URL are not acceptable values. asArrVersion
- The version whose document object needs to be retrieved. RMException
- If a Records Manager error occurs. getSearchSQL
- java.lang.String getSearchSQL(java.lang.String asContentSearchWhereClause)
asContentSearchWhereClause
- The WHERE clause of the content-based query. getDocumentContent
- com.filenet.wcm.api.TransportInputStream getDocumentContent( java.lang.String asURL)
- throws RMException
asURL
- A String to be used to locate the Document in the Document repository. getRepositoryType
- java.lang.String getRepositoryType( java.lang.String asURI)
- throws RMException
RMException
- If a Records Manager error occurs.