org.osid.meta

Class OsidMethod

java.lang.Object

org.osid.meta.OsidMethod

public class OsidMethod
extends java.lang.Object

Describes the structure of an OSID method.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OsidMethod(java.lang.String name) Constructs a new OsidMethod.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addError(java.lang.String error)
protected void	addParameter(OsidParameter parameter)
java.util.Collection<java.lang.String>	getErrors() Gets the method errors.
java.lang.String	getName() Gets the method name.
java.util.Collection<OsidParameter>	getParameters() Gets the method paramerers.
OsidReturn	getReturn() Gets the method return.
boolean	isDeprecated() Tests if the method is specified as deprecated.
boolean	isMandatory() Tests if the method is specified as mandatory.
boolean	isNew() Tests if the method is specified as new.
protected void	setDeprecated(java.lang.String asOf)
protected void	setMandatory(boolean mandatory)
protected void	setNew(java.lang.String asOf)
protected void	setReturn(OsidReturn ret)

Methods inherited from class java.lang.Object

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

Constructor Detail

OsidMethod

protected OsidMethod(java.lang.String name)

Constructs a new OsidMethod.

Parameters:

name - method name

Method Detail

getName

public java.lang.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 java.util.Collection<OsidParameter> getParameters()

Gets the method paramerers.

Returns:

the parameters or null if none

addParameter

protected void addParameter(OsidParameter parameter)

getErrors

public java.util.Collection<java.lang.String> getErrors()

Gets the method errors.

Returns:

the errors or null if none

addError

protected void addError(java.lang.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(java.lang.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(java.lang.String asOf)