public interface DocumentMapper extends DocumentGetter
| Modifier and Type | Interface and Description |
|---|---|
static class |
DocumentMapper.SaveOpts
Document save options.
|
static class |
DocumentMapper.TextDocumentMenuIndexPair |
| Modifier and Type | Method and Description |
|---|---|
void |
changeDocumentDefaultVersion(int docId,
int newDocDefaultVersionNo,
UserDomainObject publisher)
Changes doc's default version.
|
<T extends DocumentDomainObject> |
copyDocument(T doc,
UserDomainObject user)
Creates a new doc as a copy of an existing doc.
|
DocumentDomainObject |
createDocumentOfTypeFromParent(int documentTypeId,
DocumentDomainObject parentDoc,
UserDomainObject user)
Creates new Document which inherits parent doc's meta excluding keywords and properties.
|
void |
deleteDocument(DocumentDomainObject document) |
void |
deleteDocument(int docId) |
java.util.List<java.lang.String> |
getAllDocumentAlias() |
java.util.List<java.lang.Integer> |
getAllDocumentIds() |
java.util.Map<java.lang.Integer,java.lang.String> |
getAllDocumentTypeIdsAndNamesInUsersLanguage(UserDomainObject user) |
CategoryMapper |
getCategoryMapper() |
java.util.Map<DocumentLanguage,DocumentCommonContent> |
getCommonContents(int docId,
int versionNo) |
<T extends DocumentDomainObject> |
getCustomDocument(DocRef docRef) |
com.imcode.db.Database |
getDatabase() |
<T extends DocumentDomainObject> |
getDefaultDocument(int docId) |
<T extends DocumentDomainObject> |
getDefaultDocument(int docId,
DocumentLanguage language)
Returns default document
|
<T extends DocumentDomainObject> |
getDefaultDocument(int docId,
java.lang.String languageCode) |
<T extends DocumentDomainObject> |
getDocument(int docId)
Returns document.
|
DocumentDomainObject |
getDocument(java.lang.String documentIdentity) |
DocumentIndex |
getDocumentIndex() |
DocumentLanguages |
getDocumentLanguages() |
DocumentMapper.TextDocumentMenuIndexPair[] |
getDocumentMenuPairsContainingDocument(DocumentDomainObject document) |
DocumentReference |
getDocumentReference(DocumentDomainObject document) |
java.util.List<DocumentDomainObject> |
getDocuments(java.util.Collection<java.lang.Integer> documentIds) |
java.util.Iterator<DocumentDomainObject> |
getDocumentsIterator(org.apache.commons.lang.math.IntRange idRange) |
java.util.List<DocumentDomainObject> |
getDocumentsWithPermissionsForRole(RoleDomainObject role) |
DocumentVersionInfo |
getDocumentVersionInfo(int documentId) |
int |
getHighestDocumentId() |
int |
getLowestDocumentId() |
<T extends DocumentDomainObject> |
getVersionedDocument(java.lang.String documentIdentity,
java.lang.String langCode,
javax.servlet.ServletRequest request)
Get document version by document id or alias, parameters in request and language code
|
<T extends DocumentDomainObject> |
getWorkingDocument(int docId) |
<T extends DocumentDomainObject> |
getWorkingDocument(int docId,
DocumentLanguage language) |
void |
invalidateDocument(DocumentDomainObject document) |
void |
invalidateDocument(int docId) |
DocumentVersion |
makeDocumentVersion(int docId,
UserDomainObject user)
Creates next document version.
|
int |
saveDocument(DocumentDomainObject doc,
java.util.Map<DocumentLanguage,DocumentCommonContent> commonContents,
UserDomainObject user)
Updates existing document.
|
int |
saveDocument(DocumentDomainObject doc,
UserDomainObject user)
Updates existing document.
|
<T extends DocumentDomainObject> |
saveNewDocument(T doc,
java.util.Map<DocumentLanguage,DocumentCommonContent> appearances,
UserDomainObject user)
Saves doc as new.
|
<T extends DocumentDomainObject> |
saveNewDocument(T doc,
UserDomainObject user)
Saves doc as new.
|
void |
saveTextDocText(TextDocTextContainer container,
UserDomainObject user)
Saves text and non-saved enclosing content loop the text may refer.
|
void |
setDocumentIndex(DocumentIndex documentIndex) |
java.lang.Integer |
toDocumentId(java.lang.String documentIdentity) |
DocumentVersionInfo getDocumentVersionInfo(int documentId)
documentId - document id.DocumentDomainObject createDocumentOfTypeFromParent(int documentTypeId, DocumentDomainObject parentDoc, UserDomainObject user)
Doc's CommonContentJPA and content (texts, images, urls, files, etc) are not inherited.
DocumentReference getDocumentReference(DocumentDomainObject document)
<T extends DocumentDomainObject> T saveNewDocument(T doc, UserDomainObject user) throws DocumentSaveException, NoPermissionToAddDocumentToMenuException
DocumentSaveExceptionNoPermissionToAddDocumentToMenuExceptioncreateDocumentOfTypeFromParent(int, DocumentDomainObject, UserDomainObject),
DocumentDomainObject.fromDocumentTypeId(int)<T extends DocumentDomainObject> T saveNewDocument(T doc, java.util.Map<DocumentLanguage,DocumentCommonContent> appearances, UserDomainObject user) throws DocumentSaveException, NoPermissionToAddDocumentToMenuException
According to the spec, new doc creation UI allows to provide i18nMeta texts in all languages available in the system. However, a DocumentDomainObject has one-to-one relationship with i18nMeta. To workaround this limitation and provide backward compatibility with legacy API, i18nMeta-s are passed in a separate parameter and doc's i18nMeta is ignored.
DocumentSaveExceptionNoPermissionToAddDocumentToMenuExceptionint saveDocument(DocumentDomainObject doc, UserDomainObject user) throws DocumentSaveException, NoPermissionToAddDocumentToMenuException, NoPermissionToEditDocumentException
int saveDocument(DocumentDomainObject doc, java.util.Map<DocumentLanguage,DocumentCommonContent> commonContents, UserDomainObject user) throws DocumentSaveException, NoPermissionToAddDocumentToMenuException, NoPermissionToEditDocumentException
DocumentVersion makeDocumentVersion(int docId, UserDomainObject user)
Saves document's working version copy as next document version.
void changeDocumentDefaultVersion(int docId,
int newDocDefaultVersionNo,
UserDomainObject publisher)
void invalidateDocument(DocumentDomainObject document)
void invalidateDocument(int docId)
DocumentIndex getDocumentIndex()
void setDocumentIndex(DocumentIndex documentIndex)
void deleteDocument(int docId)
void deleteDocument(DocumentDomainObject document)
java.util.Map<java.lang.Integer,java.lang.String> getAllDocumentTypeIdsAndNamesInUsersLanguage(UserDomainObject user)
DocumentMapper.TextDocumentMenuIndexPair[] getDocumentMenuPairsContainingDocument(DocumentDomainObject document)
java.util.Iterator<DocumentDomainObject> getDocumentsIterator(org.apache.commons.lang.math.IntRange idRange)
java.util.List<java.lang.Integer> getAllDocumentIds()
java.util.List<java.lang.String> getAllDocumentAlias()
DocumentDomainObject getDocument(java.lang.String documentIdentity)
documentIdentity - document id or alias.java.lang.Integer toDocumentId(java.lang.String documentIdentity)
documentIdentity - document id or aliasint getLowestDocumentId()
int getHighestDocumentId()
<T extends DocumentDomainObject> T copyDocument(T doc, UserDomainObject user) throws NoPermissionToAddDocumentToMenuException, DocumentSaveException
Please note that provided document is not used as a new document prototype/template; it is used as a DTO to pass existing doc identities (id, version, language) to the method.
doc - existing doc.user - the userNoPermissionToAddDocumentToMenuExceptionDocumentSaveExceptionjava.util.List<DocumentDomainObject> getDocumentsWithPermissionsForRole(RoleDomainObject role)
<T extends DocumentDomainObject> T getDefaultDocument(int docId)
getDefaultDocument in interface DocumentGetterdocId - document id<T extends DocumentDomainObject> T getWorkingDocument(int docId)
docId - document id<T extends DocumentDomainObject> T getDocument(int docId)
Delegates call to a callback associated with a user. If there is no callback then a default document is returned.
getDocument in interface DocumentGetterdocId - document id.<T extends DocumentDomainObject> T getWorkingDocument(int docId, DocumentLanguage language)
docId - document idlanguage - language<T extends DocumentDomainObject> T getDefaultDocument(int docId, DocumentLanguage language)
DocumentGettergetDefaultDocument in interface DocumentGetterdocId - document idlanguage - language<T extends DocumentDomainObject> T getDefaultDocument(int docId, java.lang.String languageCode)
docId - document idlanguageCode - language code<T extends DocumentDomainObject> T getCustomDocument(DocRef docRef)
CategoryMapper getCategoryMapper()
com.imcode.db.Database getDatabase()
DocumentLanguages getDocumentLanguages()
void saveTextDocText(TextDocTextContainer container, UserDomainObject user) throws NoPermissionInternalException
Non saved enclosing content loop might be added to the doc by ContentLoopTag2.
container - - text being savedjava.lang.IllegalStateException - if text 'docNo', 'versionNo', 'no' or 'language' is not setNoPermissionInternalExceptionjava.util.List<DocumentDomainObject> getDocuments(java.util.Collection<java.lang.Integer> documentIds)
getDocuments in interface DocumentGetterdocumentIds - id's of documents<T extends DocumentDomainObject> T getVersionedDocument(java.lang.String documentIdentity, java.lang.String langCode, javax.servlet.ServletRequest request)
documentIdentity - document id or aliasjava.util.Map<DocumentLanguage,DocumentCommonContent> getCommonContents(int docId, int versionNo)