public interface RequestForm extends OsidRelationshipForm
This is the form for creating and updating Requests.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
RequestAdminSession.
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 |
clearPool()
Removes the pool.
|
void |
clearPosition()
Removes the position.
|
void |
clearRequestedProvisionables()
Removes the requested provisionable.
|
Metadata |
getPoolMetadata()
Gets the metadata for the pool.
|
Metadata |
getPositionMetadata()
Gets the metadata for the posiiton.
|
Metadata |
getRequestedProvisionablesMetadata()
Gets the metadata for the requested provisionable.
|
RequestFormRecord |
getRequestFormRecord(Type requestRecordType)
Gets the
RequestFormRecord corresponding to the given
request record Type. |
void |
setPool(Id poolId)
Sets the pool.
|
void |
setPosition(long position)
Sets the position.
|
void |
setRequestedProvisionables(IdList provisionableIds)
Sets the requested provisionables.
|
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 getPoolMetadata()
mandatory
- This method must be implemented. void setPool(Id poolId)
poolId
- the new poolInvalidArgumentException
- poolId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearPool()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getRequestedProvisionablesMetadata()
mandatory
- This method must be implemented. void setRequestedProvisionables(IdList provisionableIds)
provisionableIds
- the new requested provisionablesInvalidArgumentException
- a provisionableId
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearRequestedProvisionables()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getPositionMetadata()
mandatory
- This method must be implemented. void setPosition(long position)
position
- the new positionInvalidArgumentException
- position
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearPosition()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. RequestFormRecord getRequestFormRecord(Type requestRecordType) throws OperationFailedException
RequestFormRecord
corresponding to the given
request record Type.
requestRecordType
- a request record typeNullArgumentException
- requestRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(requestRecordType)
is false
mandatory
- This method must be implemented.