com.atlassian.confluence.core

Interface SaveContext

All Superinterfaces:

OperationContext<PageUpdateTrigger>

All Known Implementing Classes:

DefaultSaveContext

public interface SaveContext
extends OperationContext<PageUpdateTrigger>

Context for managers to call upon when making decisions about how to save an object.

Since:

6.0

Method Summary

Modifier and Type	Method and Description
boolean	doUpdateLastModifier() UpdateLastModifier indicates whether to update the LastModifier field when saving a page.
boolean	isMinorEdit() Deprecated. since 5.4. Use com.atlassian.confluence.core.SaveContext#isSuppressNotifications instead. Minor edits indicate that notifications should not be sent out informing users of changes made to the page.
boolean	isSuppressAutowatch() Control whether the save should result in the page being watched by the creator if they have their autowatch setting on.
void	setMinorEdit(boolean minorEdit) Deprecated. since 5.4. Use DefaultSaveContext.builder() instead. Minor edits indicate that notifications should not be sent out informing users of changes made to the page.
void	setSuppressNotifications(boolean suppressNotifications) Deprecated. since 6.0. Use DefaultSaveContext.builder() instead.
void	setUpdateLastModifier(boolean updateLastModifier) Deprecated. since 6.0. Use DefaultSaveContext.builder() instead.

Methods inherited from interface com.atlassian.confluence.core.OperationContext

getUpdateTrigger, isEventSuppressed, isSuppressNotifications

Method Detail

isMinorEdit

@Deprecated
boolean isMinorEdit()

Deprecated. since 5.4. Use com.atlassian.confluence.core.SaveContext#isSuppressNotifications instead. 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

@Deprecated
void setMinorEdit(boolean minorEdit)

Deprecated. since 5.4. Use DefaultSaveContext.builder() instead. 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

@Deprecated
void setUpdateLastModifier(boolean updateLastModifier)

Deprecated. since 6.0. Use DefaultSaveContext.builder() instead.

setSuppressNotifications

@Deprecated
void setSuppressNotifications(boolean suppressNotifications)

Deprecated. since 6.0. Use DefaultSaveContext.builder() instead.

Indicates that notifications should not be sent out informing users of the changes to this content.

isSuppressAutowatch

boolean isSuppressAutowatch()

Control whether the save should result in the page being watched by the creator if they have their autowatch setting on. This has no effect if the event is suppressed as it is implemented as a property on the event.

Returns:

if true if automatic watches is to be suppressed.