Docs For Class HarmoniAuthorization

Class HarmoniAuthorization

Description

Authorization indicates what an agentId can do a Function in a Qualifier context.

OSID Version: 2.0

version: $Id: HarmoniAuthorization.class.php,v 1.18 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/HarmoniAuthorization.class.php (line 21)

Authorization
   |
   --HarmoniAuthorization

Variable Summary

object _agentId $_agentId

object _cache $_cache

object _effectiveDate $_effectiveDate

object _expirationDate $_expirationDate

boolean $_explicit

object _functionId $_functionId

string $_id

object _qualifierId $_qualifierId

Method Summary

HarmoniAuthorization HarmoniAuthorization (object id $id, ref $agentId, ref $functionId, ref $qualifierId, integer $explicit, integer $cache, [boolean $effectiveDate = NULL], [mixed $expirationDate = NULL])

object Id getAgentId ()

int getEffectiveDate ()

int getExpirationDate ()

object Function getFunction ()

object Id getModifiedBy ()

int getModifiedDate ()

object Qualifier getQualifier ()

boolean isActiveNow ()

boolean isExplicit ()

void updateEffectiveDate (mixed $effectiveDate, object DateAndTime $effectiveDate )

void updateExpirationDate (mixed $expirationDate, object DateAndTime $expirationDate )

Variables

object _agentId $_agentId (line 46)

The Id of the agent.

access: private

object _cache $_cache (line 86)

The AuthorizationCache object.

access: private

object _effectiveDate $_effectiveDate (line 30)

The date when this Authorization starts being effective.

access: private

object _expirationDate $_expirationDate (line 70)

The date when the authorization expires.

access: private

boolean $_explicit (line 78)

Specifies whether this Authorization is explicit or not.

var: _explicit
access: private

object _functionId $_functionId (line 54)

The Id of the function.

access: private

string $_id (line 38)

The Id of this Authorization (string).

var: _id
access: protected

object _qualifierId $_qualifierId (line 62)

The Id of the qualifier.

access: private

Methods

Constructor HarmoniAuthorization (line 100)

The constructor.

access: public

object id $id: The id of this Authorization
ref $agentId: object agentId The Id of the agent.
ref $functionId: object functionId The Id of the function.
ref $qualifierId: object qualifierId The Id of the qualifier.
integer $explicit: effectiveDate The date when the authorization becomes effective.
integer $cache: expirationDate The date when the authorization expires.
boolean $effectiveDate: explicit Specifies whether this Authorization is explicit or not.

getAgentId (line 302)

Get the agentid associated with this Authorization.

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

Redefinition of:

Authorization::getAgentId(): Get the agentid associated with this Authorization.

getEffectiveDate (line 153)

Get the date when this Authorization starts being effective.

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

int getEffectiveDate ()

Redefinition of:

Authorization::getEffectiveDate(): Get the date when this Authorization starts being effective.

getExpirationDate (line 177)

Get the date when this Authorization stops being effective.

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

int getExpirationDate ()

Redefinition of:

Authorization::getExpirationDate(): Get the date when this Authorization stops being effective.

getFunction (line 249)

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

Redefinition of:

Authorization::getFunction()

getModifiedBy (line 201)

Get the Id of the agent that modified this Authorization.

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

Redefinition of:

Authorization::getModifiedBy(): Get the Id of the agent that modified this Authorization.

getModifiedDate (line 225)

Get the date when this Authorization was modified.

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

int getModifiedDate ()

Redefinition of:

Authorization::getModifiedDate(): Get the date when this Authorization was modified.

getQualifier (line 276)

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

Redefinition of:

Authorization::getQualifier()

isActiveNow (line 326)

Return true if this Authorization is effective; false otherise;

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

Redefinition of:

Authorization::isActiveNow(): Return true if this Authorization is effective; false otherise;

isExplicit (line 363)

Some Authorizations are explicitly stored and others are implied, so use this method to determine if the Authorization is explicit and can be modified or deleted.

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

Redefinition of:

Authorization::isExplicit(): Some Authorizations are explicitly stored and others are implied, so use this method to determine if the Authorization is explicit and can be modified or deleted.

updateEffectiveDate (line 457)

the date when this Authorization stops being effective.

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

void updateEffectiveDate (mixed $effectiveDate, object DateAndTime $effectiveDate )

object DateAndTime $effectiveDate

Redefinition of:

Authorization::updateEffectiveDate(): the date when this Authorization stops being effective.

updateExpirationDate (line 390)

Modify the date when this Authorization starts being effective.

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

void updateExpirationDate (mixed $expirationDate, object DateAndTime $expirationDate )

object DateAndTime $expirationDate

Redefinition of:

Authorization::updateExpirationDate(): Modify the date when this Authorization starts being effective.

Inherited Methods

Inherited From Authorization

Authorization::getAgentId()
Authorization::getEffectiveDate()
Authorization::getExpirationDate()
Authorization::getFunction()
Authorization::getModifiedBy()
Authorization::getModifiedDate()
Authorization::getQualifier()
Authorization::isActiveNow()
Authorization::isExplicit()
Authorization::updateEffectiveDate()
Authorization::updateExpirationDate()

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