com.filenet.rm.api
Interface DocumentStore
- public interface DocumentStore
Method Summary
Modifier and Type | Method and Description |
---|---|
|
getDomain()
Returns the name of the domain name for this
DocumentStore object.
|
|
getLibraryName()
Returns the name of the document library as represented by this
DocumentStore object.
|
|
getObjectStore()
Returns this
DocumentStore object.
|
|
getRepositoryName()
Generates a repository name for this
DocumentStore object by combining the domain
and library names this object.
|
|
getRepositoryType()
Returns a value indicating the repository type of this
DocumentStore object.
|
|
getServerName()
Returns the URL that is used to connect to the Content Engine server and return.
|
|
getURI(RMObjectStore aoRMobjectStore,java.lang.String[] asArrDocumentId)
Generates a URI that is passed to RM Declaration API when documents are declared as records.
|
Method Detail
getURI
- java.lang.String getURI(RMObjectStore aoRMobjectStore,
- java.lang.String[] asArrDocumentId)
- throws RMException
Generates a URI that is passed to RM Declaration API when documents are declared as records.
Parameters:
aoRMobjectStore
- An RMObjectStore
object that represents the object store
in which the records are to be declared. asArrDocumentId
- A String
array that contains the IDs of the documents that
are to be declared as records. Returns:
A
String
that represents the URI to be used to declare documents as records. Throws:
RMException
- If a Records Manager error occurs. getRepositoryType
- java.lang.String getRepositoryType( )
- throws RMException
Returns a value indicating the repository type of this
DocumentStore
object.
Returns:
A
String
that indicates the repository type of
this DocumentStore
object. Throws:
RMException
- If a Records Manager error occurs. getServerName
- java.lang.String getServerName( )
- throws RMException
Returns the URL that is used to connect to the Content Engine server and return.
Returns:
A
String
representing the URL for the Content Java API listener. Throws:
RMException
- If a Records Manager error occurs. getRepositoryName
- java.lang.String getRepositoryName( )
- throws RMException
Generates a repository name for this
DocumentStore
object by combining the domain
and library names this object.
Returns:
A
String
that represents the name of the repository for this
DocumentStore
object. Throws:
RMException
- If a Records Manager error occurs. getLibraryName
- java.lang.String getLibraryName( )
- throws RMException
Returns the name of the document library as represented by this
DocumentStore
object.
Returns:
A
String
that represents the document library name. Throws:
RMException
- If a Records Manager error occurs. getDomain
- java.lang.String getDomain()
- throws RMException
Returns the name of the domain name for this
DocumentStore
object.
Returns:
A
String
that represents the domain name. Throws:
RMException
- If a Records Manager error occurs. getObjectStore
- com.filenet.wcm.api.ObjectStore getObjectStore( )
- throws RMException
Returns this
DocumentStore
object.
Returns:
An
ObjectStore
object that represents this DocumentStore
object. Throws:
RMException
- If a Records Manager error occurs.