Docs For Class FunctionInterface

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

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/oki2/osid/authorization/Function.php (line 19)

Direct descendents

Class	Description
HarmoniFunction	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.

Method Summary

string getDescription ()

object Type getFunctionType ()

object Id getId ()

object Id getQualifierHierarchyId ()

string getReferenceName ()

void updateDescription (mixed $description, string $description )

Methods

getDescription (line 89)

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 ()

Redefined in descendants as:

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

getFunctionType (line 113)

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 ()

Redefined in descendants as:

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

getId (line 41)

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 ()

Redefined in descendants as:

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

getQualifierHierarchyId (line 137)

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 ()

Redefined in descendants as:

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

getReferenceName (line 65)

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 ()

Redefined in descendants as:

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

updateDescription (line 163)

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

Redefined in descendants as:

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