Interface Event

All Superinterfaces:
Browsable, Containable, Extensible, Identifiable, OsidObject, Temporal
public interface Event extends OsidObject, Temporal, Containable

An Event represents a span of time and an optional location.

  • Method Details

    • isImplicit

      boolean isImplicit()
      Tests if this event is implicit. An implicit event is one that is generated from an offset or recurring series.
      Returns:
      true if this event is implicit, false if explicitly defined
      Compliance:
      mandatory - This method must be implemented.

    • isInRecurringSeries

      boolean isInRecurringSeries()
      Tests if this event is an implclit event part of a recurring event. If true, isImplicit() must also be true.
      Returns:
      true if this event is part of a recurring series, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • isSupersedingEvent

      boolean isSupersedingEvent()
      Tests if this event is a superseding event. If true, isImplicit() must also be true.
      Returns:
      true if this event is superseding event, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • isOffsetEvent

      boolean isOffsetEvent()
      Tests if this event is an event calculated from an offset. If true, isImplicit() must also be true.
      Returns:
      true if this event is an offset event, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getDuration

      Duration getDuration(DateTimeResolution units)
      Gets the duration of the event.
      Parameters:
      units - the units of the duration
      Returns:
      the duration
      Throws:
      NullArgumentException - units is null
      Compliance:
      mandatory - This method must be implemented.

    • getLocationDescription

      DisplayText getLocationDescription()
      Gets a descriptive location.
      Returns:
      the location
      Compliance:
      mandatory - This method must be implemented.

    • hasLocation

      boolean hasLocation()
      Tests if a location is associated with this event.
      Returns:
      true if there is an associated location, 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.

    • hasSponsors

      boolean hasSponsors()
      Tests if a sponsor is associated with this event.
      Returns:
      true if there is an associated sponsor. false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSponsorIds

      IdList getSponsorIds()
      Gets the Id of the event sponsors.
      Returns:
      the sponsor Ids
      Throws:
      IllegalStateException - hasSponsors() is false
      Compliance:
      mandatory - This method must be implemented.

    • getSponsors

      ResourceList getSponsors() throws OperationFailedException
      Gets the Sponsors .
      Returns:
      the sponsors
      Throws:
      IllegalStateException - hasSponsors() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getEventRecord

      EventRecord getEventRecord(Type eventRecordType) throws OperationFailedException
      Gets the event record corresponding to the given Event record Type .This method is used to retrieve an object implementing the requested record. The eventRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(eventRecordType) is true .
      Parameters:
      eventRecordType - the type of the record to retrieve
      Returns:
      the event record
      Throws:
      NullArgumentException - eventRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(eventRecordType) is false
      Compliance:
      mandatory - This method must be implemented.