public interface OffsetEvent extends OsidRule
An OffsetEvent
describes events that are relative to
other events. OffsetEvents
may have a fixed or rubber start
date as well as a fixed or rubber end date. A rubber start and end date
has a variable duration based on the starting and ending milestones. An
OffsetEvent
with a fixed start date and a fixed duration
behaves like a normal fixed Event.
Creating an OffsetEvent
produces an Event
that is based on these offset rules.
Modifier and Type | Method and Description |
---|---|
Event |
getEndReferenceEvent()
Gets the
Event to which the end of this event is
offset. |
Id |
getEndReferenceEventId()
Gets the
Event Id to which the end of this event is
offset. |
Duration |
getFixedDuration(DateTimeResolution units)
Gets the duration of the offset event.
|
Duration |
getFixedEndOffset()
Gets the fixed ending time offset.
|
Duration |
getFixedStartOffset()
Gets the fixed starting time offset.
|
DateTime |
getFixedStartTime()
Gets the fixed start time for this event.
|
Location |
getLocation()
Gets the
Location. |
DisplayText |
getLocationDescription()
Gets a descriptive location.
|
Id |
getLocationId()
Gets the location
Id . |
OffsetEventRecord |
getOffsetEventRecord(Type offsetEventRecordType)
Gets the offset event record corresponding to the given
OffsetEvent record Type. |
long |
getRelativeEndWeekday()
Gets the ending weekday number.
|
long |
getRelativeStartWeekday()
Gets the starting weekday number.
|
long |
getRelativeWeekdayEndOffset()
Gets the ending offset as the nth weekday from the relative event.
|
long |
getRelativeWeekdayStartOffset()
Gets the starting offset as the nth weekday from the relative event.
|
IdList |
getSponsorIds()
Gets the
Id of the event sponsors. |
ResourceList |
getSponsors()
Gets the
Sponsors. |
Event |
getStartReferenceEvent()
Gets the
Event to which the start of this event is
offset. |
Id |
getStartReferenceEventId()
Gets the
Event Id to which the start of this event is
offset. |
boolean |
hasFixedDuration()
Tests if this offset event is based on a fixed duration.
|
boolean |
hasFixedEndOffset()
Tests if this offset end time based on a fixed period of time.
|
boolean |
hasFixedStartOffset()
Tests if this offset start time based on a fixed period of time.
|
boolean |
hasFixedStartTime()
Tests if this offset event is based on a fixed start time.
|
boolean |
hasLocation()
Tests if a location is associated with this event.
|
boolean |
hasRelativeWeekdayEndOffset()
Tests if this ending time offset is a based on a relative weekday.
|
boolean |
hasRelativeWeekdayStartOffset()
Tests if this starting time offset is a based on a relative weekday.
|
boolean |
hasSponsors()
Tests if a sponsor is associated with this event.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
boolean hasFixedStartTime()
true
if this offset is based on a fixed start
time, false
otherwisemandatory
- This method must be implemented. DateTime getFixedStartTime()
IllegalStateException
- hasFixedStartIme()
is false
mandatory
- This method must be implemented. Id getStartReferenceEventId()
Event Id
to which the start of this event is
offset. Id
IllegalStateException
- hasFixedStartTime()
is true
mandatory
- This method must be implemented. Event getStartReferenceEvent() throws OperationFailedException
Event
to which the start of this event is
offset.IllegalStateException
- hasFixedStartTime()
is true
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasFixedStartOffset()
true
if this offset is based on a fixed period
of time, false
otherwiseIllegalStateException
- hasFixedStartTime()
is true
mandatory
- This method must be implemented. Duration getFixedStartOffset()
IllegalStateException
- hasFixedStartOffset()
is false
mandatory
- This method must be implemented. boolean hasRelativeWeekdayStartOffset()
true
if this offset is based on a relative
weekday, false
otherwiseIllegalStateException
- hasFixedStartOffset()
is true
mandatory
- This method must be implemented. long getRelativeWeekdayStartOffset()
IllegalStateException
-
hasRelativeWeekdayStartOffset()
is false
mandatory
- This method must be implemented. long getRelativeStartWeekday()
IllegalStateException
-
hasRelativeWeekdayStartOffset()
is false
mandatory
- This method must be implemented. boolean hasFixedDuration()
true
if this offset is based on a fixed
duration, false
otherwisemandatory
- This method must be implemented. Duration getFixedDuration(DateTimeResolution units)
units
- the units of the durationIllegalStateException
- hasFixedDuration()
is false
NullArgumentException
- units
is
null
mandatory
- This method must be implemented. Id getEndReferenceEventId()
Event Id
to which the end of this event is
offset. Id
IllegalStateException
- hasFixedDuration()
is true
mandatory
- This method must be implemented. Event getEndReferenceEvent() throws OperationFailedException
Event
to which the end of this event is
offset.IllegalStateException
- hasFixedDuration()
is true
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasFixedEndOffset()
true
if this offset is based on a fixed period
of time, false
otherwiseIllegalStateException
- hasFixedDuration()
is true
mandatory
- This method must be implemented. Duration getFixedEndOffset()
IllegalStateException
- hasFixedEndOffset()
is false
mandatory
- This method must be implemented. boolean hasRelativeWeekdayEndOffset()
true
if this offset is based on a relative
weekday, false
otherwiseIllegalStateException
- hasFixedEndOffset()
is true
mandatory
- This method must be implemented. long getRelativeWeekdayEndOffset()
IllegalStateException
-
hasRelativeWeekdayEndOffset()
is false
mandatory
- This method must be implemented. long getRelativeEndWeekday()
IllegalStateException
-
hasRelativeWeekdayEndOffset()
is false
mandatory
- This method must be implemented. DisplayText getLocationDescription()
mandatory
- This method must be implemented. boolean hasLocation()
true
if there is an associated location,
false
otherwisemandatory
- This method must be implemented. Id getLocationId()
Id
. Id
IllegalStateException
- hasLocation()
is
false
mandatory
- This method must be implemented. Location getLocation() throws OperationFailedException
Location.
IllegalStateException
- hasLocation()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasSponsors()
true
if there is an associated sponsor.
false
otherwisemandatory
- This method must be implemented. IdList getSponsorIds()
Id
of the event sponsors. Ids
IllegalStateException
- hasSponsors()
is
false
mandatory
- This method must be implemented. ResourceList getSponsors() throws OperationFailedException
Sponsors.
IllegalStateException
- hasSponsors()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. OffsetEventRecord getOffsetEventRecord(Type offsetEventRecordType) throws OperationFailedException
OffsetEvent
record Type.
This method is used to
retrieve an object implementing the requested record. The
offsetEventRecordType
may be the Type
returned
in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(offsetEventRecordType)
is true
.offsetEventRecordType
- the type of the record to retrieveNullArgumentException
- offsetEventRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(offsetEventRecordType)
is false
mandatory
- This method must be implemented.