public interface OffsetEventForm extends OsidRuleForm
This is the form for creating and updating OffsetEvents.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
OffsetEventAdminSession.
For each data element that may be set,
metadata may be examined to provide display hints or data constraints.
Modifier and Type | Method and Description |
---|---|
void |
clearEndReferenceEvent()
Clears the ending reference event.
|
void |
clearFixedDuration()
Clears the fixed duration.
|
void |
clearFixedEndOffset()
Clears the fixed end offset.
|
void |
clearFixedStartOffset()
Clears the fixed start offset.
|
void |
clearFixedStartTime()
Clears the fixed start time.
|
void |
clearLocation()
Clears the location.
|
void |
clearLocationDescription()
Clears the location description.
|
void |
clearRelativeEndWeekday()
Clears the relative end weekday.
|
void |
clearRelativeStartWeekday()
Clears the relative start weekday.
|
void |
clearRelativeWeekdayEndOffset()
Clears the relative weekday offset.
|
void |
clearRelativeWeekdayStartOffset()
Clears the relative weekday offset.
|
void |
clearSponsors()
Clears the sponsors.
|
void |
clearStartReferenceEvent()
Clears the start reference event.
|
Metadata |
getEndReferenceEventMetadata()
Gets the metadata for the ending reference event.
|
Metadata |
getFixedDurationMetadata()
Gets the metadata for the fixed duration.
|
Metadata |
getFixedEndOffsetMetadata()
Gets the metadata for the fixed end offset.
|
Metadata |
getFixedStartOffsetMetadata()
Gets the metadata for the fixed start offset.
|
Metadata |
getFixedStartTimeMetadata()
Gets the metadata for the fixed start time.
|
Metadata |
getLocationDescriptionMetadata()
Gets the metadata for a location description.
|
Metadata |
getLocationMetadata()
Gets the metadata for a location.
|
OffsetEventFormRecord |
getOffsetEventFormRecord(Type offsetEventRecordType)
Gets the
OffsetEventFormRecord corresponding to the
given schedule record Type. |
Metadata |
getRelativeEndWeekdayMetadata()
Gets the metadata for the relative weekday.
|
Metadata |
getRelativeStartWeekdayMetadata()
Gets the metadata for the relative weekday.
|
Metadata |
getRelativeWeekdayEndOffsetMetadata()
Gets the metadata for the relative weekday offset.
|
Metadata |
getRelativeWeekdayStartOffsetMetadata()
Gets the metadata for the relative weekday offset.
|
Metadata |
getSponsorMetadata()
Gets the metadata for a sponsor.
|
Metadata |
getStartReferenceEventMetadata()
Gets the metadata for the starting reference event.
|
void |
setEndReferenceEvent(Id eventId)
Sets the fixed end time.
|
void |
setFixedDuration(Duration duration)
Sets the fixed duration.
|
void |
setFixedEndOffset(Duration offset)
Sets the fixed end offset.
|
void |
setFixedStartOffset(Duration offset)
Sets the fixed start offset.
|
void |
setFixedStartTime(DateTime date)
Sets the fixed start time.
|
void |
setLocation(Id locationId)
Sets the location.
|
void |
setLocationDescription(java.lang.String location)
Sets the location description.
|
void |
setRelativeEndWeekday(long weekday)
Sets the relative weekday.
|
void |
setRelativeStartWeekday(long weekday)
Sets the relative weekday.
|
void |
setRelativeWeekdayEndOffset(long offset)
Sets the relative weekday offset as the nth weekday from the relative
event.
|
void |
setRelativeWeekdayStartOffset(long offset)
Sets the relative weekday offset as the nth weekday from the relative
event.
|
void |
setSponsors(Id[] sponsorIds)
Sets the sponsors.
|
void |
setStartReferenceEvent(Id eventId)
Sets the fixed start time.
|
clearRule, getRuleMetadata, setRule
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
Metadata getFixedStartTimeMetadata()
mandatory
- This method must be implemented. void setFixedStartTime(DateTime date)
date
- the fixed start timeInvalidArgumentException
- date
is
invalidNoAccessException
- date
cannot be
modifiedNullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearFixedStartTime()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getStartReferenceEventMetadata()
mandatory
- This method must be implemented. void setStartReferenceEvent(Id eventId)
eventId
- the start reference event Id
InvalidArgumentException
- eventId
is
invalidNoAccessException
- eventId
cannot be
modifiedNullArgumentException
- eventId
is
null
mandatory
- This method must be implemented. void clearStartReferenceEvent()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getFixedStartOffsetMetadata()
mandatory
- This method must be implemented. void setFixedStartOffset(Duration offset)
offset
- the fixed offsetInvalidArgumentException
- offset
is
invalidNoAccessException
- offset
cannot be
modifiedNullArgumentException
- offset
is
null
mandatory
- This method must be implemented. void clearFixedStartOffset()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRelativeWeekdayStartOffsetMetadata()
mandatory
- This method must be implemented. void setRelativeWeekdayStartOffset(long offset)
offset
- the week offsetInvalidArgumentException
- offset
is
invalidNoAccessException
- offset
cannot be
modifiedmandatory
- This method must be implemented. void clearRelativeWeekdayStartOffset()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRelativeStartWeekdayMetadata()
mandatory
- This method must be implemented. void setRelativeStartWeekday(long weekday)
weekday
- the weekdayInvalidArgumentException
- weekday
is
invalidNoAccessException
- weekday
cannot be
modifiedmandatory
- This method must be implemented. void clearRelativeStartWeekday()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getFixedDurationMetadata()
mandatory
- This method must be implemented. void setFixedDuration(Duration duration)
duration
- the fixed durationInvalidArgumentException
- duration
is
invalidNoAccessException
- duration
cannot be
modifiedNullArgumentException
- duration
is
null
mandatory
- This method must be implemented. void clearFixedDuration()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getEndReferenceEventMetadata()
mandatory
- This method must be implemented. void setEndReferenceEvent(Id eventId)
eventId
- the end reference event Id
InvalidArgumentException
- eventId
is
invalidNoAccessException
- eventId
cannot be
modifiedNullArgumentException
- eventId
is
null
mandatory
- This method must be implemented. void clearEndReferenceEvent()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getFixedEndOffsetMetadata()
mandatory
- This method must be implemented. void setFixedEndOffset(Duration offset)
offset
- the fixed offsetInvalidArgumentException
- offset
is
invalidNoAccessException
- offset
cannot be
modifiedNullArgumentException
- offset
is
null
mandatory
- This method must be implemented. void clearFixedEndOffset()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRelativeWeekdayEndOffsetMetadata()
mandatory
- This method must be implemented. void setRelativeWeekdayEndOffset(long offset)
offset
- the week offsetInvalidArgumentException
- offset
is
invalidNoAccessException
- offset
cannot be
modifiedmandatory
- This method must be implemented. void clearRelativeWeekdayEndOffset()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRelativeEndWeekdayMetadata()
mandatory
- This method must be implemented. void setRelativeEndWeekday(long weekday)
weekday
- the weekdayInvalidArgumentException
- weekday
is
invalidNoAccessException
- weekday
cannot be
modifiedmandatory
- This method must be implemented. void clearRelativeEndWeekday()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getLocationDescriptionMetadata()
mandatory
- This method must be implemented. void setLocationDescription(java.lang.String location)
location
- the new location descriptionInvalidArgumentException
- location
is
invalidNoAccessException
- location
cannot be
modifiedNullArgumentException
- location
is
null
mandatory
- This method must be implemented. void clearLocationDescription()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getLocationMetadata()
mandatory
- This method must be implemented. void setLocation(Id locationId)
locationId
- the new locationInvalidArgumentException
- locationId
is
invalidNoAccessException
- locationId
cannot be
modifiedNullArgumentException
- locationId
is
null
mandatory
- This method must be implemented. void clearLocation()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getSponsorMetadata()
mandatory
- This method must be implemented. void setSponsors(Id[] sponsorIds)
sponsorIds
- the new sponsorInvalidArgumentException
- sponsorIds
is
invalidNoAccessException
- sponsorIds
cannot be
modifiedNullArgumentException
- sponsorIds
is
null
mandatory
- This method must be implemented. void clearSponsors()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. OffsetEventFormRecord getOffsetEventFormRecord(Type offsetEventRecordType) throws OperationFailedException
OffsetEventFormRecord
corresponding to the
given schedule record Type.
offsetEventRecordType
- the offset event record typeNullArgumentException
- offsetEventRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(offsetEventRecordType)
is false
mandatory
- This method must be implemented.