Package passport.domain.contexts.events

Class AvailableEventsListing

java.lang.Object

passport.domain.contexts.events.AvailableEventsListing

All Implemented Interfaces:

Context

public class AvailableEventsListing
extends Object
implements Context

Context for listing available events starting from today.

Constructor Summary

Constructors

Constructor	Description
AvailableEventsListing(Events events)	Constructor with the specified events repository.

Method Summary

Modifier and Type	Method	Description
List<Event>	availables()	Retrieves the list of available events starting from the set date.
AvailableEventsListing	beingToday(LocalDate today)	Sets the current date for the context.
AvailableEventsListing	including(String sample)	Sets the filter by exact name.
AvailableEventsListing	intoInterval(LocalDate startDate, LocalDate endDate)	Sets the filter by date range.
AvailableEventsListing	sortedByDate()	Sets the sorter by date.
AvailableEventsListing	sortedByTitle()	Sets the sorter by name.
AvailableEventsListing	withCategory(EventCategory category)	Sets the filter by category.
AvailableEventsListing	withDate(LocalDate date)	Sets the filter by date.

Methods inherited from class java.lang.Object

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

Constructor Details

AvailableEventsListing

public AvailableEventsListing(Events events)

Constructor with the specified events repository.

Parameters:

events - the repository of events used for listing

Method Details

beingToday

public AvailableEventsListing beingToday(LocalDate today)

Sets the current date for the context.

Parameters:

today - the current date

Returns:

the updated AvailableEventsListing object

including

public AvailableEventsListing including(String sample)

Sets the filter by exact name.

Parameters:

sample - the name to filter by

Returns:

the updated AvailableEventsListing object

withCategory

public AvailableEventsListing withCategory(EventCategory category)

Sets the filter by category.

Parameters:

category - the category to filter by

Returns:

the updated AvailableEventsListing object

withDate

public AvailableEventsListing withDate(LocalDate date)

Sets the filter by date.

Parameters:

date - the date to filter by

Returns:

the updated AvailableEventsListing object

intoInterval

public AvailableEventsListing intoInterval(LocalDate startDate,
 LocalDate endDate)

Sets the filter by date range.

Parameters:

startDate - the start date of the range

endDate - the end date of the range

Returns:

the updated AvailableEventsListing object

sortedByTitle

public AvailableEventsListing sortedByTitle()

Sets the sorter by name.

Returns:

the updated AvailableEventsListing object

sortedByDate

public AvailableEventsListing sortedByDate()

Sets the sorter by date.

Returns:

the updated AvailableEventsListing object

availables

public List<Event> availables()

Retrieves the list of available events starting from the set date.

Returns:

a list of available events

Throws:

NullPointerException - if the current date or events repository is not set