public interface ProjectForm extends OsidObjectForm, OsidTemporalForm
This is the form for creating and updating Projects.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
ProjectAdminSession.
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 |
clearCost()
Clears the cost.
|
Metadata |
getCostMetadata()
Gets the metadata for the cost.
|
ProjectFormRecord |
getProjectFormRecord(Type projectRecordType)
Gets the
ProjectFormRecord corresponding to the given
project record Type. |
void |
setCost(Currency cost)
Sets the cost.
|
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 getCostMetadata()
mandatory
- This method must be implemented. void setCost(Currency cost)
cost
- the new costInvalidArgumentException
- cost
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- cost
is
null
mandatory
- This method must be implemented. void clearCost()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ProjectFormRecord getProjectFormRecord(Type projectRecordType) throws OperationFailedException
ProjectFormRecord
corresponding to the given
project record Type.
projectRecordType
- the project record typeNullArgumentException
- projectRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(projectRecordType)
is false
mandatory
- This method must be implemented.