TypeBean

Name TypeBean
Usage HandcarAuthorizationService HandcarHierarchyService HandcarLearningService HandcarLoggingService HandcarRelationshipService
getVaultGenusTypes getFunctionGenusTypes getQualifierGenusTypes getAuthorizationGenusTypes getHierarchyGenusTypes getTypeById getObjectiveBankGenusTypes getTypes getTypeById getObjectiveGenusTypes getAllowedChildObjectiveGenusTypes getObjectiveRelationshipGenusTypes getActivityGenusTypes getAssetGenusTypes getAssetContentGenusTypes getAssetContentAccessibilityTypes getDisplayTextLanguageTypes getDefaultDisplayTextLanguageTypes getDisplayTextScriptTypes getDefaultDisplayTextScriptTypes getDisplayTextFormatTypes getDefaultDisplayTextFormatTypes getProficiencyGenusTypes getLogGenusTypes getLogEntryGenusTypes getLogEntryPriorityTypes getFamilyGenusTypes getRelationshipGenusTypes
Type Complex

Description

A type in the OSID model.

A type is simply a way to configure the system constraining the system in particular ways. There are many different
kinds of types including: Objective relationship types (RELATED, ???) Display Text types Format types (PLAIN, HTML,
RTF, LATEX, etc) Language types (ENGLISH, FRENCH, etc.) Script types (LATIN, CYRILLIC, etc.) Objective Types (TOPIC,
OUTCOME)

OSID reference: Type Manager Package
also Type

Structure Definition

ShortName Name Type Description Required? Read only? Implementation Notes
id Id String Unique identifier for this type.

Note: in the OSID a type does not have an Id but we construct one for handcar so we can point to a type using a
String representation.

The id is expected to be unique for the type and should be treated as if the id is opaque. Opaque means that no
consumer should interrogate the structure of the string but should just manipulate it as a whole.

Having said that, for DEBUGGING purposes, the ids have a structure as follows: authority:identifier@namespace

OSID reference: Id		 Required Read only on updates  
displayName Display Name DisplayTextBean Get the name of the type to be displayed on the screen to a user.

OSID reference: Type		 Required    
description Description DisplayTextBean The description of the type

The consumer might have to interrogate the format type to properly display the the description on the screen.

OSID reference: Type		      
displayLabel Display Label DisplayTextBean The label used to prefix the type when presenting it to a user

The consumer might have to interrogate the format type to properly display the the description on the screen.

OSID reference: Type		      
domain Domain DisplayTextBean The domain of the type

TODO: Task #62 find out what really should go into the domain of a type, I am never quite sure.

OSID reference: Type		      
authority Authority String The authority of the type.

This is the organization or agent under who's authority the identifier is constructed.

For example: The authority for domain names is ICANN.


OSID reference: Type		      
identifierNamespace Identifier Namespace String The namespace of the identifier for this type

This qualifies the actual identifier to help make it unique.

For example: The namespace of an email address would the domain name (i.e. "mit.edu" for an email of
nwright@mit.edu)

OSID reference: Type		      
identifier Identifier String The identifier itself for this type

To be fully unique the identifier is qualified by a namespace and authority.

OSID reference: Type		      
sortKey Sort Key String Sort key that can be used to sort this object when in a list.

This value is NOT persisted but is calculated based on the query that was used to fetch the objects.

For example the larger the value the more relevant the keyword search applies to this object.		      
extensionRecord Extension Record ExtensionRecordBean Extension Record for this object if the method requested that the extension record be
included.		      

JSON Structure

{
     "type" : "Type",
     "id" : "id",
     "displayName" :  {
          "languageTypeId" : "id",
          "scriptTypeId" : "id",
          "formatTypeId" : "id",
          "text" : "XXXX"
          },
     "description" :  {
          "languageTypeId" : "id",
          "scriptTypeId" : "id",
          "formatTypeId" : "id",
          "text" : "XXXX"
          },
     "displayLabel" :  {
          "languageTypeId" : "id",
          "scriptTypeId" : "id",
          "formatTypeId" : "id",
          "text" : "XXXX"
          },
     "domain" :  {
          "languageTypeId" : "id",
          "scriptTypeId" : "id",
          "formatTypeId" : "id",
          "text" : "XXXX"
          },
     "authority" : "XXXX",
     "identifierNamespace" : "XXXX",
     "identifier" : "XXXX",
     "sortKey" : "XXXX",
     "extensionRecord" :  {
          "recordTypeIds" : ["id", ...],
          "recordProperties" : [ {
               "displayName" :  {
                    "languageTypeId" : "id",
                    "scriptTypeId" : "id",
                    "formatTypeId" : "id",
                    "text" : "XXXX"
                    },
               "description" :  {
                    "languageTypeId" : "id",
                    "scriptTypeId" : "id",
                    "formatTypeId" : "id",
                    "text" : "XXXX"
                    },
               "recordTypeId" : "id",
               "value" : "XXXX",
               "displayLabel" :  {
                    "languageTypeId" : "id",
                    "scriptTypeId" : "id",
                    "formatTypeId" : "id",
                    "text" : "XXXX"
                    },
               "associatedId" : "id"
               },
               ...],
          "associatedId" : "id"
          }
}