com.sssw.cm.event.api
Class EboDocTypesListedEvent

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

All Implemented Interfaces:

Serializable

public class EboDocTypesListedEvent

extends EboCmEvent

This event is fired off when document types are listed.

See Also:

Serialized Form

Field Summary

static int

EVENT_ID_DOC_TYPES_LISTED The event ID of the "document types listed" 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

EboDocTypesListedEvent(EbiContext context, boolean filterAccessible)
Constructor.

Method Summary

int	getEventID() Returns the event ID.
String	getVerboseDescr() Returns a verbose description of this event.
boolean	mustFilterAccessible() Tells whether the returned field list must be filtered based on security access for the user listing the doctypes.

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_TYPES_LISTED

public static final int EVENT_ID_DOC_TYPES_LISTED

The event ID of the "document types listed" event.

Constructor Detail

EboDocTypesListedEvent

public EboDocTypesListedEvent(EbiContext context,
                              boolean filterAccessible)

Constructor.

Parameters:

context - context of the user listing doctypes

filterAccessible - if true, only doctypes that are READ-accessible to the user are returned, otherwise all the doctypes are returned

Method Detail

mustFilterAccessible

public boolean mustFilterAccessible()

Tells whether the returned field list must be filtered based on security access for the user listing the doctypes.

Returns:

true if only the doctypes that are READ-accessible to the user are returned, false if all the doctypes are to be returned

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