org.osid.meta

Class OsidParameter

java.lang.Object

org.osid.meta.OsidParameter

public class OsidParameter
extends java.lang.Object

The definition for an OSID parameter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OsidParameter(java.lang.String name, java.lang.String type) Constructs a new OsidParameter for enumerations.
protected	OsidParameter(java.lang.String name, java.lang.String type, boolean array) Constructs a new OsidParameter for non-primitives.
protected	OsidParameter(java.lang.String name, java.lang.String type, boolean array, java.lang.String specPrimitiveType) Constructs a new OsidParameter for primitives.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName() Gets the name of this parameter.
java.lang.String	getSpecType() Gets the specification type of this parameter.
java.lang.String	getType() Gets the type of this parameter.
boolean	isArray() Tests if this parameter is an array.
boolean	isEnumeration() Tests if this parameter is an OSID enumeration.
boolean	isPrimitive() Tests if this parameter is an OSID primitive.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OsidParameter

protected OsidParameter(java.lang.String name,
             java.lang.String type)

Constructs a new OsidParameter for enumerations. This constructor marks the parameter as an enumeration.

Parameters:

name - the name of the enumeration

type - the type of the enumeration

OsidParameter

protected OsidParameter(java.lang.String name,
             java.lang.String type,
             boolean array)

Constructs a new OsidParameter for non-primitives.

Parameters:

name - the parameter name

type - the name of the primitive or interface

array - true if the parameter is an array false otherwise

OsidParameter

protected OsidParameter(java.lang.String name,
             java.lang.String type,
             boolean array,
             java.lang.String specPrimitiveType)

Constructs a new OsidParameter for primitives. This constructor marks the parameter as a primitive.

Parameters:

name - the parameter name

type - the name of the primitive or interface

array - true if the parameter is an array false otherwise

specPrimitiveType - the primitive type according to spec

Method Detail

getName

public java.lang.String getName()

Gets the name of this parameter.

Returns:

the parameter name

getType

public java.lang.String getType()

Gets the type of this parameter.

Returns:

the parameter type

getSpecType

public java.lang.String getSpecType()

Gets the specification type of this parameter.

Returns:

the specification type

isPrimitive

public boolean isPrimitive()

Tests if this parameter is an OSID primitive.

Returns:

true if this parameter is an OSID primitive, code otherwise

isEnumeration

public boolean isEnumeration()

Tests if this parameter is an OSID enumeration.

Returns:

true if this parameter is an OSID enumeration, code otherwise

isArray

public boolean isArray()

Tests if this parameter is an array.

Returns:

true if this parameter is an array, code otherwise