public class DocumentInstanceOutputProperties extends InstanceOutputProperties
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
Constructor and Description |
---|
DocumentInstanceOutputProperties() |
Modifier and Type | Method and Description |
---|---|
org.xwiki.model.reference.DocumentReference |
getAuthor() |
org.xwiki.model.reference.EntityReference |
getDefaultReference() |
org.xwiki.rendering.syntax.Syntax |
getDefaultSyntax() |
String |
getSaveComment() |
boolean |
isAuthorPreserved() |
boolean |
isAuthorSet() |
boolean |
isPreviousDeleted() |
boolean |
isStoppedWhenSaveFail() |
boolean |
isVersionPreserved() |
void |
setAuthor(org.xwiki.model.reference.DocumentReference author) |
void |
setAuthorPreserved(boolean authorPreserved) |
void |
setDefaultReference(org.xwiki.model.reference.EntityReference defaultReference) |
void |
setDefaultSyntax(org.xwiki.rendering.syntax.Syntax defaultSyntax) |
void |
setPreviousDeleted(boolean previousDeleted) |
void |
setSaveComment(String saveComment) |
void |
setStoppedWhenSaveFail(boolean stoppedWhenSaveFail) |
void |
setVersionPreserved(boolean versionPreserved) |
isVerbose, set, setVerbose
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
equals, hashCode, toString
public org.xwiki.model.reference.EntityReference getDefaultReference()
public void setDefaultReference(org.xwiki.model.reference.EntityReference defaultReference)
defaultReference
- The base reference to use to resolve reference from eventspublic String getSaveComment()
public void setSaveComment(String saveComment)
saveComment
- The comment to set when saving a documentpublic org.xwiki.rendering.syntax.Syntax getDefaultSyntax()
public void setDefaultSyntax(org.xwiki.rendering.syntax.Syntax defaultSyntax)
defaultSyntax
- The default syntax if not is provided in eventspublic boolean isPreviousDeleted()
public void setPreviousDeleted(boolean previousDeleted)
previousDeleted
- Indicate if existing document should be deleted before importing the new onepublic boolean isVersionPreserved()
public void setVersionPreserved(boolean versionPreserved)
versionPreserved
- Indicate if the versions coming from the events should be keptpublic org.xwiki.model.reference.DocumentReference getAuthor()
public void setAuthor(org.xwiki.model.reference.DocumentReference author)
author
- the author to use when saving documentspublic boolean isAuthorSet()
public boolean isAuthorPreserved()
public void setAuthorPreserved(boolean authorPreserved)
authorPreserved
- indicate if the authors coming from the events should be kept. Not taken into account if
setAuthor(DocumentReference)
is used.public boolean isStoppedWhenSaveFail()
public void setStoppedWhenSaveFail(boolean stoppedWhenSaveFail)
stoppedWhenSaveFail
- Indicate if an exception should be thrown if a document save fail.Copyright © 2004–2019 XWiki. All rights reserved.