| org.enhydra.dm.api.DocumentManager
All known Subclasses: org.enhydra.dm.business.DocumentManagerImpl,
| DocumentManager | | public interface DocumentManager (Code) | | |
| Method Summary | |
| public void | checkIn(String id, String documentPath, String user)
Method to document checkin. | | public Document | checkOut(String id, String user)
Method to document checkout. | | public void | configure(Properties properties)
| | public String | create(String documentName, String documentPath, String mimeType, String user, String foDocumentId, boolean isTemplate, String templateId)
Method that creates document in database. | | public void | createVersion(String documentId, String user)
| | public void | delete(String id, String user)
Method to delete document by document id. | | public Document[] | getDeleted(boolean isTemplate)
Getting all deleted documents or templates. | | public Document | getDocument(String id)
Method to get document from database by document id. | | public DocumentVersion | getDocumentVersion(String id)
Method to get documentVersion from database by document version id. | | public DocumentVersion[] | getDocumentVersions(String id)
Getting document versions by document id. | | public Document[] | getDocuments(boolean isTemplate)
Getting all available documents or templates. | | public Log | getLogger()
| | public void | lock(String id, String user)
Method to document lock. | | public void | restore(String id, String user)
Restore document version - set as current version. | | public void | restoreDocumentVersion(String versionId, String user)
Restore document version - set as current version. | | public void | setLogger(Log logger)
| | public void | switchArchived(String documentId, String user)
| | public void | switchAutoVersionable(String documentId, String user)
| | public void | unCheckOut(String id, String user)
Method to document unCheckout. | | public void | unlock(String id, String user)
Method to document unlock. | | public void | update(String id, String path, String user, String foDocumentId)
Method to document update. |
| checkIn | | public void checkIn(String id, String documentPath, String user) throws BaseException(Code) | | Method to document checkin. This method accepts document id, byte array document
content and user as Strings and sets LOCK flag to false.
Parameters:
id -
Parameters:
documentPath -
Parameters:
user -
throws:
BaseException - - is document isn't checked out |
| checkOut | | public Document checkOut(String id, String user) throws BaseException(Code) | | Method to document checkout. This method accepts document id and user as Strings and
sets LOCK flag to true.
Parameters:
id - (Document ID)
Parameters:
user - (User ID)
throws:
BaseException - - already checked out |
| create | | public String create(String documentName, String documentPath, String mimeType, String user, String foDocumentId, boolean isTemplate, String templateId) throws BaseException(Code) | | Method that creates document in database.
Parameters:
documentName -
Parameters:
documentPath -
Parameters:
mimeType -
Parameters:
user -
Parameters:
foDocumentId -
Parameters:
isTemplate -
Parameters:
getTemplateRef - id
throws:
BaseException - |
| createVersion | | public void createVersion(String documentId, String user) throws BaseException(Code) | | Creates version for documents that are not autoversionable
Parameters:
documentDO -
Parameters:
userName -
throws:
BaseException - |
| delete | | public void delete(String id, String user) throws BaseException(Code) | | Method to delete document by document id. This method sets deleted flag to true and
lastModifiedBy to user
Parameters:
id -
Parameters:
user -
throws:
BaseException - |
| getLogger | | public Log getLogger()(Code) | | Getter for logger
|
| lock | | public void lock(String id, String user) throws BaseException(Code) | | Method to document lock. This method accepts document id and user as Strings. and
sets LOCK flag to false.
Parameters:
id -
Parameters:
user -
throws:
BaseException - |
| restoreDocumentVersion | | public void restoreDocumentVersion(String versionId, String user) throws BaseException(Code) | | Restore document version - set as current version.
Parameters:
documentVersion -
Parameters:
user -
throws:
BaseException - |
| setLogger | | public void setLogger(Log logger)(Code) | | Setter for logger
Parameters:
logger - |
| unCheckOut | | public void unCheckOut(String id, String user) throws BaseException(Code) | | Method to document unCheckout. This method accepts document id and user as Strings
and sets LOCK flag to false.
Parameters:
id -
Parameters:
user -
throws:
BaseException - - document isn't locked |
| unlock | | public void unlock(String id, String user) throws BaseException(Code) | | Method to document unlock. This method accepts document id and user as Strings and
sets LOCK flag to false.
Parameters:
id -
Parameters:
user -
throws:
BaseException - |
| update | | public void update(String id, String path, String user, String foDocumentId) throws BaseException(Code) | | Method to document update. This method will be executed after document save.
Parameters:
id -
Parameters:
path -
Parameters:
user -
Parameters:
foDocumentId -
throws:
BaseException - |
|
|