Interface OffsetEventForm

All Superinterfaces:

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

All Known Subinterfaces:

OffsetEventBatchForm

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.

Method Summary

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 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 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

getFixedStartTimeMetadata

Metadata getFixedStartTimeMetadata()

Gets the metadata for the fixed start time.

Returns:

metadata for the fixed start time

Compliance:

mandatory - This method must be implemented.

setFixedStartTime

void setFixedStartTime(DateTime date)

Sets the fixed start time.

Parameters:

date - the fixed start time

Throws:

InvalidArgumentException - date is invalid

NoAccessException - date cannot be modified

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearFixedStartTime

void clearFixedStartTime()

Clears the fixed start time.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getStartReferenceEventMetadata

Metadata getStartReferenceEventMetadata()

Gets the metadata for the starting reference event.

Returns:

metadata for the starting reference event

Compliance:

mandatory - This method must be implemented.

setStartReferenceEvent

void setStartReferenceEvent(Id eventId)

Sets the fixed start time.

Parameters:

eventId - the start reference event Id

Throws:

InvalidArgumentException - eventId is invalid

NoAccessException - eventId cannot be modified

NullArgumentException - eventId is null

Compliance:

mandatory - This method must be implemented.

clearStartReferenceEvent

void clearStartReferenceEvent()

Clears the start reference event.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getFixedStartOffsetMetadata

Metadata getFixedStartOffsetMetadata()

Gets the metadata for the fixed start offset.

Returns:

metadata for the fixed start offset

Compliance:

mandatory - This method must be implemented.

setFixedStartOffset

void setFixedStartOffset(Duration offset)

Sets the fixed start offset.

Parameters:

offset - the fixed offset

Throws:

InvalidArgumentException - offset is invalid

NoAccessException - offset cannot be modified

NullArgumentException - offset is null

Compliance:

mandatory - This method must be implemented.

clearFixedStartOffset

void clearFixedStartOffset()

Clears the fixed start offset.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRelativeWeekdayStartOffsetMetadata

Metadata getRelativeWeekdayStartOffsetMetadata()

Gets the metadata for the relative weekday offset.

Returns:

metadata for the relative weekday offset

Compliance:

mandatory - This method must be implemented.

setRelativeWeekdayStartOffset

void setRelativeWeekdayStartOffset(long offset)

Sets the relative weekday offset as the nth weekday from the relative event.

Parameters:

offset - the week offset

Throws:

InvalidArgumentException - offset is invalid

NoAccessException - offset cannot be modified

Compliance:

mandatory - This method must be implemented.

clearRelativeWeekdayStartOffset

void clearRelativeWeekdayStartOffset()

Clears the relative weekday offset.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRelativeStartWeekdayMetadata

Metadata getRelativeStartWeekdayMetadata()

Gets the metadata for the relative weekday.

Returns:

metadata for the relative weekday

Compliance:

mandatory - This method must be implemented.

setRelativeStartWeekday

void setRelativeStartWeekday(long weekday)

Sets the relative weekday.

Parameters:

weekday - the weekday

Throws:

InvalidArgumentException - weekday is invalid

NoAccessException - weekday cannot be modified

Compliance:

mandatory - This method must be implemented.

clearRelativeStartWeekday

void clearRelativeStartWeekday()

Clears the relative start weekday.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getFixedDurationMetadata

Metadata getFixedDurationMetadata()

Gets the metadata for the fixed duration.

Returns:

metadata for the fixed duration

Compliance:

mandatory - This method must be implemented.

setFixedDuration

void setFixedDuration(Duration duration)

Sets the fixed duration.

Parameters:

duration - the fixed duration

Throws:

InvalidArgumentException - duration is invalid

NoAccessException - duration cannot be modified

NullArgumentException - duration is null

Compliance:

mandatory - This method must be implemented.

clearFixedDuration

void clearFixedDuration()

Clears the fixed duration.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getEndReferenceEventMetadata

Metadata getEndReferenceEventMetadata()

Gets the metadata for the ending reference event.

Returns:

metadata for the ending reference event

Compliance:

mandatory - This method must be implemented.

setEndReferenceEvent

void setEndReferenceEvent(Id eventId)

Sets the fixed end time.

Parameters:

eventId - the end reference event Id

Throws:

InvalidArgumentException - eventId is invalid

