com.sssw.cm.event.api
Class EboFolderMovedEvent

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.EboFolderMovedEvent

All Implemented Interfaces:

Serializable

public class EboFolderMovedEvent

extends EboCmElementEvent

This event is fired off when a folder is moved.

See Also:

Serialized Form

Field Summary

static int

EVENT_ID_FOLDER_MOVED The event ID of the "folder moved" 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

EboFolderMovedEvent(EbiContext context, EbiDocFolder sourceFolder, EbiDocFolder destFolder, boolean withSecurity, boolean overwrite, int docParts)
Constructor.

Method Summary

EbiDocFolder	getDestFolder() Gets the destination folder
int	getDocParts() Tells which parts of documents are to be moved.
int	getEventID() Returns the event ID.
EbiDocFolder	getSourceFolder() Gets the source folder
String	getVerboseDescr() Returns a verbose description of this event.
boolean	mustOverwrite() Tells whether existing elements are to be overwritten.
boolean	withSecurity() Tells whether the folder's security is preserved.

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_FOLDER_MOVED

public static final int EVENT_ID_FOLDER_MOVED

The event ID of the "folder moved" event.

Constructor Detail

EboFolderMovedEvent

public EboFolderMovedEvent(EbiContext context,
                           EbiDocFolder sourceFolder,
                           EbiDocFolder destFolder,
                           boolean withSecurity,
                           boolean overwrite,
                           int docParts)

Constructor.

Parameters:

context - the context of the user moving the folder

sourceFolder - the Folder being moved

destFolder - the destination Folder

withSecurity - if true, preserve Folder's ACL

overwrite - if true, overwrite any already existing entries

docParts - which parts of Documents to move

Method Detail

getSourceFolder

public EbiDocFolder getSourceFolder()

Gets the source folder

Returns:

the source folder metadata

getDestFolder

public EbiDocFolder getDestFolder()

Gets the destination folder

Returns:

the destination folder metadata

withSecurity

public boolean withSecurity()

Tells whether the folder's security is preserved.

Returns:

true if the folder's security is preserved, false otherwise

mustOverwrite

public boolean mustOverwrite()

Tells whether existing elements are to be overwritten.

Returns:

true if any existing elements are to be overwritten, false otherwise

getDocParts

public int getDocParts()

Tells which parts of documents are to be moved.

Returns:

the doc parts specifier

See Also:

EbiDocument

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