Docs For Class Authorization

Class Authorization

Description

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

OSID Version: 2.0

Licensed under the org.osid.SidImplementationLicenseMIT.

Located in /harmoni/oki2/osid/authorization/Authorization.php (line 18)

Direct descendents

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

Method Summary

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, int $effectiveDate )

void updateExpirationDate (mixed $expirationDate, int $expirationDate )

Methods

getAgentId (line 184)

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

Redefined in descendants as:

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

getEffectiveDate (line 40)

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

Redefined in descendants as:

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

getExpirationDate (line 64)

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

Redefined in descendants as:

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

getFunction (line 136)

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

Redefined in descendants as:

HarmoniAuthorization::getFunction()

getModifiedBy (line 88)

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

Redefined in descendants as:

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

getModifiedDate (line 112)

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

Redefined in descendants as:

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

getQualifier (line 160)

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

Redefined in descendants as:

HarmoniAuthorization::getQualifier()

isActiveNow (line 208)

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

Redefined in descendants as:

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

isExplicit (line 234)

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

Redefined in descendants as:

HarmoniAuthorization::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 288)

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, int $effectiveDate )

int $effectiveDate

Redefined in descendants as:

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

updateExpirationDate (line 261)

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, int $expirationDate )

int $expirationDate

Redefined in descendants as:

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

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