Class OsidParameter

java.lang.Object
org.osid.meta.OsidParameter
public class OsidParameter extends Object
The definition for an OSID parameter.

  • Constructor Details

    • OsidParameter

      protected OsidParameter(String name, 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(String name, 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(String name, String type, boolean array, 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 Details

    • getName

      public String getName()
      Gets the name of this parameter.
      Returns:
      the parameter name

    • getType

      public String getType()
      Gets the type of this parameter.
      Returns:
      the parameter type

    • getSpecType

      public 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