Docs For Class HarmoniQualifier

Class HarmoniQualifier

Description

Qualifier is the context in which an Authorization is valid and consists of an Id, a description and a QualifierType. Ids in Authorization are externally defined and their uniqueness is enforced by the implementation.

OSID Version: 2.0

version: $Id: HarmoniQualifier.class.php,v 1.12 2007/09/04 20:25:38 adamfranco Exp $
license: GNU General Public License (GPL)
copyright: Copyright © 2005, Middlebury College

Located in /harmoni/core/oki2/authorization/HarmoniQualifier.class.php (line 25)

Qualifier
   |
   --HarmoniQualifier

Variable Summary

object _cache $_cache

object _node $_node

Method Summary

HarmoniQualifier HarmoniQualifier (ref $node, ref $cache)

void addParent (mixed $parentQualifierId, object Id $parentQualifierId )

void changeParent (object Id $oldParentId, mixed $newParentId, object Id $newParentId )

object QualifierIterator getChildren ()

string getDescription ()

object Id getId ()

object QualifierIterator getParents ()

object Type getQualifierType ()

string getReferenceName ()

boolean isChildOf (mixed $parentId, object Id $parentId )

boolean isDescendantOf (mixed $ancestorId, object Id $ancestorId )

boolean isParent ()

void removeParent (mixed $parentQualifierId, object Id $parentQualifierId )

void updateDescription (mixed $description, string $description )

void updateReferenceName (mixed $referenceName, string $referenceName )

Variables

object _cache $_cache (line 42)

The AuthorizationCache object.

access: private

object _node $_node (line 34)

The associated hierarchy node object.

access: private

Methods

Constructor HarmoniQualifier (line 51)

The constructor.

access: public

HarmoniQualifier HarmoniQualifier (ref $node, ref $cache)

ref $node: object node The associated hierarchy node object.
ref $cache: object cache The AuthorizationCache object.

addParent (line 262)

Adds a parent to this Qualifier supported by the Authorization implementation.

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, UNKNOWN_ID

void addParent (mixed $parentQualifierId, object Id $parentQualifierId )

object Id $parentQualifierId

Redefinition of:

Qualifier::addParent(): Adds a parent to this Qualifier supported by the Authorization implementation.

changeParent (line 322)

Changes the parent of this Qualifier by adding a new parent and removing the old parent.

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, UNKNOWN_ID

void changeParent (object Id $oldParentId, mixed $newParentId, object Id $newParentId )

object Id $oldParentId
object Id $newParentId

Redefinition of:

Qualifier::changeParent(): Changes the parent of this Qualifier by adding a new parent and removing the old parent.

getChildren (line 439)

Gets the children of this Qualifier.

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

Redefinition of:

Qualifier::getChildren(): Gets the children of this Qualifier.

getDescription (line 131)

Get the description for this Qualifier.

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:

Qualifier::getDescription(): Get the description for this Qualifier.

getId (line 82)

Get the unique Id for this Qualifier.

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:

Qualifier::getId(): Get the unique Id for this Qualifier.

getParents (line 484)

Gets the parents of this Qualifier.

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

Redefinition of:

Qualifier::getParents(): Gets the parents of this Qualifier.

getQualifierType (line 179)

Get the QualifierType for this Qualifier.

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

Redefinition of:

Qualifier::getQualifierType(): Get the QualifierType for this Qualifier.

getReferenceName (line 107)

Get the permanent reference name for this Qualifier.

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:

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

isChildOf (line 352)

Determines if this Qualifier is the child a given parent

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, UNKNOWN_ID

boolean isChildOf (mixed $parentId, object Id $parentId )

object Id $parentId

Redefinition of:

Qualifier::isChildOf(): Determines if this Qualifier is the child a given parent

isDescendantOf (line 398)

Determines if this Qualifier is a descendant of the given qualifierId.

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, UNKNOWN_ID

boolean isDescendantOf (mixed $ancestorId, object Id $ancestorId )

object Id $ancestorId

Redefinition of:

Qualifier::isDescendantOf(): Determines if this Qualifier is a descendant of the given qualifierId.

isParent (line 155)

Return true if this Qualifier has any children; false otherwise

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

boolean isParent ()

Redefinition of:

Qualifier::isParent(): Return true if this Qualifier has any children; false otherwise

removeParent (line 292)

Removes a parent from this Qualifier. If this is the last parent the delete will fail and an AuthorizationException will be thrown. For a non-Root Qualifier there must always be a parent.

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, UNKNOWN_ID

void removeParent (mixed $parentQualifierId, object Id $parentQualifierId )

object Id $parentQualifierId

Redefinition of:

Qualifier::removeParent(): Removes a parent from this Qualifier. If this is the last parent the delete will fail and an AuthorizationException will be thrown. For a non-Root Qualifier there must always be a parent.

updateDescription (line 233)

Update the description for this Qualifier.

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:

Qualifier::updateDescription(): Update the description for this Qualifier.

updateReferenceName (line 207)

Update the reference name for this Qualifier.

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 Qualifier

Qualifier::addParent()
Qualifier::changeParent()
Qualifier::getChildren()
Qualifier::getDescription()
Qualifier::getId()
Qualifier::getParents()
Qualifier::getQualifierType()
Qualifier::getReferenceName()
Qualifier::isChildOf()
Qualifier::isDescendantOf()
Qualifier::isParent()
Qualifier::removeParent()
Qualifier::updateDescription()

Documentation generated on Wed, 19 Sep 2007 10:24:11 -0400 by phpDocumentor 1.3.0RC3