|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IDocumentRepositoryManager
Method Summary | |
---|---|
DocumentRepositoryEntry |
addDocument(DocumentRepositoryEntry document)
Adds a new document to the repository |
DocumentRepositoryEntry |
addDocument(DocumentRepositoryEntry document,
Boolean ignoreSizeLimit)
Adds a new document to the repository |
void |
authorizeDocumentForCurrentSession(IDIFSession session,
Long documentID)
Declares the requested document to be declared as authorized access for the current session scope. |
void |
deleteDocument(Long id)
Deletes an existing document from the repository |
DocumentRepositoryEntry |
getDocument(Long id)
Searches an existing document by it's unique identifier |
List<DocumentRepositoryEntry> |
getDocumentByOriginalFileName(String originalFileName)
Searches for a document by it's original file name |
List<DocumentRepositoryEntry> |
getDocumentsByCreator(String creatorUserID)
Searches an existing document by it's creator |
List<DocumentRepositoryEntry> |
getDocumentsByIds(List<Long> documentIds)
Get DocumentRepositoryEntry by ids |
boolean |
isDocumentAuthorizedInCurrentSession(IDIFSession session,
Long documentID)
Searches the authorization list in session for the document ID |
DocumentRepositoryEntry |
updateDocument(DocumentRepositoryEntry document)
Updates an existing document with the new data |
Method Detail |
---|
DocumentRepositoryEntry addDocument(DocumentRepositoryEntry document) throws DocumentRepositoryException
document
- the document to add
DocumentRepositoryException
DocumentRepositoryEntry addDocument(DocumentRepositoryEntry document, Boolean ignoreSizeLimit) throws DocumentRepositoryException
document
- the document to addignoreSizeLimit
- ignores the size limit
DocumentRepositoryException
void authorizeDocumentForCurrentSession(IDIFSession session, Long documentID)
session
- the current sessiondocumentID
- the document ID to authorizevoid deleteDocument(Long id) throws DocumentRepositoryException
id
- the document to delete
DocumentRepositoryException
DocumentRepositoryEntry getDocument(Long id) throws DocumentRepositoryException
id
- the document id
DocumentRepositoryException
List<DocumentRepositoryEntry> getDocumentByOriginalFileName(String originalFileName) throws DocumentRepositoryException
originalFileName
- the file name
DocumentRepositoryException
List<DocumentRepositoryEntry> getDocumentsByCreator(String creatorUserID) throws DocumentRepositoryException
creatorUserID
- the user id that created the document
DocumentRepositoryException
List<DocumentRepositoryEntry> getDocumentsByIds(List<Long> documentIds) throws DocumentRepositoryException
DocumentRepositoryEntry
by ids
documentIds
- the array of document ids
DocumentRepositoryEntry
DocumentRepositoryException
boolean isDocumentAuthorizedInCurrentSession(IDIFSession session, Long documentID)
session
- the current sessiondocumentID
- the document ID to check for authorization
DocumentRepositoryEntry updateDocument(DocumentRepositoryEntry document)
document
- the document to update in the respository
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |