Docs For Class Id

Class Id

Description

Id represents a unique identifier. A String representation of the unique

identifier is available with getIdString(). To convert from a String representation of the identifier to the identifier object, org.osid.shared.Id, use getId(String). Id can determine if it is equal to another Id.

<p> OSID Version: 2.0 </p>

<p> Licensed under the org.osid.SidImplementationLicenseMIT. </p>

Located in /harmoni/oki2/osid/shared/Id.php (line 21)

Direct descendents

Class	Description
HarmoniId	Id represents a unique identifier. A String representation of the unique
HarmoniStringId	An Id class that allows for the passing of an arbitrary string as an Id object.

Method Summary

string getIdString ()

boolean isEqual (mixed $id, object Id $id )

Methods

getIdString (line 40)

Return the String representation of this unique Id.

access: public
throws: object SharedException An exception with one of the following messages defined in org.osid.shared.SharedException may be thrown: UNKNOWN_TYPE, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED

string getIdString ()

Redefined in descendants as:

HarmoniId::getIdString() : Return the String representation of this unique Id.
HarmoniStringId::getIdString()

isEqual (line 65)

Tests if an unique Id equals this unique Id.

access: public
throws: object SharedException An exception with one of the following messages defined in org.osid.shared.SharedException may be thrown: UNKNOWN_TYPE, PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT

boolean isEqual (mixed $id, object Id $id )

object Id $id

Redefined in descendants as:

HarmoniId::isEqual() : Tests if an unique Id equals this unique Id.
HarmoniStringId::isEqual()

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