org.osid.calendaring

Interface MeetingTime

All Superinterfaces:

OsidCapsule

public interface MeetingTime
extends OsidCapsule

An individual meeting time.

Method Summary

Methods

Modifier and Type	Method and Description
DateTime	getDate() Gets the date.
Location	getLocation() Gets the Location.
DisplayText	getLocationDescription() Gets a descriptive text for the location.
Id	getLocationId() Gets the location Id .
boolean	hasLocation() Tests if a location is available.

Method Detail

getDate

DateTime getDate()

Gets the date.

Returns:

the date

Compliance:

mandatory - This method must be implemented.

getLocationDescription

DisplayText getLocationDescription()

Gets a descriptive text for the location.

Returns:

a location description

Compliance:

mandatory - This method must be implemented.

hasLocation

boolean hasLocation()

Tests if a location is available.

Returns:

true if a location is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLocationId

Id getLocationId()

Gets the location Id .

Returns:

a location Id

Throws:

IllegalStateException - hasLocation() is false

Compliance:

mandatory - This method must be implemented.

getLocation

Location getLocation()
                     throws OperationFailedException

Gets the Location.

Returns:

a location

Throws:

IllegalStateException - hasLocation() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.