Interface: KuoteInterfaces_LearningOfferTaken

Source Location: /classes/KuoteInterfaces/LearningOfferTaken.php

Interface KuoteInterfaces_LearningOfferTaken

Interface Overview

KuoteInterfaces_LearningOfferTaken This intefaces defines the set of methods that all LearningOfferTaken implementations need to function as part of the Kuote System.

Located in /classes/KuoteInterfaces/LearningOfferTaken.php [line 18]

Author(s):

Kyle Hall

Information Tags:

Copyright:

2006

Methods

[ Top ]

Method Summary

integer	getEnrollmentId()	Returns the Id of the Enrollment of this Learning Offering Taken.
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	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.

[ Top ]

Methods

getEnrollmentId [line 56]

integer getEnrollmentId(
)

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

API Tags:

Return:	Learning Id.
Access:	public

[ Top ]

getLearningOfferingId [line 41]

integer getLearningOfferingId(
)

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

API Tags:

Return:	Learning Id.
Access:	public

[ Top ]

getTime [line 34]

integer getTime(
)

Returns the timestamp of when this LearningOfferTaken was created.

API Tags:

Return:	The time of creation.
Access:	public

[ Top ]

initialize [line 27]

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 ]

setEnrollmentId [line 64]

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 49]

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 ]

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

	KuoteInterfaces Object

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