Package DE_EPAGES::Calendar::API::Object::Calendar
object interface for Calendar.
Base |
DE_EPAGES::Object::API::Object::Object |
Functions
- appointmentInterval
- businessMinutes
- className
- clone
- dayList
- dbPackage
- defaultDuration
- getRemainingQuantity
- isBusiness
- isBusy
- isLocked
- nextAppointmentNo
- removeBookingPeriods
- removeLockingPeriods
- setBookingPeriods
- setLock
appointmentInterval
Returns interval for appointments in minutes (uses BaseCalendar if AppointmentInterval isnt defined at this calendar).
Syntax |
$Interval = $Calendar->appointmentInterval; |
Return |
|
businessMinutes
get booking periods formated to minutes for the given day.
Syntax |
$aaMinutes = $Calendar->businessMinutes( $Date ); |
Input |
|
Return |
|
className
Returns the class name, used for DAL access.
Syntax |
$ClassName = $Calendar->className; |
Return |
|
clone
Inserts a new object into the database as copy from old object, dont clones appointments.
Syntax |
$Clone = $Object->clone( $hInfo ); $Clone = $Object->clone( $hInfo, $Recursive ); |
Input |
|
Return |
|
dayList
Returns day list for TLE function (AppointmentDayList).
Syntax |
$ahDayList = $Calendar->dayList( $Date ); |
Input |
|
Return |
|
dbPackage
Returns the database package, used for DAL access.
Syntax |
$DbPackage = $Calendar->dbPackage; |
Return |
|
defaultDuration
Return default duration.
Syntax |
$Calendar->defaultDuration; |
Return |
|
getRemainingQuantity
Returns remaining quantity of given period
Syntax |
$Calendar->isBusy($StartDate, $EndDate, $Requested, $Available); |
Input |
|
Return |
|
isBusiness
Returns true if on period of time is open for business (including locks).
Syntax |
$IsBusiness = $Calendar->isBusiness( $StartDate, $EndDate, $BusinessMinutes ); |
Input |
|
Return |
|
isBusy
Return default duration.
Syntax |
$Calendar->isBusy($StartDate, $EndDate, $Requested, $Available); |
Input |
|
Return |
|
isLocked
Returns true if on period of time is locked.
Syntax |
$IsLocked = $Calendar->isLocked( $StartDate, $EndDate ); |
Input |
|
Return |
|
nextAppointmentNo
Returns the next appointment alias.
Syntax |
$AppointmentNo = $Calendar->nextAppointmentNo; |
Return |
|
removeBookingPeriods
Removes all booking periods of this calendar (to use base calendar).
Syntax |
$Calendar->removeBookingPeriods; |
removeLockingPeriods
Removes all locking periods of this calendar (to use booking periods).
Syntax |
$Calendar->removeLockingPeriods; |
setBookingPeriods
set booking periods for each day.
Syntax |
$Calendar->setBookingPeriods( $ahData ); |
Input |
|
setLock
Add a lock period to the calendar, the existing periods could be change if there are some overlaps.
Syntax |
$Calendar->setLock( $hLockPeriod ); |
Input |
|