NamespaceBean

Name NamespaceBean
Usage HandcarIdService
getNamespaces getNamespace
Type Complex

Description

A namespace in the OSID model.

A namesspace is used to qualify the actual identifier.

OSID reference: Id

Structure Definition

ShortName Name Type Description Required? Read only? Implementation Notes
displayName Display Name DisplayTextBean Get the name of the namespace to be displayed on the screen to a user. Required    
description Description DisplayTextBean The description of the namespace

The consumer might have to interrogate the format type to properly display the the description on the screen.
     
code Code String Code -- a unique identifier for this namespace Required    

JSON Structure

{
     "type" : "Namespace",
     "displayName" :  {
          "languageTypeId" : "id",
          "scriptTypeId" : "id",
          "formatTypeId" : "id",
          "text" : "XXXX"
          },
     "description" :  {
          "languageTypeId" : "id",
          "scriptTypeId" : "id",
          "formatTypeId" : "id",
          "text" : "XXXX"
          },
     "code" : "XXXX"
}