businex v0.2.0 Businex.Calendar
Businex.Calendar provides the main interface into the business days functionality.
Link to this section Summary
Functions
Adds a given number of business days to a given date
Check if a given date falls on a business day, as defined by the set calendar
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Get the next available business day, as defined by the set calendar
Get the previous business day, as defined by the set calendar
Provides a way to set the calendar data. This is currently set by default to :bacs by start_link. There is only one calendar type at the minute (:bacs)
Subtracts a given number of business days from a given date
Link to this section Functions
Adds a given number of business days to a given date.
Examples
iex> date = Timex.parse!("2018-02-01", "{YYYY}-{0M}-{D}")
iex> Businex.Calendar.add_business_days(date, 2)
~N[2018-02-05 00:00:00]
Check if a given date falls on a business day, as defined by the set calendar.
Examples
iex> date = Timex.parse!("2018-02-01", "{YYYY}-{0M}-{D}")
iex> Businex.Calendar.business_day?(date)
true
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
args
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
except handle_info(:timeout, state)
will be called after timeout
milliseconds if no messages are received within the timeout.
Returning {:ok, state, :hibernate}
is similar to
{:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning :ignore
will cause start_link/3
to return :ignore
and the
process will exit normally without entering the loop or calling c:terminate/2
.
If used when part of a supervision tree the parent supervisor will not fail
to start nor immediately try to restart the GenServer
. The remainder of the
supervision tree will be (re)started and so the GenServer
should not be
required by other processes. It can be started later with
Supervisor.restart_child/2
as the child specification is saved in the parent
supervisor. The main use cases for this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.
Get the next available business day, as defined by the set calendar.
Examples
iex> date = Timex.parse!("2018-02-01", "{YYYY}-{0M}-{D}")
iex> Businex.Calendar.next_business_day(date)
~N[2018-02-02 00:00:00]
Get the previous business day, as defined by the set calendar.
Examples
iex> date = Timex.parse!("2018-02-01", "{YYYY}-{0M}-{D}")
iex> Businex.Calendar.previous_business_day(date)
~N[2018-01-31 00:00:00]
Provides a way to set the calendar data. This is currently set by default to :bacs by start_link. There is only one calendar type at the minute (:bacs).
Examples
iex> Businex.Calendar.set_calendar(:bacs)
:ok
Subtracts a given number of business days from a given date.
Examples
iex> date = Timex.parse!("2018-02-01", "{YYYY}-{0M}-{D}")
iex> Businex.Calendar.subtract_business_days(date, 4)
~N[2018-01-26 00:00:00]