Docs For Class HarmoniId

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>

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

Located in /harmoni/core/oki2/shared/HarmoniId.class.php (line 23)

Id
   |
   --HarmoniId

Variable Summary

string $_id

Method Summary

HarmoniId HarmoniId (string $id)

string getIdString ()

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

string printableString ()

string __toString ()

Variables

string $_id (line 30)

var: The id of this id.

Methods

Constructor HarmoniId (line 37)

Constructor. Creates a HarmoniId with id = $id or a new unique id if $id is NULL.

HarmoniId HarmoniId (string $id)

string $id: The desired id. If NULL, a new unique id is used.

getIdString (line 69)

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

Redefinition of:

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

isEqual (line 118)

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

Redefinition of:

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

printableString (line 93)

Answer a String whose characters are a description of the receiver.

Override this method as needed to provide a better representation

since: 7/11/05
access: public

string printableString ()

__toString (line 81)

Answer the string version of this id. Enables transparent Id to string translation.

access: public
since: 8/22/07

string __toString ()

Inherited Methods

Inherited From Id

Id::getIdString()
Id::isEqual()