public interface

SaveContext

com.atlassian.confluence.core.SaveContext
Known Indirect Subclasses

Class Overview

Context for managers to call upon when making decisions about how to save an object. This type could easily evolve into an UpdateContext, CreateContext, etc., this version of the interface is a first step.

Summary

Public Methods
boolean doUpdateLastModifier()
UpdateLastModifier indicates whether to update the LastModifier field when saving a page.
boolean isEventSuppressed()
Control whether the save should result in an event being published.
boolean isMinorEdit()
Minor edits indicate that notifications should not be sent out informing users of changes made to the page.
void setMinorEdit(boolean minorEdit)
Minor edits indicate that notifications should not be sent out informing users of changes made to the page.
void setUpdateLastModifier(boolean updateLastModifier)

Public Methods

public boolean doUpdateLastModifier ()

UpdateLastModifier indicates whether to update the LastModifier field when saving a page.

Returns
  • true if the LastModifier should be updated

public boolean isEventSuppressed ()

Control whether the save should result in an event being published. If this is false then there will be no event published. It should be noted that even if this is false, whether an event is actually published is a decision of the involved publishing component. So by setting this true you can ensure there is not an event. Setting false does not guarantee you will get an event.

Returns
  • if true if event publishing is to be suppressed.

public boolean isMinorEdit ()

Minor edits indicate that notifications should not be sent out informing users of changes made to the page.

Returns
  • true if a 'minor edit' has been made.

public void setMinorEdit (boolean minorEdit)

Minor edits indicate that notifications should not be sent out informing users of changes made to the page.

public void setUpdateLastModifier (boolean updateLastModifier)