Interface OffsetEventBatchForm

All Superinterfaces:

Extensible, Identifiable, OffsetEventForm, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable

public interface OffsetEventBatchForm
extends OffsetEventForm

This is the form for creating and updating offset events in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the OffsetEventBatchAdminSession . For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Modifier and Type	Method	Description
Id	getEventId()	Gets the Event Id of the offset event if this is a create transaction.
Id	getOffsetEventId()	Gets the Id of the offset event to be updated if this is an update transaction.
Id	getTimePeriodId()	Gets the time period Id of the offset event if this is a create transaction.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OffsetEventForm

clearEndReferenceEvent, clearFixedDuration, clearFixedEndOffset, clearFixedStartOffset, clearFixedStartTime, clearLocation, clearLocationDescription, clearRelativeEndWeekday, clearRelativeStartWeekday, clearRelativeWeekdayEndOffset, clearRelativeWeekdayStartOffset, clearSponsors, clearStartReferenceEvent, getEndReferenceEventMetadata, getFixedDurationMetadata, getFixedEndOffsetMetadata, getFixedStartOffsetMetadata, getFixedStartTimeMetadata, getLocationDescriptionMetadata, getLocationMetadata, getOffsetEventFormRecord, getRelativeEndWeekdayMetadata, getRelativeStartWeekdayMetadata, getRelativeWeekdayEndOffsetMetadata, getRelativeWeekdayStartOffsetMetadata, getSponsorsMetadata, getStartReferenceEventMetadata, setEndReferenceEvent, setFixedDuration, setFixedEndOffset, setFixedStartOffset, setFixedStartTime, setLocation, setLocationDescription, setRelativeEndWeekday, setRelativeStartWeekday, setRelativeWeekdayEndOffset, setRelativeWeekdayStartOffset, setSponsors, setStartReferenceEvent

Modifier and Type	Method	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	getSponsorsMetadata()	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(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.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Methods inherited from interface OsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
void	setRule(Id ruleId)	Sets a rule.

Method Details

getEventId

Id getEventId()

Gets the Event Id of the offset event if this is a create transaction.

Returns:

the event Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getTimePeriodId

Id getTimePeriodId()

Gets the time period Id of the offset event if this is a create transaction.

Returns:

the time period Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getOffsetEventId

Id getOffsetEventId()

Gets the Id of the offset event to be updated if this is an update transaction.

Returns:

the offset event Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.