public interface EventForm extends OsidObjectForm, OsidTemporalForm, OsidContainableForm
This is the form for creating and updating Events.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the EventAdminSession.
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 |
clearLocation()
Clears the location.
|
void |
clearLocationDescription()
Clears the location description.
|
void |
clearSponsors()
Clears the sponsors.
|
EventFormRecord |
getEventFormRecord(Type eventRecordType)
Gets the
EventFormRecord corresponding to the given
event record Type. |
Metadata |
getLocationDescriptionMetadata()
Gets the metadata for a location description.
|
Metadata |
getLocationMetadata()
Gets the metadata for a location.
|
Metadata |
getSponsorMetadata()
Gets the metadata for a sponsor.
|
void |
setLocation(Id locationId)
Sets the location.
|
void |
setLocationDescription(java.lang.String location)
Sets the location description.
|
void |
setSponsors(Id[] sponsorIds)
Sets the sponsors.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
clearSequestered, getSequesteredMetadata, setSequestered
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. EventFormRecord getEventFormRecord(Type eventRecordType) throws OperationFailedException
EventFormRecord
corresponding to the given
event record Type.
eventRecordType
- the event record typeNullArgumentException
- eventRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(eventRecordType)
is false
mandatory
- This method must be implemented.