public class IndexMaskDocument extends Object
Modifier and Type | Class and Description |
---|---|
static class |
IndexMaskDocument.AclWriteMode
Possible ways of storing ACLs when the document is saved.
|
Modifier and Type | Method and Description |
---|---|
void |
addAcl(String aclName)
Adds an ACL to the document.
|
void |
addIndexValue(String fieldName,
Object value)
Adds an index-value to the document.
|
Set<String> |
getAcls()
Returns the ACLs currently set.
|
IndexMaskDocument.AclWriteMode |
getAclWriteMode() |
String |
getComment() |
DocumentId |
getDocumentId()
Returns the ID of the document if the document was already archived.
|
ResultProperties |
getIndexProperties()
Returns the document's index-properties or null, if the document was not yet archived.
|
Map<String,Object> |
getIndexValues() |
Map<String,DocumentVariable> |
getVariables()
Returns the variables contained in the document.
|
boolean |
isArchived() |
boolean |
isVariablesChanged() |
void |
removeAcl(String aclName)
Removes an ACL that was added by
addAcl(String) before. |
void |
removeIndexValue(String fieldName)
Removes a value previously added by
addIndexValue(String, Object) . |
void |
setAclWriteMode(IndexMaskDocument.AclWriteMode mode)
Sets how to store the ACLs on the document.
|
void |
setComment(String comment)
Allows to set a comment to use for the new revision.
|
void |
setVariable(DocumentVariable variable)
Sets a new variable.
|
public DocumentId getDocumentId() throws DocumentIdentificationException
DocumentIdentificationException
- if the document was not yet archivedpublic ResultProperties getIndexProperties()
public Map<String,DocumentVariable> getVariables()
public void addAcl(String aclName)
aclName
- the name of the ACL to addpublic void removeAcl(String aclName)
addAcl(String)
before.aclName
- the name of the ACL to removepublic void setAclWriteMode(IndexMaskDocument.AclWriteMode mode)
mode
- IndexMaskDocument.AclWriteMode
to usepublic IndexMaskDocument.AclWriteMode getAclWriteMode()
public boolean isArchived()
public String getComment()
public void setComment(String comment)
comment
- comment to use for the new revisionpublic void addIndexValue(String fieldName, Object value)
fieldName
- the name of the fieldvalue
- the value of the property (must match the field-type)public void removeIndexValue(String fieldName)
addIndexValue(String, Object)
.fieldName
- name of the value's fieldpublic void setVariable(DocumentVariable variable)
variable
- the DocumentVariable
to setpublic boolean isVariablesChanged()
Copyright © 2020 Hyland Software Germany GmbH. All rights reserved.