Class OsidInterface

java.lang.Object

org.osid.meta.OsidInterface

public class OsidInterface
extends Object

Represents an OSID interface.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OsidInterface(String name)	Constructs a new OsidInterface.

Method Summary

Modifier and Type	Method	Description
protected void	addMethod(OsidMethod method)
OsidMethod	getMethod(String name)	Gets a method defined in this interface.
Collection<OsidMethod>	getMethods()	Gets all methods defined in this interface.
String	getName()	Gets the name of this interface.
boolean	isDeprecated()	Tests if the interface is specified as deprecated.
boolean	isNew()	Tests if the interface is specified as new.
protected void	setDeprecated(String asOf)
protected void	setNew(String asOf)

Methods inherited from class Object

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

Constructor Details

OsidInterface

protected OsidInterface(String name)

Constructs a new OsidInterface.

Parameters:

name - the name of the interface

Method Details

getName

public String getName()

Gets the name of this interface.

Returns:

the interface name

isDeprecated

public boolean isDeprecated()

Tests if the interface is specified as deprecated.

Returns:

true if the interface is deprecated, false otherwise

setDeprecated

protected void setDeprecated(String asOf)

isNew

public boolean isNew()

Tests if the interface is specified as new.

Returns:

true if the interface is new, false otherwise

setNew

protected void setNew(String asOf)

getMethods

public Collection<OsidMethod> getMethods()

Gets all methods defined in this interface.

Returns:

the methods

getMethod

public OsidMethod getMethod(String name)

Gets a method defined in this interface.

Parameters:

name - the name of the method to retrieve

Returns:

the method or null if not found

addMethod

protected void addMethod(OsidMethod method)