NoAccessException - eventId cannot be modified

NullArgumentException - eventId is null

Compliance:

mandatory - This method must be implemented.

clearEndReferenceEvent

void clearEndReferenceEvent()

Clears the ending reference event.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getFixedEndOffsetMetadata

Metadata getFixedEndOffsetMetadata()

Gets the metadata for the fixed end offset.

Returns:

metadata for the fixed end offset

Compliance:

mandatory - This method must be implemented.

setFixedEndOffset

void setFixedEndOffset(Duration offset)

Sets the fixed end offset.

Parameters:

offset - the fixed offset

Throws:

InvalidArgumentException - offset is invalid

NoAccessException - offset cannot be modified

NullArgumentException - offset is null

Compliance:

mandatory - This method must be implemented.

clearFixedEndOffset

void clearFixedEndOffset()

Clears the fixed end offset.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRelativeWeekdayEndOffsetMetadata

Metadata getRelativeWeekdayEndOffsetMetadata()

Gets the metadata for the relative weekday offset.

Returns:

metadata for the relative weekday offset

Compliance:

mandatory - This method must be implemented.

setRelativeWeekdayEndOffset

void setRelativeWeekdayEndOffset(long offset)

Sets the relative weekday offset as the nth weekday from the relative event.

Parameters:

offset - the week offset

Throws:

InvalidArgumentException - offset is invalid

NoAccessException - offset cannot be modified

Compliance:

mandatory - This method must be implemented.

clearRelativeWeekdayEndOffset

void clearRelativeWeekdayEndOffset()

Clears the relative weekday offset.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRelativeEndWeekdayMetadata

Metadata getRelativeEndWeekdayMetadata()

Gets the metadata for the relative weekday.

Returns:

metadata for the relative weekday

Compliance:

mandatory - This method must be implemented.

setRelativeEndWeekday

void setRelativeEndWeekday(long weekday)

Sets the relative weekday.

Parameters:

weekday - the weekday

Throws:

InvalidArgumentException - weekday is invalid

NoAccessException - weekday cannot be modified

Compliance:

mandatory - This method must be implemented.

clearRelativeEndWeekday

void clearRelativeEndWeekday()

Clears the relative end weekday.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getLocationDescriptionMetadata

Metadata getLocationDescriptionMetadata()

Gets the metadata for a location description.

Returns:

metadata for the location description

Compliance:

mandatory - This method must be implemented.

setLocationDescription

void setLocationDescription(String location)

Sets the location description.

Parameters:

location - the new location description

Throws:

InvalidArgumentException - location is invalid

NoAccessException - location cannot be modified

NullArgumentException - location is null

Compliance:

mandatory - This method must be implemented.

clearLocationDescription

void clearLocationDescription()

Clears the location description.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getLocationMetadata

Metadata getLocationMetadata()

Gets the metadata for a location.

Returns:

metadata for the location

Compliance:

mandatory - This method must be implemented.

setLocation

void setLocation(Id locationId)

Sets the location.

Parameters:

locationId - the new location

Throws:

InvalidArgumentException - locationId is invalid

NoAccessException - locationId cannot be modified

NullArgumentException - locationId is null

Compliance:

mandatory - This method must be implemented.

clearLocation

void clearLocation()

Clears the location.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getSponsorsMetadata

Metadata getSponsorsMetadata()

Gets the metadata for a sponsor.

Returns:

metadata for the sponsor

Compliance:

mandatory - This method must be implemented.

setSponsors

void setSponsors(Id[] sponsorIds)

Sets the sponsors.

Parameters:

sponsorIds - the new sponsor

Throws:

InvalidArgumentException - sponsorIds is invalid

NoAccessException - sponsorIds cannot be modified

NullArgumentException - sponsorIds is null

Compliance:

mandatory - This method must be implemented.

clearSponsors

void clearSponsors()

Clears the sponsors.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getOffsetEventFormRecord

OffsetEventFormRecord getOffsetEventFormRecord(Type offsetEventRecordType)
                                        throws OperationFailedException

Gets the OffsetEventFormRecord corresponding to the given schedule record Type.

Parameters:

offsetEventRecordType - the offset event record type

Returns:

the offset event form record

Throws:

NullArgumentException - offsetEventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(offsetEventRecordType) is false

Compliance:

mandatory - This method must be implemented.