com.sssw.cm.event.api
Class EboCategoryCopiedEvent

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

All Implemented Interfaces:

Serializable

public class EboCategoryCopiedEvent

extends EboCmEvent

This event is fired off when a category is copied.

See Also:

Serialized Form

Field Summary

static int

EVENT_ID_CATEGORY_COPIED The event ID of the "category 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

EboCategoryCopiedEvent(EbiContext context, EbiDocCategory sourceCategory, EbiDocCategory destCategory, boolean copyCategorySecurity, boolean copySubcategories, boolean assignDocuments, boolean overwrite)
Constructor.

Method Summary

EbiDocCategory	getDestCategory() Gets the destination category
int	getEventID() Returns the event ID.
EbiDocCategory	getSourceCategory() Gets the source category
String	getVerboseDescr() Returns a verbose description of this event.
boolean	mustAssignDocuments() Tells whether the documents are to be assigned.
boolean	mustCopyCategorySecurity() Tells whether the category's security is copied.
boolean	mustCopySubcategories() Tells whether the subcategories are to be copied
boolean	mustOverwrite() Tells whether existing elements are to be overwritten.

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_CATEGORY_COPIED

public static final int EVENT_ID_CATEGORY_COPIED

The event ID of the "category copied" event.

Constructor Detail

EboCategoryCopiedEvent

public EboCategoryCopiedEvent(EbiContext context,
                              EbiDocCategory sourceCategory,
                              EbiDocCategory destCategory,
                              boolean copyCategorySecurity,
                              boolean copySubcategories,
                              boolean assignDocuments,
                              boolean overwrite)

Constructor.

Parameters:

context - context

sourceCategory - the category to copy

destCategory - the destination category

copyCategorySecurity - if true, category security is copied

copySubcategories - if true, a recursive copy is done

assignDocuments - assign documents into respective categories

overwrite - overwrite any existing directory entries

Method Detail

getSourceCategory

public EbiDocCategory getSourceCategory()

Gets the source category

Returns:

the source category metadata

getDestCategory

public EbiDocCategory getDestCategory()

Gets the destination category

Returns:

the destination category metadata

mustCopyCategorySecurity

public boolean mustCopyCategorySecurity()

Tells whether the category's security is copied.

Returns:

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

mustCopySubcategories

public boolean mustCopySubcategories()

Tells whether the subcategories are to be copied

Returns:

true if the subcategories are to be copied, false otherwise

mustAssignDocuments

public boolean mustAssignDocuments()

Tells whether the documents are to be assigned.

Returns:

true if the documents are to be assigned, 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

getEventID

public int getEventID()

Returns the event ID.

Overrides:

getEventID in class EboCmEvent

Returns:

the event ID

getVerboseDescr

public String getVerboseDescr()

Returns a verbose description of this event.

Overrides:

getVerboseDescr in class EboCmEvent

Tags copied from class: EboCmEvent

Returns:

a verbose description of the event