com.sssw.cm.event.api
Class EboDocQueryExecutedEvent

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

All Implemented Interfaces:

Serializable

public class EboDocQueryExecutedEvent

extends EboCmEvent

This event is fired off when a document query is executed via any of the findElements... methods off the Content Manager.

See Also:

Serialized Form

Field Summary

static int

EVENT_ID_DOC_QUERY_EXECUTED The event ID of the "document query executed" 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

EboDocQueryExecutedEvent(EbiContext context, EbiQuery query, boolean filterResults)
Constructor.

Method Summary

int	getEventID() Returns the event ID.
EbiQuery	getQuery() Returns the query
String	getVerboseDescr() Returns a verbose description of this event.
boolean	mustFilterResults() Returns true if query results are to be security-filtered.

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_QUERY_EXECUTED

public static final int EVENT_ID_DOC_QUERY_EXECUTED

The event ID of the "document query executed" event.

Constructor Detail

EboDocQueryExecutedEvent

public EboDocQueryExecutedEvent(EbiContext context,
                                EbiQuery query,
                                boolean filterResults)

Constructor.

Parameters:

context - context of the user executing the query

query - the query to execute

filterResults - whether the results must be security-filtered

Method Detail

getQuery

public EbiQuery getQuery()

Returns the query

Returns:

the query

mustFilterResults

public boolean mustFilterResults()

Returns true if query results are to be security-filtered.

Returns:

true if the query results are to be security-filtered

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