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

Class UsersLoadEvent

java.lang.Object
overit.geocall.bl.GenericEvent<PageResponse<BOUser>>
overit.geocall.bl.BusinessEvent<PageResponse<BOUser>>
overit.geocall.basic.bl.user.event.UsersLoadEvent
@Deprecated(since="13.0", forRemoval=true) public class UsersLoadEvent extends BusinessEvent<PageResponse<BOUser>>
Deprecated, for removal: This API element is subject to removal in a future version.
Event that will be called to load the users information.
GCApi:
event
Reactors:
BTUsersLoad(0)
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
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected Collection<Long>
    filterIds
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected Order
    order
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected Page
    page
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Fields inherited from class overit.geocall.bl.GenericEvent

    executorService, journal, streamJournal

  • Constructor Summary

    Constructors
    Constructor
    Description
    UsersLoadEvent(Page page, BOUser filter)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new event that will be called to load the users information
    UsersLoadEvent(Page page, BOUser filter, Order order)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new event that will be called to load the users information
    UsersLoadEvent(Page page, BOUser filter, Order order, Collection<Long> filterIds)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Create a new event that will be called to load the users information

  • Method Summary

    Modifier and Type
    Method
    Description
    BOUser
    getFilter()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the object containing the values that will be used to filter the query results.
    Collection<Long>
    getFilterIds()
    Deprecated, for removal: This API element is subject to removal in a future version.
    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()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the object that handles the order filter fields.
    Page
    getPage()
    Deprecated, for removal: This API element is subject to removal in a future version.
    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
      Deprecated, for removal: This API element is subject to removal in a future version.

    • page

      protected Page page
      Deprecated, for removal: This API element is subject to removal in a future version.

    • order

      protected Order order
      Deprecated, for removal: This API element is subject to removal in a future version.

    • filterIds

      protected Collection<Long> filterIds
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • UsersLoadEvent

      public UsersLoadEvent(Page page, BOUser filter)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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

    • UsersLoadEvent

      public UsersLoadEvent(Page page, BOUser filter, Order order)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

    • UsersLoadEvent

      public UsersLoadEvent(Page page, BOUser filter, Order order, Collection<Long> filterIds)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns will be used to paginate the results
      Returns:
      will be used to paginate the results

    • getFilter

      public BOUser getFilter()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the object that handles the order filter fields.
      Returns:
      the object that handles the order filter fields.

    • getFilterIds

      public Collection<Long> getFilterIds()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.