com.filenet.rm.api

Interface DocumentStore


  1. public interface DocumentStore
Represents a repository in which documents are stored.

Method Summary

Modifier and Type Method and Description
  1. java.lang.String
getDomain()
Returns the name of the domain name for this DocumentStore object.
  1. java.lang.String
getLibraryName()
Returns the name of the document library as represented by this DocumentStore object.
  1. com.filenet.wcm.api.ObjectStore
getObjectStore()
Returns this DocumentStore object.
  1. java.lang.String
getRepositoryName()
Generates a repository name for this DocumentStore object by combining the domain and library names this object.
  1. java.lang.String
getRepositoryType()
Returns a value indicating the repository type of this DocumentStore object.
  1. java.lang.String
getServerName()
Returns the URL that is used to connect to the Content Engine server and return.
  1. java.lang.String
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

  1. java.lang.String getURI(RMObjectStore aoRMobjectStore,
  2. java.lang.String[] asArrDocumentId)
  3. 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

  1. java.lang.String getRepositoryType( )
  2. 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

  1. java.lang.String getServerName( )
  2. 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

  1. java.lang.String getRepositoryName( )
  2. 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

  1. java.lang.String getLibraryName( )
  2. 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

  1. java.lang.String getDomain()
  2. 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

  1. com.filenet.wcm.api.ObjectStore getObjectStore( )
  2. throws RMException
Returns this DocumentStore object.
Returns:
An ObjectStore object that represents this DocumentStore object.
Throws:
RMException - If a Records Manager error occurs.