SpecialEvent Class Reference
[Scheduler]

Basic class describing a specialEvent. More...

List of all members.

Public Member Functions
	getDescription ($locale)
	getEndTime ()
	getName ($locale)
	getSchedConfId ()
	getSpecialEventDescription ()
	getSpecialEventId ()
	getSpecialEventName ()
	getStartTime ()
	setDescription ($description, $locale)
	setEndTime ($endTime)
	setName ($name, $locale)
	setSchedConfId ($schedConfId)
	setSpecialEventId ($specialEventId)
	setStartTime ($startTime)

---

Detailed Description

Basic class describing a specialEvent.

See also:

SpecialEvent

Definition at line 22 of file SpecialEvent.inc.php.

---

Member Function Documentation

SpecialEvent.getDescription

(

$

locale

)

Get the description of the special event.

Parameters:

$locale

string

Returns:

string

Definition at line 132 of file SpecialEvent.inc.php.

SpecialEvent.getEndTime

(

)

Get the special event end time.

Returns:

date

Definition at line 81 of file SpecialEvent.inc.php.

SpecialEvent.getName

(

$

locale

)

Get the name of the specialEvent.

Parameters:

$locale

string

Returns:

string

Definition at line 106 of file SpecialEvent.inc.php.

SpecialEvent.getSchedConfId

(

)

Get the sched conf ID of the specialEvent.

Returns:

int

Definition at line 49 of file SpecialEvent.inc.php.

SpecialEvent.getSpecialEventDescription

(

)

Get the localized description of the specialEvent.

Returns:

string

Definition at line 123 of file SpecialEvent.inc.php.

SpecialEvent.getSpecialEventId

(

)

Get the ID of the specialEvent.

Returns:

int

Definition at line 31 of file SpecialEvent.inc.php.

SpecialEvent.getSpecialEventName

(

)

Get the localized name of the specialEvent.

Returns:

string

Definition at line 97 of file SpecialEvent.inc.php.

SpecialEvent.getStartTime

(

)

Get the presentation start time.

Returns:

date

Definition at line 65 of file SpecialEvent.inc.php.

SpecialEvent.setDescription	(	$	description,
		$	locale
	)

Set the description of the special event.

Parameters:

	$description	string
	$locale	string

Definition at line 141 of file SpecialEvent.inc.php.

SpecialEvent.setEndTime

(

$

endTime

)

Get the special event end time.

Parameters:

$endTime

date

Definition at line 89 of file SpecialEvent.inc.php.

SpecialEvent.setName	(	$	name,
		$	locale
	)

Set the name of the specialEvent.

Parameters:

	$name	string
	$locale	string

Definition at line 115 of file SpecialEvent.inc.php.

SpecialEvent.setSchedConfId

(

$

schedConfId

)

Set the sched conf ID of the specialEvent.

Parameters:

$schedConfId

int

Definition at line 57 of file SpecialEvent.inc.php.

SpecialEvent.setSpecialEventId

(

$

specialEventId

)

Set the ID of the specialEvent.

Parameters:

$specialEventId

int

Definition at line 40 of file SpecialEvent.inc.php.

SpecialEvent.setStartTime

(

$

startTime

)

Set the presentation start time.

Parameters:

$startTime

date

Definition at line 73 of file SpecialEvent.inc.php.

---

The documentation for this class was generated from the following file:

• classes/scheduler/SpecialEvent.inc.php

---