Package overit.geocall.basic.bl.user.event

Class LoadUsersEvent

java.lang.Object

overit.geocall.bl.GenericEvent<PageResponse<BOUser>>

overit.geocall.bl.BusinessEvent<PageResponse<BOUser>>

overit.geocall.basic.bl.user.event.LoadUsersEvent

public class LoadUsersEvent
extends BusinessEvent<PageResponse<BOUser>>

Event that will be called to load the users information.

GCApi:

event

No Reactors

No Spouts

Nested Class Summary

Nested classes/interfaces inherited from class overit.geocall.bl.GenericEvent

GenericEvent.Step<O>

Field Summary

Fields

Modifier and Type	Field	Description
protected BOUser	filter
protected Collection<Long>	filterIds
protected Order	order
protected Page	page

Fields inherited from class overit.geocall.bl.GenericEvent

executorService, journal, streamJournal

Constructor Summary

Constructors

Constructor	Description
LoadUsersEvent(Page page, BOUser filter)	Create a new event that will be called to load the users information
LoadUsersEvent(Page page, BOUser filter, Order order)	Create a new event that will be called to load the users information
LoadUsersEvent(Page page, BOUser filter, Order order, Collection<Long> filterIds)	Create a new event that will be called to load the users information

Method Summary

Modifier and Type	Method	Description
BOUser	getFilter()	Returns the object containing the values that will be used to filter the query results.
Collection<Long>	getFilterIds()	Returns the object that handles the ids filter field. This filter field is used to specify one or more user's id to filter the results of the users load event.
Order	getOrder()	Returns the object that handles the order filter fields.
Page	getPage()	Returns will be used to paginate the results

Methods inherited from class overit.geocall.bl.BusinessEvent

doLaunch

Methods inherited from class overit.geocall.bl.GenericEvent

clearEvents, defineInterruptor, defineResult, getJournal, getResult, getSpouts, getStreamJournal, isInternal, launch, launch, launchAsync, launchAsync, register, registerSpouts

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

filter

protected BOUser filter

page

protected Page page

order

protected Order order

filterIds

protected Collection<Long> filterIds

Constructor Details

LoadUsersEvent

public LoadUsersEvent(Page page,
 BOUser filter)

Create a new event that will be called to load the users information

Parameters:

page - will be used to paginate the results

filter - the object containing the values that will be used to filter the query results

LoadUsersEvent

public LoadUsersEvent(Page page,
 BOUser filter,
 Order order)

Create a new event that will be called to load the users information

Parameters:

page - will be used to paginate the results

filter - the object containing the values that will be used to filter the query results

order - The Order object form which retrieve the custom sql order by clause.

LoadUsersEvent

public LoadUsersEvent(Page page,
 BOUser filter,
 Order order,
 Collection<Long> filterIds)

Create a new event that will be called to load the users information

Parameters:

page - will be used to paginate the results

filter - the object containing the values that will be used to filter the query results

order - The Order object form which retrieve the custom sql order by clause.

filterIds - The list of IDs to filter the users to load.

Method Details

getPage

public Page getPage()

Returns will be used to paginate the results

Returns:

will be used to paginate the results

getFilter

public BOUser getFilter()

Returns the object containing the values that will be used to filter the query results.

Returns:

the object containing the values that will be used to filter the query results.

getOrder

public Order getOrder()

Returns the object that handles the order filter fields.

Returns:

the object that handles the order filter fields.

getFilterIds

public Collection<Long> getFilterIds()

Returns the object that handles the ids filter field.
This filter field is used to specify one or more user's id to filter the results of the users load event.

Returns:

the object that handles the ids filter field.