public interface OfferingForm extends OsidRelationshipForm
This is the form for creating and updating Offering
objects. Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
OfferingAdminSession.
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 |
clearCode()
Clears the code.
|
void |
clearResultOptions()
Removes the grading options.
|
void |
clearSponsors()
Removes the sponsors.
|
void |
clearTitle()
Clears the title.
|
Metadata |
getCodeMetadata()
Gets the metadata for a given name.
|
OfferingFormRecord |
getOfferingFormRecord(Type offeringRecordType)
Gets the
OfferingFormRecord interface corresponding to
the given offering record Type. |
Metadata |
getResultOptionsMetadata()
Gets the metadata for the grading options.
|
Metadata |
getSponsorsMetadata()
Gets the metadata for the sponsors.
|
Metadata |
getTitleMetadata()
Gets the metadata for a title.
|
void |
setCode(java.lang.String code)
Sets the code.
|
void |
setResultOptions(Id[] gradeSystemIds)
Sets the grading options.
|
void |
setSponsors(Id[] sponsorIds)
Sets the sponsors.
|
void |
setTitle(java.lang.String title)
Sets the title.
|
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 titleInvalidArgumentException
- title
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- title
is nullmandatory
- This method must be implemented. void clearTitle()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCodeMetadata()
mandatory
- This method must be implemented. void setCode(java.lang.String code)
code
- the codeInvalidArgumentException
- code
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- code
is nullmandatory
- This method must be implemented. void clearCode()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getResultOptionsMetadata()
mandatory
- This method must be implemented. void setResultOptions(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 clearResultOptions()
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. OfferingFormRecord getOfferingFormRecord(Type offeringRecordType) throws OperationFailedException
OfferingFormRecord
interface corresponding to
the given offering record Type.
offeringRecordType
- the offering record typeNullArgumentException
- offeringRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(offeringRecordType)
is false
mandatory
- This method must be implemented.