org.osid.type

Interface Type

All Superinterfaces:

java.lang.Comparable<Type>, OsidPrimitive, java.io.Serializable, Type

public interface Type
extends OsidPrimitive, Type

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.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAuthority() Gets the authority of this Type.
DisplayText	getDescription() Gets a description of this Type.
DisplayText	getDisplayLabel() Gets the shorter display label for this Type .
DisplayText	getDisplayName() Gets the full display name of this Type.
DisplayText	getDomain() Gets the domain.
java.lang.String	getIdentifier() Gets the identifier of this Type.
java.lang.String	getIdentifierNamespace() Gets the namespace of the identifier.

Methods inherited from interface org.osid.binding.java.Type

compareTo, equals, hashCode

Methods inherited from interface org.osid.binding.java.OsidPrimitive

toString

Method Detail

getDisplayName

DisplayText getDisplayName()

Gets the full display name of this Type.

Returns:

the display name of this Type

Compliance:

mandatory - This method must be implemented.

getDisplayLabel

DisplayText getDisplayLabel()

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".

Returns:

the display label for this Type

Compliance:

mandatory - This method must be implemented.

getDescription

DisplayText getDescription()

Gets a description of this Type.

Returns:

the description of this Type

Compliance:

mandatory - This method must be implemented.

getDomain

DisplayText getDomain()

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

Returns:

the domain of this Type

Compliance:

mandatory - This method must be implemented.

getAuthority

java.lang.String getAuthority()

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.

Returns:

the authority of this Type

Compliance:

mandatory - This method must be implemented.

getIdentifierNamespace

java.lang.String getIdentifierNamespace()

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

Returns:

the authority of this Type

Compliance:

mandatory - This method must be implemented.

getIdentifier

java.lang.String getIdentifier()

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

Returns:

the identifier of this Type

Compliance:

mandatory - This method must be implemented.