com.atlassian.confluence.core
Interface SaveContext

All Known Implementing Classes:
DefaultSaveContext

public interface SaveContext

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.


Method Summary
 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)
           
 

Method Detail

isMinorEdit

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.

setMinorEdit

void setMinorEdit(boolean minorEdit)
Minor edits indicate that notifications should not be sent out informing users of changes made to the page.


doUpdateLastModifier

boolean doUpdateLastModifier()
UpdateLastModifier indicates whether to update the LastModifier field when saving a page.

Returns:
true if the LastModifier should be updated

setUpdateLastModifier

void setUpdateLastModifier(boolean updateLastModifier)

isEventSuppressed

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.


Copyright © 2003-2011 Atlassian. All Rights Reserved.