Package org.craftercms.studio.api.v2.event.lock

Class LockContentEvent

java.lang.Object

org.craftercms.studio.api.v2.event.StudioEvent

org.craftercms.studio.api.v2.event.SiteAwareEvent

org.craftercms.studio.api.v2.event.lock.LockContentEvent

All Implemented Interfaces:

BroadcastEvent, SiteBroadcastEvent

public class LockContentEvent
extends SiteAwareEvent
implements SiteBroadcastEvent

Event triggered when content is locked or unlocked

Note:This event is not part of the content hierarchy to prevent triggering a reindex

Since:

4.0.0

Author:

joseross

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	locked
protected final String	targetPath

Fields inherited from class org.craftercms.studio.api.v2.event.SiteAwareEvent

siteId

Fields inherited from class org.craftercms.studio.api.v2.event.StudioEvent

timestamp, user

Constructor Summary

Constructors

Constructor	Description
LockContentEvent(org.springframework.security.core.Authentication authentication, String siteId, String targetPath, boolean locked)

Method Summary

Modifier and Type	Method	Description
String	getEventType()
String	getTargetPath()
boolean	isLocked()
String	toString()

Methods inherited from class org.craftercms.studio.api.v2.event.SiteAwareEvent

getSiteId

Methods inherited from class org.craftercms.studio.api.v2.event.StudioEvent

getTimestamp, getUser

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.craftercms.studio.api.v2.event.SiteBroadcastEvent

getSiteId

Field Details

targetPath

protected final String targetPath

locked

protected final boolean locked

Constructor Details

LockContentEvent

public LockContentEvent(org.springframework.security.core.Authentication authentication,
 String siteId,
 String targetPath,
 boolean locked)

Method Details

getTargetPath

public String getTargetPath()

isLocked

public boolean isLocked()

getEventType

public String getEventType()

Specified by:

getEventType in interface BroadcastEvent

toString

public String toString()

Overrides:

toString in class Object