Class OsidReturn

java.lang.Object
org.osid.meta.OsidReturn
public class OsidReturn extends Object
Defines an OSID return statement.

  • Constructor Details

    • OsidReturn

      protected OsidReturn(String type)
      Constructs a new OsidReturn for enumerations. This constructor marks the return as an enumeration.
      Parameters:
      type - the type of the enumeration

    • OsidReturn

      protected OsidReturn(String type, boolean array)
      Constructs a new OsidReturn for non-primitives.
      Parameters:
      type - the return type
      array - true if the return type is an array

    • OsidReturn

      protected OsidReturn(String type, boolean array, String specPrimitiveType)
      Constructs a new OsidReturn for primitives. This constructor marks the return as a primitive.
      Parameters:
      type - the type of the primitive or interface
      array - true if the return is an array false otherwise
      specPrimitiveType - the primitive type according to spec

  • Method Details

    • getType

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

    • getSpecType

      public String getSpecType()
      Gets the specification type of this return..
      Returns:
      the specification type

    • isPrimitive

      public boolean isPrimitive()
      Tests if this return is an OSID primitive.
      Returns:
      true if this return is an OSID primitive, code otherwise

    • isEnumeration

      public boolean isEnumeration()
      Tests if this return is an OSID enumeration.
      Returns:
      true if this return is an OSID enumeration, code otherwise

    • isArray

      public boolean isArray()
      Tests if the return is an array.
      Returns:
      true if this return is an array, code otherwise