public interface CredentialRequirementForm extends OsidRuleForm, OsidAggregateableForm
This is the form for creating and updating
CredentialRequirements.
Like all OsidForm
objects,
various data elements may be set here for use in the create and update
methods in the RequisiteAdminSession.
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 |
clearTimeframe()
Clears the timeframe.
|
CredentialRequirementFormRecord |
getCredentialRequirementFormRecord(Type credentialRequirementRecordType)
Gets the
CredentialRequirementFormRecord corresponding
to the given credential requirement record Type. |
Metadata |
getTimeframeMetadata()
Gets the metadata for the timeframe.
|
void |
setTimeframe(Duration duration)
Sets the timeframe.
|
clearRule, getRuleMetadata, setRule
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
Metadata getTimeframeMetadata()
mandatory
- This method must be implemented. void setTimeframe(Duration duration)
duration
- the new durationInvalidArgumentException
- duration
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- duration
is
null
mandatory
- This method must be implemented. void clearTimeframe()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. CredentialRequirementFormRecord getCredentialRequirementFormRecord(Type credentialRequirementRecordType) throws OperationFailedException
CredentialRequirementFormRecord
corresponding
to the given credential requirement record Type.
credentialRequirementRecordType
- a credential requirement
record typeNullArgumentException
-
credentialRequirementRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(credentialRequirementRecordType)
is
false
mandatory
- This method must be implemented.