public interface RouteForm extends OsidRelationshipForm, OsidAggregateableForm
This is the form for creating and updating Routes. Like
all OsidForm objects, various data elements may be set here
for use in the create and update methods in the RouteAdminSession.
For each data element that may be set, metadata may be examined to
provide display hints or data constraints. Some data may be automatically
derived from the route segments.
| Modifier and Type | Method and Description |
|---|---|
RouteFormRecord |
getRouteFormRecord(Type routeRecordType)
Gets the
RouteFormRecord corresponding to the given
route record Type. |
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusTypegetRequiredRecordTypesgetRecordTypes, hasRecordTypegetDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocalegetId, isCurrentclearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDateRouteFormRecord getRouteFormRecord(Type routeRecordType) throws OperationFailedException
RouteFormRecord corresponding to the given
route record Type. routeRecordType - a route record typeNullArgumentException - routeRecordType
is null OperationFailedException - unable to complete requestUnsupportedException -
hasRecordType(routeRecordType) is false mandatory - This method must be implemented.