OSID Logo
OSID Specifications
type package
Version 3.0.0
Release Candidate Preview
Interfaceosid.type.Type
Implementsosid.OsidPrimitive
Description

The Type is a form of identifier that is primarily used to identify interface specifications. The Type differs from Id in that it offers display information and Types may be arranged in hierarchies to indicate an extended interface. Semantically, an Id identifies any OSID object while the Type identifies a specification.

The components of the Type that make up its identification are:

  • identifier: a unique key or guid
  • namespace: the namespace of the identifier
  • authority: the isuer of the identifier

Persisting a type reference means to persist the above identification elements. In addition to these identifier components, A Type mai also provide some additional metadata such as a name, description and domain.

MethodgetDisplayName
Description

Gets the full display name of this Type.

Returnosid.locale.DisplayTextthe display name of this Type
CompliancemandatoryThis method must be implemented.
MethodgetDisplayLabel
Description

Gets the shorter display label for this Type . Where a display name of a Type might be " Critical Logging Priority Type", the display label could be "critical".

Returnosid.locale.DisplayTextthe display label for this Type
CompliancemandatoryThis method must be implemented.
MethodgetDescription
Description

Gets a description of this Type.

Returnosid.locale.DisplayTextthe description of this Type
CompliancemandatoryThis method must be implemented.
MethodgetDomain
Description

Gets the domain. The domain can provide an information label about ths application space of this Type.

Returnosid.locale.DisplayTextthe domain of this Type
CompliancemandatoryThis method must be implemented.
MethodgetAuthority
Description

Gets the authority of this Type. The authority is a string used to ensure the uniqueness of this Type when using a non-federated identifier space. Generally, it is a domain name identifying the party responsible for this Type. This method is used to compare one Type to another.

Returnstringthe authority of this Type
CompliancemandatoryThis method must be implemented.
MethodgetIdentifierNamespace
Description

Gets the namespace of the identifier. This method is used to compare one Type to another.

Returnstringthe authority of this Type
CompliancemandatoryThis method must be implemented.
MethodgetIdentifier
Description

Gets the identifier of this Type. This method is used to compare one Type to another.

Returnstringthe identifier of this Type
CompliancemandatoryThis method must be implemented.