com.sssw.cm.event.api
Class EboDocumentRolledBackEvent

java.lang.Object
 |
 +--com.sssw.fw.event.api.EboEvent
       |
       +--com.sssw.fw.event.api.EboStateChangeEvent
             |
             +--com.sssw.cm.event.api.EboCmEvent
                   |
                   +--com.sssw.cm.event.api.EboCmElementEvent
                         |
                         +--com.sssw.cm.event.api.EboDocumentRolledBackEvent

All Implemented Interfaces:

Serializable

public class EboDocumentRolledBackEvent

extends EboCmElementEvent

This event is fired off when a document is rolled back.

See Also:

Serialized Form

Field Summary

static int

EVENT_ID_DOC_ROLLED_BACK The event ID of the "document rolled back" event.

Fields inherited from class com.sssw.fw.event.api.EboStateChangeEvent

EVENT_ID_BASE, EVENT_ID_LAST, EVENT_ID_UNKNOWN, SC_BASE, SC_CHECK_ACCESS, SC_CLEAR, SC_COPY, SC_CREATE, SC_DEFAULT, SC_DELETE, SC_EXECUTE, SC_EXPORT, SC_FAIL, SC_GENERATE, SC_IMPORT, SC_INVALIDATE, SC_LAST, SC_LIST, SC_LOGOFF, SC_LOGON, SC_MOVE, SC_PUT, SC_QUERY, SC_REDEPLOY, SC_REGISTERED, SC_RETRIEVE, SC_SELECT, SC_SILENCE, SC_START, SC_STATUS, SC_STOP, SC_UNREGISTERED, SC_UPDATE, STR_SC_CHECK_ACCESS, STR_SC_CLEAR, STR_SC_COPY, STR_SC_CREATE, STR_SC_DEFAULT, STR_SC_DELETE, STR_SC_EXECUTE, STR_SC_EXPORT, STR_SC_FAIL, STR_SC_GENERATE, STR_SC_IMPORT, STR_SC_INVALIDATE, STR_SC_LIST, STR_SC_LOGOFF, STR_SC_LOGON, STR_SC_MOVE, STR_SC_QUERY, STR_SC_REGISTERED, STR_SC_RETRIEVE, STR_SC_SELECT, STR_SC_SILENCE, STR_SC_START, STR_SC_STATUS, STR_SC_STOP, STR_SC_UNKNOWN, STR_SC_UNREGISTERED, STR_SC_UPDATE

Constructor Summary

EboDocumentRolledBackEvent(EbiContext context, EbiDocument doc, EbiDocVersion rollbackVersion, boolean publish)
Constructor

Method Summary

EbiDocument	getDocument() Gets the metadata for the document being rolled back
int	getEventID() Returns the event ID.
EbiDocVersion	getRollbackVersion() Gets the rollback version.
String	getVerboseDescr() Returns a verbose description of this event.
boolean	mustPublish() Tells whether the version that the document is rolled back to is to be published once the rollback has been successfully completed.

Methods inherited from class com.sssw.cm.event.api.EboCmElementEvent

getElement

Methods inherited from class com.sssw.cm.event.api.EboCmEvent

getContext

Methods inherited from class com.sssw.fw.event.api.EboStateChangeEvent

getState, getStateDescr, setState

Methods inherited from class com.sssw.fw.event.api.EboEvent

getObject, setObject

Methods inherited from class java.lang.Object

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

Field Detail

EVENT_ID_DOC_ROLLED_BACK

public static final int EVENT_ID_DOC_ROLLED_BACK

The event ID of the "document rolled back" event.

Constructor Detail

EboDocumentRolledBackEvent

public EboDocumentRolledBackEvent(EbiContext context,
                                  EbiDocument doc,
                                  EbiDocVersion rollbackVersion,
                                  boolean publish)

Constructor

Parameters:

context - the context of the user rolling back the document

doc - the document being rolled back

rollbackVersion - the version rolled back to

publish - if true, the version that the content is rolled back to is published

Method Detail

getDocument

public EbiDocument getDocument()

Gets the metadata for the document being rolled back

Returns:

the metadata for the document being rolled back

getRollbackVersion

public EbiDocVersion getRollbackVersion()

Gets the rollback version.

Returns:

the metadata of the version to roll back to

mustPublish

public boolean mustPublish()

Tells whether the version that the document is rolled back to is to be published once the rollback has been successfully completed.

Returns:

true if publish is to be done, false otherwise

getEventID

public int getEventID()

Returns the event ID.

Overrides:

getEventID in class EboCmElementEvent

Returns:

the event ID

getVerboseDescr

public String getVerboseDescr()

Returns a verbose description of this event.

Overrides:

getVerboseDescr in class EboCmElementEvent

Tags copied from class: EboCmElementEvent

Returns:

a verbose description of the event