Class: KuoteObjects_LearningOfferTaken

Source Location: /classes/KuoteObjects/LearningOfferTaken.php

Class KuoteObjects_LearningOfferTaken

Class Overview

Implements interfaces:

KuoteObjects LearningOfferTaken

The KuoteObjects LearningOfferTaken represents a learning offering that a student has taken. It must implement the interfaces KuoteInterfaces_Object, and KuoteInterfaces_LearningOffering.

Located in /classes/KuoteObjects/LearningOfferTaken.php [line 20]

Author(s):

Kyle Hall

Information Tags:

Copyright:

2006

Methods

[ Top ]

Method Summary

KuoteObjects_LearningOfferTaken	__construct()	Constructor instantiates $enrollment as a DataObjects_LearningOfferTaken object.
boolean	delete()	Removes the object from the datastore based on it's Id
boolean	get()	Loads the object from the data store by its unique identifier.
integer	getEnrollmentId()	Returns the Id of the Enrollment of this Learning Offering Taken.
integer	getId()	Returns the unique id of the object
integer	getLearningOfferingId()	Returns the Id of the Learning Offering of this Learning Offering Taken.
integer	getTime()	Returns the timestamp of when this LearningOfferTaken was created.
boolean	initialize()	Creates a new LearningOfferTaken in the datastore based on the given Learning Offering Id and Enrollment Id.
boolean	insert()	Takes the currently set properties of the object and inserts them into the data store as a new instance with its own unique id.
boolean	setEnrollmentId()	Sets the Id of the Enrollment of this Learning Offering Taken.
boolean	setLearningOfferingId()	Sets the Id of the Learning Offering of this Learning Offering Taken.
boolean	update()	Updates the datastore to reflect the currently set properties of the object.

[ Top ]

Methods

Constructor __construct [line 32]

KuoteObjects_LearningOfferTaken __construct(
)

Constructor instantiates $enrollment as a DataObjects_LearningOfferTaken object.

API Tags:

Access:

public

Information Tags:

Link:

http://pear.php.net/package/DB_DataObject/

[ Top ]

delete [line 71]

boolean delete(
)

Removes the object from the datastore based on it's Id

API Tags:

Return:	True on success, false otherwise.
Access:	public

[ Top ]

get [line 42]

boolean get(
integer
$id 
)

Loads the object from the data store by its unique identifier.

Parameters:

integer

$id:

Unique identifier of a course in the data store.

API Tags:

Return:	True on success, false otherwise.
Access:	public

[ Top ]

getEnrollmentId [line 132]

integer getEnrollmentId(
)

Returns the Id of the Enrollment of this Learning Offering Taken.

API Tags:

Return:	Learning Id.
Access:	public

[ Top ]

getId [line 80]

integer getId(
)

Returns the unique id of the object

API Tags:

Return:	The objects's unique id
Access:	public

[ Top ]

getLearningOfferingId [line 113]

integer getLearningOfferingId(
)

Returns the Id of the Learning Offering of this Learning Offering Taken.

API Tags:

Return:	Learning Id.
Access:	public

[ Top ]

getTime [line 104]

integer getTime(
)

Returns the timestamp of when this LearningOfferTaken was created.

API Tags:

Return:	The time of creation.
Access:	public

[ Top ]

initialize [line 92]

boolean initialize(
KuoteObjects_LearningOffering
$learningOffering, 
$enrollment, KuoteObjects_Enrollment
$enrollmentId 
)

Creates a new LearningOfferTaken in the datastore based on the given Learning Offering Id and Enrollment Id.

Parameters:

KuoteObjects_LearningOffering	$learningOffering:	The LearningOffering being taken.
KuoteObjects_Enrollment	$enrollmentId:	The Enrollment in this course offering.
	$enrollment:

API Tags:

Return:	True if created successfully, false otherwise.
Access:	public

[ Top ]

insert [line 52]

boolean insert(
)

Takes the currently set properties of the object and inserts them into the data store as a new instance with its own unique id.

API Tags:

Return:	True on success, false otherwise.
Access:	public

[ Top ]

setEnrollmentId [line 142]

boolean setEnrollmentId(
integer
$id 
)

Sets the Id of the Enrollment of this Learning Offering Taken.

Parameters:

integer

$id:

The id of the Enrollment of this Learning Offering Taken.

API Tags:

Return:	True on success, false otherwise.
Access:	public

[ Top ]

setLearningOfferingId [line 123]

boolean setLearningOfferingId(
integer
$id 
)

Sets the Id of the Learning Offering of this Learning Offering Taken.

Parameters:

integer

$id:

The id of the Learning Offering of this Learning Offering Taken.

API Tags:

Return:	True on success, false otherwise.
Access:	public

[ Top ]

update [line 62]

boolean update(
)

Updates the datastore to reflect the currently set properties of the object.

Updates by the current Id.

API Tags:

Return:	True on success, false otherwise.
Access:	public

[ Top ]

Documentation generated on Fri, 15 Dec 2006 11:18:12 -0500 by phpDocumentor 1.3.0

	KuoteObjects LearningOfferTaken

[ class tree: KuoteObjects ] [ index: KuoteObjects ] [ all elements ]