Docs For Class Qualifier

Class Qualifier

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

Licensed under the org.osid.SidImplementationLicenseMIT.

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

Direct descendents

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

Method Summary

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 )

Methods

addParent (line 192)

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

Redefined in descendants as:

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

changeParent (line 252)

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

Redefined in descendants as:

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

getChildren (line 336)

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

Redefined in descendants as:

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

getDescription (line 89)

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

Redefined in descendants as:

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

getId (line 41)

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

Redefined in descendants as:

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

getParents (line 360)

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

Redefined in descendants as:

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

getQualifierType (line 137)

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

Redefined in descendants as:

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

getReferenceName (line 65)

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

Redefined in descendants as:

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

isChildOf (line 282)

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

Redefined in descendants as:

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

isDescendantOf (line 312)

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

Redefined in descendants as:

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

isParent (line 113)

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

Redefined in descendants as:

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

removeParent (line 222)

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

Redefined in descendants as:

HarmoniQualifier::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 163)

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

Redefined in descendants as:

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

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