Package com.atlassian.confluence.core

Class AbstractOperationContext<TRIGGER extends OperationTrigger>

java.lang.Object

com.atlassian.confluence.core.AbstractOperationContext<TRIGGER>

All Implemented Interfaces:

OperationContext<TRIGGER>

Direct Known Subclasses:

DefaultDeleteContext, DefaultSaveContext

public abstract class AbstractOperationContext<TRIGGER extends OperationTrigger>
extends Object
implements OperationContext<TRIGGER>

Since:

6.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractOperationContext.BaseBuilder<T extends AbstractOperationContext.BaseBuilder,TRIGGER extends OperationTrigger>

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	suppressNotifications

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOperationContext(AbstractOperationContext.BaseBuilder<?,TRIGGER> builder)

Method Summary

Modifier and Type	Method	Description
@NonNull TRIGGER	getUpdateTrigger()
boolean	isEventSuppressed()	Control whether the save should result in an event being published.
boolean	isSuppressNotifications()	Indicates that notifications should not be sent out informing users of the changes to this content.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

suppressNotifications

protected boolean suppressNotifications

Constructor Detail

AbstractOperationContext

protected AbstractOperationContext(AbstractOperationContext.BaseBuilder<?,TRIGGER> builder)

Method Detail

isEventSuppressed

public final boolean isEventSuppressed()

Description copied from interface: OperationContext

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.

Specified by:

isEventSuppressed in interface OperationContext<TRIGGER extends OperationTrigger>

Returns:

if true if event publishing is to be suppressed.

isSuppressNotifications

public final boolean isSuppressNotifications()

Description copied from interface: OperationContext

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

Specified by:

isSuppressNotifications in interface OperationContext<TRIGGER extends OperationTrigger>

Returns:

true if notifications should not be sent to users.

getUpdateTrigger

public final @NonNull TRIGGER getUpdateTrigger()

Specified by:

getUpdateTrigger in interface OperationContext<TRIGGER extends OperationTrigger>

Returns:

an indication of how the content update was triggered