com.sssw.cm.event.api
Class EboDocLayoutStylesListedEvent

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

All Implemented Interfaces:

Serializable

public class EboDocLayoutStylesListedEvent

extends EboCmElementEvent

This event is fired off when document layout styles are listed.

See Also:

Serialized Form

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

EboDocLayoutStylesListedEvent(EbiContext context, EbiDocType docType, boolean filterAccessible)
Constructor.

Method Summary

EbiDocType	getDocType() Returns the doctype whose styles are listed.
int	getEventID() Returns the event ID.
String	getVerboseDescr() Returns a verbose description of this event.
boolean	mustFilterAccessible() Tells whether the returned style list must be filtered based on security access for the user listing the style.

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

Constructor Detail

EboDocLayoutStylesListedEvent

public EboDocLayoutStylesListedEvent(EbiContext context,
                                     EbiDocType docType,
                                     boolean filterAccessible)

Constructor.

Parameters:

context - context of the user listing styles

docType - the document type whose styles are to be listed

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

Method Detail

mustFilterAccessible

public boolean mustFilterAccessible()

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

Returns:

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

getDocType

public EbiDocType getDocType()

Returns the doctype whose styles are listed.

Returns:

the doctype whose styles are listed

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