public interface CourseOfferingForm extends OsidRelationshipForm
This is the form for creating and updating CourseOfferings.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
CourseOfferingAdminSession.
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 |
clearCredits()
Removes the credits.
|
void |
clearEvent()
Removes the event.
|
void |
clearGradingOptions()
Removes the grading options.
|
void |
clearInstructors()
Removes the instructors.
|
void |
clearMaximumSeats()
Removes the maximum seats.
|
void |
clearMinimumSeats()
Removes the minimum seats.
|
void |
clearNumber()
Removes the course number.
|
void |
clearRequiresRegistration()
Removes the requires registration flag.
|
void |
clearScheduleInfo()
Removes the schedule info.
|
void |
clearSponsors()
Removes the sponsors.
|
void |
clearTitle()
Removes the title.
|
void |
clearURL()
Removes the url.
|
CourseOfferingFormRecord |
getCourseOfferingFormRecord(Type courseOfferingRecordType)
Gets the
CourseOfferingFormRecord corresponding to the
given course offering record Type. |
Metadata |
getCreditsMetadata()
Gets the metadata for the credits.
|
Metadata |
getEventMetadata()
Gets the metadata for manually linking an event.
|
Metadata |
getGradingOptionsMetadata()
Gets the metadata for the grading options.
|
Metadata |
getInstructorsMetadata()
Gets the metadata for the instructors.
|
Metadata |
getMaximumSeatsMetadata()
Gets the metadata for the maximum seats.
|
Metadata |
getMinimumSeatsMetadata()
Gets the metadata for the minimum seats.
|
Metadata |
getNumberMetadata()
Gets the metadata for a course number.
|
Metadata |
getRequiresRegistrationMetadata()
Gets the metadata for requires registration flag.
|
Metadata |
getScheduleInfoMetadata()
Gets the metadata for a schedule informatoin string.
|
Metadata |
getSponsorsMetadata()
Gets the metadata for the sponsors.
|
Metadata |
getTitleMetadata()
Gets the metadata for a course title.
|
Metadata |
getURLMetadata()
Gets the metadata for a class url.
|
void |
setCredits(Id[] gradeIds)
Sets the credits.
|
void |
setEvent(Id eventId)
Sets the event.
|
void |
setGradingOptions(Id[] gradeSystemIds)
Sets the grading options.
|
void |
setInstructors(Id[] resourceIds)
Sets the instructors.
|
void |
setMaximumSeats(long seats)
Sets the maximum seating count.
|
void |
setMinimumSeats(long seats)
Sets the minimum seating count.
|
void |
setNumber(java.lang.String number)
Sets the course number.
|
void |
setRequiresRegistration(boolean requiresRegistration)
Sets the requires registration flag.
|
void |
setScheduleInfo(java.lang.String scheduleInfo)
Sets the schedule information.
|
void |
setSponsors(Id[] sponsorIds)
Sets the sponsors.
|
void |
setTitle(java.lang.String title)
Sets the title.
|
void |
setURL(java.lang.String url)
Sets the url for a class web site.
|
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
Metadata getTitleMetadata()
mandatory
- This method must be implemented. void setTitle(java.lang.String title)
title
- the new titleInvalidArgumentException
- title
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- title
is
null
mandatory
- This method must be implemented. void clearTitle()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getNumberMetadata()
mandatory
- This method must be implemented. void setNumber(java.lang.String number)
number
- the new course numberInvalidArgumentException
- number
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- number
is
null
mandatory
- This method must be implemented. void clearNumber()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getInstructorsMetadata()
mandatory
- This method must be implemented. void setInstructors(Id[] resourceIds)
resourceIds
- the new instructorsInvalidArgumentException
- instructorIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- instructorIds
is
null
mandatory
- This method must be implemented. void clearInstructors()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getSponsorsMetadata()
mandatory
- This method must be implemented. void setSponsors(Id[] sponsorIds)
sponsorIds
- the new sponsorsInvalidArgumentException
- sponsorIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- sponsorIds
is
null
mandatory
- This method must be implemented. void clearSponsors()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCreditsMetadata()
mandatory
- This method must be implemented. void setCredits(Id[] gradeIds)
gradeIds
- the new credit levelsInvalidArgumentException
- gradeIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- gradeIds
is
null
mandatory
- This method must be implemented. void clearCredits()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getGradingOptionsMetadata()
mandatory
- This method must be implemented. void setGradingOptions(Id[] gradeSystemIds)
gradeSystemIds
- the new grading optionsInvalidArgumentException
- gradeSystemIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- gradeSystemIds
is null
mandatory
- This method must be implemented. void clearGradingOptions()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRequiresRegistrationMetadata()
mandatory
- This method must be implemented. void setRequiresRegistration(boolean requiresRegistration)
requiresRegistration
- the new registration flagInvalidArgumentException
- requiresRegistration
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearRequiresRegistration()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getMinimumSeatsMetadata()
mandatory
- This method must be implemented. void setMinimumSeats(long seats)
seats
- the new minimum seatsInvalidArgumentException
- seats
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearMinimumSeats()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getMaximumSeatsMetadata()
mandatory
- This method must be implemented. void setMaximumSeats(long seats)
seats
- the new maximum seatsInvalidArgumentException
- seats
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearMaximumSeats()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getURLMetadata()
mandatory
- This method must be implemented. void setURL(java.lang.String url)
url
- the new urlInvalidArgumentException
- url
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- url
is
null
mandatory
- This method must be implemented. void clearURL()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getScheduleInfoMetadata()
mandatory
- This method must be implemented. void setScheduleInfo(java.lang.String scheduleInfo)
scheduleInfo
- the new schedule infoInvalidArgumentException
- scheduleInfo
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- scheduleInfo
is
null
mandatory
- This method must be implemented. void clearScheduleInfo()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getEventMetadata()
mandatory
- This method must be implemented. void setEvent(Id eventId)
eventId
- the new eventInvalidArgumentException
- eventId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- eventId
is
null
mandatory
- This method must be implemented. void clearEvent()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. CourseOfferingFormRecord getCourseOfferingFormRecord(Type courseOfferingRecordType) throws OperationFailedException
CourseOfferingFormRecord
corresponding to the
given course offering record Type.
courseOfferingRecordType
- a course offering record typeNullArgumentException
- courseOfferingRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(courseOfferingRecordType)
is
false
mandatory
- This method must be implemented.