Class OsidMethod

java.lang.Object
org.osid.meta.OsidMethod
public class OsidMethod extends Object
Describes the structure of an OSID method.

  • Constructor Details

    • OsidMethod

      protected OsidMethod(String name)
      Constructs a new OsidMethod.
      Parameters:
      name - method name

  • Method Details

    • getName

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

    • getReturn

      public OsidReturn getReturn()
      Gets the method return.
      Returns:
      the return or null if none

    • setReturn

      protected void setReturn(OsidReturn ret)

    • getParameters

      public Collection<OsidParameter> getParameters()
      Gets the method paramerers.
      Returns:
      the parameters or null if none

    • addParameter

      protected void addParameter(OsidParameter parameter)

    • getErrors

      public Collection<String> getErrors()
      Gets the method errors.
      Returns:
      the errors or null if none

    • addError

      protected void addError(String error)

    • isMandatory

      public boolean isMandatory()
      Tests if the method is specified as mandatory.
      Returns:
      true if the method is mandatory, false otherwise

    • setMandatory

      protected void setMandatory(boolean mandatory)

    • isDeprecated

      public boolean isDeprecated()
      Tests if the method is specified as deprecated.
      Returns:
      true if the method is deprecated, false otherwise

    • setDeprecated

      protected void setDeprecated(String asOf)

    • isNew

      public boolean isNew()
      Tests if the method is specified as new.
      Returns:
      true if the method is new, false otherwise

    • setNew

      protected void setNew(String asOf)