Docs For Class HarmoniFunction

Description

Function is composed of Id, a displayName, a description, a category, and a QualifierType. Ids in Authorization are externally defined and their uniqueness is enforced by the implementation.

OSID Version: 2.0

version: $Id: HarmoniFunction.class.php,v 1.13 2007/09/13 16:04:18 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/authorization/HarmoniFunction.class.php (line 21)

FunctionInterface
   |
   --HarmoniFunction

Variable Summary

integer $_dbIndex

string $_description

object _functionType $_functionType

object _id $_id

object _qualifierHierarchyId $_qualifierHierarchyId

string $_referenceName

Method Summary

HarmoniFunction HarmoniFunction (ref $id, string $referenceName, string $description, ref $functionType, ref $qualifierHierarchyId, integer $dbIndex, string 6)

string getDescription ()

object Type getFunctionType ()

object Id getId ()

object Id getQualifierHierarchyId ()

string getReferenceName ()

void updateDescription (mixed $description, string $description )

void updateReferenceName (mixed $referenceName, string $referenceName )

Variables

integer $_dbIndex (line 70)

The index of the database connection as returned by the DBHandler.

var: _dbIndex
access: private

string $_description (line 46)

The description of this function.

var: _description
access: private

object _functionType $_functionType (line 54)

The type of this function.

access: private

object _id $_id (line 30)

The Unique ID of this function.

access: private

object _qualifierHierarchyId $_qualifierHierarchyId (line 62)

The ID of the qualifier hierarchy that is associated with this function.

access: private

string $_referenceName (line 38)

The display name of this function.

var: _referenceName
access: private

Methods

Constructor HarmoniFunction (line 91)

The constructor.

access: public

HarmoniFunction HarmoniFunction (ref $id, string $referenceName, string $description, ref $functionType, ref $qualifierHierarchyId, integer $dbIndex, string 6)

string 6: authzDB The name of the Authorization database.
ref $id: object id - is externally defined functionId - is externally defined.
string $referenceName: referenceName - is externally defined referenceName - the name to display for this Function
string $description: description - is externally defined description - the description of this Function
ref $functionType: object functionType - is externally defined functionType - the Type of this Function
ref $qualifierHierarchyId: object qualifierHierarchyId - is externally defined qualifierHierarchyId - the Id of the Qualifier Hierarchy associated with this Function
integer $dbIndex: dbIndex The index of the database connection as returned by the DBHandler.

getDescription (line 182)

Get the description for this Function.

access: public
throws: object AuthorizationException An exception with one of the following messages defined in org.osid.authorization.AuthorizationException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getDescription ()

Redefinition of:

FunctionInterface::getDescription(): Get the description for this Function.

getFunctionType (line 206)

Get the FunctionType for this Function.

access: public
throws: object AuthorizationException An exception with one of the following messages defined in org.osid.authorization.AuthorizationException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Type getFunctionType ()

Redefinition of:

FunctionInterface::getFunctionType(): Get the FunctionType for this Function.

getId (line 134)

Get the unique Id for this Function.

access: public
throws: object AuthorizationException An exception with one of the following messages defined in org.osid.authorization.AuthorizationException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Id getId ()

Redefinition of:

FunctionInterface::getId(): Get the unique Id for this Function.

getQualifierHierarchyId (line 230)

Get the QualifierHierarchyId for this Function.

access: public
throws: object AuthorizationException An exception with one of the following messages defined in org.osid.authorization.AuthorizationException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

object Id getQualifierHierarchyId ()

Redefinition of:

FunctionInterface::getQualifierHierarchyId(): Get the QualifierHierarchyId for this Function.

getReferenceName (line 158)

Get the permanent reference name for this Function.

access: public
throws: object AuthorizationException An exception with one of the following messages defined in org.osid.authorization.AuthorizationException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getReferenceName ()

Redefinition of:

FunctionInterface::getReferenceName(): Get the permanent reference name for this Function.

updateDescription (line 256)

Update the description for this Function.

access: public
throws: object AuthorizationException An exception with one of the following messages defined in org.osid.authorization.AuthorizationException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateDescription (mixed $description, string $description )

string $description

Redefinition of:

FunctionInterface::updateDescription(): Update the description for this Function.

updateReferenceName (line 311)

Update the reference name for this Function.

WARNING: NOT IN OSID

access: public
throws: object AuthorizationException An exception with one of the following messages defined in org.osid.authorization.AuthorizationException may be thrown: OPERATION_FAILED, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

void updateReferenceName (mixed $referenceName, string $referenceName )

string $referenceName

Inherited Methods

Inherited From FunctionInterface

FunctionInterface::getDescription()
FunctionInterface::getFunctionType()
FunctionInterface::getId()
FunctionInterface::getQualifierHierarchyId()
FunctionInterface::getReferenceName()
FunctionInterface::updateDescription()