com.sssw.cm.event.api
Class EboFolderCopiedEvent

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

All Implemented Interfaces:

Serializable

public class EboFolderCopiedEvent

extends EboCmElementEvent

This event is fired off when a folder is copied.

See Also:

Serialized Form

Field Summary

static int

EVENT_ID_FOLDER_COPIED The event ID of the "folder copied" 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

EboFolderCopiedEvent(EbiContext context, EbiDocFolder sourceFolder, EbiDocFolder destFolder, boolean copyFolderSecurity, boolean copySubfolders, boolean copyDocuments, boolean overwrite, int docParts)
Constructor.

Method Summary

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

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_COPIED

public static final int EVENT_ID_FOLDER_COPIED

The event ID of the "folder copied" event.

Constructor Detail

EboFolderCopiedEvent

public EboFolderCopiedEvent(EbiContext context,
                            EbiDocFolder sourceFolder,
                            EbiDocFolder destFolder,
                            boolean copyFolderSecurity,
                            boolean copySubfolders,
                            boolean copyDocuments,
                            boolean overwrite,
                            int docParts)

Constructor.

Parameters:

context - the context of the user copying the folder

sourceFolder - the Folder to copy

destFolder - the destination Folder

copyFolderSecurity - if true, copy the Folder's ACL

copySubfolders - if true, do a recursive copy

copyDocuments - if true, copy the documents

overwrite - if true, overwrite any already existing entries

docParts - which parts of Documents to copy, if copyDocuments is true

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

mustCopyFolderSecurity

public boolean mustCopyFolderSecurity()

Tells whether the folder's security is copied.

Returns:

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

mustCopySubfolders

public boolean mustCopySubfolders()

Tells whether the subfolders are to be copied

Returns:

true if the subfolders are to be copied, false otherwise

mustCopyDocuments

public boolean mustCopyDocuments()

Tells whether the documents are to be copied.

Returns:

true if the documents are to be copied, 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 (if documents are copied) are to be copied.

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