org.osid

Interface OsidForm

All Superinterfaces:

Identifiable, Suppliable

All Known Subinterfaces:

AcademyBatchForm, AcademyForm, AccountBatchForm, AccountForm, ActionBatchForm, ActionEnablerForm, ActionEnablerFormRecord, ActionForm, ActionGroupBatchForm, ActionGroupForm, ActivityBatchForm, ActivityBatchForm, ActivityBatchForm, ActivityBundleBatchForm, ActivityBundleForm, ActivityForm, ActivityForm, ActivityForm, ActivityRegistrationBatchForm, ActivityRegistrationForm, ActivityUnitBatchForm, ActivityUnitForm, AddressBatchForm, AddressBookBatchForm, AddressBookForm, AddressForm, AgencyBatchForm, AgencyForm, AgendaForm, AgentBatchForm, AgentForm, AllocationForm, AnswerBatchForm, AnswerForm, AntimatroidForm, AppointmentBatchForm, AppointmentForm, AssessmentBatchForm, AssessmentEntryBatchForm, AssessmentEntryForm, AssessmentForm, AssessmentOfferedBatchForm, AssessmentOfferedForm, AssessmentPartForm, AssessmentRequirementForm, AssessmentTakenBatchForm, AssessmentTakenForm, AssetBatchForm, AssetContentForm, AssetForm, AuctionBatchForm, AuctionConstrainerEnablerForm, AuctionConstrainerEnablerFormRecord, AuctionConstrainerForm, AuctionConstrainerFormRecord, AuctionForm, AuctionHouseBatchForm, AuctionHouseForm, AuctionProcessorEnablerForm, AuctionProcessorEnablerFormRecord, AuctionProcessorForm, AuctionProcessorFormRecord, AuditBatchForm, AuditEnablerForm, AuditEnablerFormRecord, AuditForm, AuthorizationBatchForm, AuthorizationEnablerForm, AuthorizationEnablerFormRecord, AuthorizationForm, AvailabilityBatchForm, AvailabilityEnablerForm, AvailabilityForm, AwardBatchForm, AwardEntryBatchForm, AwardEntryForm, AwardForm, AwardRequirementForm, BallotBatchForm, BallotConstrainerEnablerForm, BallotConstrainerEnablerFormRecord, BallotConstrainerForm, BallotConstrainerFormRecord, BallotForm, BankBatchForm, BankForm, BidBatchForm, BidForm, BillingBatchForm, BillingForm, BinBatchForm, BinForm, BlockBatchForm, BlockForm, BlogBatchForm, BlogForm, BookBatchForm, BookForm, BranchBatchForm, BranchForm, BrokerBatchForm, BrokerConstrainerEnablerForm, BrokerConstrainerEnablerFormRecord, BrokerConstrainerForm, BrokerConstrainerFormRecord, BrokerForm, BrokerProcessorEnablerForm, BrokerProcessorEnablerFormRecord, BrokerProcessorForm, BrokerProcessorFormRecord, BudgetBatchForm, BudgetEntryBatchForm, BudgetEntryForm, BudgetForm, BuildingBatchForm, BuildingForm, BusinessBatchForm, BusinessBatchForm, BusinessForm, BusinessForm, CalendarBatchForm, CalendarForm, CampusBatchForm, CampusForm, CandidateBatchForm, CandidateForm, CanonicalUnitBatchForm, CanonicalUnitEnablerForm, CanonicalUnitEnablerFormRecord, CanonicalUnitForm, CanonicalUnitProcessorEnablerForm, CanonicalUnitProcessorEnablerFormRecord, CanonicalUnitProcessorForm, CanonicalUnitProcessorFormRecord, CatalogEnablerForm, CatalogEnablerFormRecord, CatalogForm, CatalogueBatchForm, CatalogueForm, CategoryBatchForm, CategoryForm, ChainForm, CheckForm, ChecklistBatchForm, ChecklistForm, CommentBatchForm, CommentForm, CommissionBatchForm, CommissionEnablerForm, CommissionForm, CommitmentBatchForm, CommitmentEnablerForm, CommitmentEnablerFormRecord, CommitmentForm, CompetencyBatchForm, CompetencyForm, CompositionBatchForm, CompositionEnablerForm, CompositionEnablerFormRecord, CompositionForm, ConferralBatchForm, ConferralForm, ConfigurationBatchForm, ConfigurationForm, ContactBatchForm, ContactEnablerForm, ContactEnablerFormRecord, ContactForm, ControllerBatchForm, ControllerForm, ConvocationBatchForm, ConvocationForm, CookbookBatchForm, CookbookForm, CourseBatchForm, CourseCatalogBatchForm, CourseCatalogForm, CourseEntryBatchForm, CourseEntryForm, CourseForm, CourseOfferingBatchForm, CourseOfferingForm, CourseRequirementForm, CredentialBatchForm, CredentialEntryBatchForm, CredentialEntryForm, CredentialForm, CredentialRequirementForm, CreditBatchForm, CreditForm, CustomerBatchForm, CustomerForm, CyclicEventBatchForm, CyclicEventForm, CyclicTimePeriodBatchForm, CyclicTimePeriodForm, DeedBatchForm, DeedForm, DemographicEnablerForm, DemographicEnablerFormRecord, DemographicForm, DemographicFormRecord, DepotBatchForm, DepotForm, DeviceBatchForm, DeviceEnablerForm, DeviceEnablerFormRecord, DeviceForm, DictionaryBatchForm, DictionaryForm, DirectionBatchForm, DirectionForm, DirectoryEntryForm, DirectoryForm, DispatchBatchForm, DispatchForm, DistributorBatchForm, DistributorForm, DocetBatchForm, DocetForm, EdgeBatchForm, EdgeEnablerForm, EdgeEnablerFormRecord, EdgeForm, EffortBatchForm, EffortForm, EngineForm, EngineForm, EnrollmentBatchForm, EnrollmentForm, EntryBatchForm, EntryBatchForm, EntryBatchForm, EntryBatchForm, EntryForm, EntryForm, EntryForm, EntryForm, EventBatchForm, EventForm, FamilyBatchForm, FamilyForm, FileForm, FiscalPeriodBatchForm, FiscalPeriodForm, FloorBatchForm, FloorForm, ForumBatchForm, ForumForm, FoundryBatchForm, FoundryForm, FrontOfficeBatchForm, FrontOfficeForm, FunctionBatchForm, FunctionForm, GradeBatchForm, GradebookBatchForm, GradebookColumnBatchForm, GradebookColumnCalculationForm, GradebookColumnForm, GradebookForm, GradeEntryBatchForm, GradeEntryForm, GradeForm, GradeSystemBatchForm, GradeSystemForm, GradeSystemTransformForm, GraphBatchForm, GraphForm, HierarchyForm, HoldBatchForm, HoldEnablerForm, HoldEnablerFormRecord, HoldForm, IdBatchForm, IdForm, IngredientBatchForm, IngredientForm, InputBatchForm, InputEnablerForm, InputEnablerFormRecord, InputForm, InquestBatchForm, InquestForm, InquiryBatchForm, InquiryEnablerForm, InquiryEnablerFormRecord, InquiryForm, InstallationContentForm, InstructionForm, IntersectionBatchForm, IntersectionForm, InventoryBatchForm, InventoryForm, IssueBatchForm, IssueBatchForm, IssueForm, IssueForm, ItemBatchForm, ItemBatchForm, ItemBatchForm, ItemBatchForm, ItemForm, ItemForm, ItemForm, ItemForm, JobBatchForm, JobConstrainerEnablerForm, JobConstrainerForm, JobForm, JobProcessorEnablerForm, JobProcessorForm, JournalBatchForm, JournalEntryBatchForm, JournalEntryForm, JournalForm, KeyBatchForm, KeyForm, LearningObjectiveRequirementForm, LeaseBatchForm, LeaseForm, LessonForm, LocationBatchForm, LocationForm, LogBatchForm, LogEntryBatchForm, LogEntryForm, LogEntryForm, LogForm, MailboxBatchForm, MailboxForm, MapBatchForm, MapForm, MessageBatchForm, MessageForm, MeterBatchForm, MeterForm, ModelBatchForm, ModelForm, ModuleBatchForm, ModuleForm, NodeBatchForm, NodeForm, ObjectiveBankBatchForm, ObjectiveBankForm, ObjectiveBatchForm, ObjectiveForm, ObstacleBatchForm, ObstacleEnablerForm, ObstacleEnablerFormRecord, ObstacleForm, OfferingBatchForm, OfferingConstrainerEnablerForm, OfferingConstrainerEnablerFormRecord, OfferingConstrainerForm, OfferingConstrainerFormRecord, OfferingForm, OfficeBatchForm, OfficeForm, OffsetEventBatchForm, OffsetEventEnablerForm, OffsetEventEnablerFormRecord, OffsetEventForm, OntologyBatchForm, OntologyForm, OrderBatchForm, OrderForm, OrganizationBatchForm, OrganizationForm, OsidAggregateableForm, OsidBrowsableForm, OsidCapsuleForm, OsidCatalogForm, OsidCompendiumForm, OsidConstrainerForm, OsidContainableForm, OsidEnablerForm, OsidExtensibleForm, OsidFederateableForm, OsidGovernatorForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidProcessorForm, OsidRelationshipForm, OsidRuleForm, OsidSourceableForm, OsidSubjugateableForm, OsidTemporalForm, OublietteBatchForm, OublietteForm, PackageBatchForm, PackageForm, ParameterBatchForm, ParameterForm, ParameterProcessorEnablerForm, ParameterProcessorEnablerFormRecord, ParameterProcessorForm, ParameterProcessorFormRecord, ParticipantBatchForm, ParticipantForm, PathBatchForm, PathForm, PathForm, PayerBatchForm, PayerForm, PaymentBatchForm, PaymentForm, PeriodBatchForm, PeriodForm, PersonBatchForm, PersonForm, PlanForm, PollsBatchForm, PollsForm, PoolBatchForm, PoolConstrainerEnablerForm, PoolConstrainerEnablerFormRecord, PoolConstrainerForm, PoolConstrainerFormRecord, PoolForm, PoolProcessorEnablerForm, PoolProcessorEnablerFormRecord, PoolProcessorForm, PoolProcessorFormRecord, PositionBatchForm, PositionForm, PostBatchForm, PostBatchForm, PostEntryBatchForm, PostEntryForm, PostForm, PostForm, PriceBatchForm, PriceEnablerForm, PriceEnablerFormRecord, PriceForm, PriceScheduleBatchForm, PriceScheduleForm, ProcedureBatchForm, ProcedureForm, ProcessBatchForm, ProcessEnablerForm, ProcessEnablerFormRecord, ProcessForm, ProcessForm, ProductBatchForm, ProductForm, ProficiencyBatchForm, ProficiencyForm, ProfileBatchForm, ProfileEntryBatchForm, ProfileEntryEnablerForm, ProfileEntryEnablerFormRecord, ProfileEntryForm, ProfileForm, ProfileItemBatchForm, ProfileItemForm, ProgramBatchForm, ProgramEntryBatchForm, ProgramEntryForm, ProgramForm, ProgramOfferingBatchForm, ProgramOfferingForm, ProgramRequirementForm, ProjectBatchForm, ProjectForm, ProvisionableBatchForm, ProvisionableForm, ProvisionBatchForm, ProvisionForm, ProvisionReturnForm, PublisherBatchForm, PublisherForm, QualifierBatchForm, QualifierForm, QuestionBatchForm, QuestionForm, QueueBatchForm, QueueBatchForm, QueueConstrainerEnablerForm, QueueConstrainerEnablerForm, QueueConstrainerEnablerFormRecord, QueueConstrainerEnablerFormRecord, QueueConstrainerForm, QueueConstrainerForm, QueueConstrainerFormRecord, QueueConstrainerFormRecord, QueueForm, QueueForm, QueueProcessorEnablerForm, QueueProcessorEnablerForm, QueueProcessorEnablerFormRecord, QueueProcessorEnablerFormRecord, QueueProcessorForm, QueueProcessorForm, QueueProcessorFormRecord, QueueProcessorFormRecord, RaceBatchForm, RaceConstrainerEnablerForm, RaceConstrainerEnablerFormRecord, RaceConstrainerForm, RaceConstrainerFormRecord, RaceForm, RaceProcessorEnablerForm, RaceProcessorEnablerFormRecord, RaceProcessorForm, RaceProcessorFormRecord, RealmBatchForm, RealmForm, ReceiptBatchForm, ReceiptForm, RecipeBatchForm, RecipeForm, RecurringEventBatchForm, RecurringEventEnablerForm, RecurringEventEnablerFormRecord, RecurringEventForm, RegistrationBatchForm, RegistrationForm, RelationshipBatchForm, RelationshipEnablerForm, RelationshipEnablerFormRecord, RelationshipForm, RelevancyBatchForm, RelevancyEnablerForm, RelevancyEnablerFormRecord, RelevancyForm, RenovationBatchForm, RenovationForm, ReplyBatchForm, ReplyForm, RepositoryBatchForm, RepositoryForm, RequestBatchForm, RequestForm, RequestTransactionBatchForm, RequestTransactionForm, RequisiteForm, ResourceBatchForm, ResourceForm, ResourceRelationshipBatchForm, ResourceRelationshipForm, ResponseBatchForm, ResponseForm, ResponseForm, ResultBatchForm, ResultForm, RoomBatchForm, RoomForm, RouteForm, RouteSegmentForm, RuleForm, SceneBatchForm, SceneForm, ScheduleBatchForm, ScheduleForm, ScheduleSlotBatchForm, ScheduleSlotForm, SequenceRuleEnablerForm, SequenceRuleEnablerFormRecord, SequenceRuleForm, SettingBatchForm, SettingForm, ShipmentBatchForm, ShipmentForm, SignalBatchForm, SignalEnablerForm, SignalEnablerFormRecord, SignalForm, SpeedZoneBatchForm, SpeedZoneEnablerForm, SpeedZoneEnablerFormRecord, SpeedZoneForm, StateForm, StepBatchForm, StepConstrainerEnablerForm, StepConstrainerEnablerFormRecord, StepConstrainerForm, StepConstrainerFormRecord, StepForm, StepProcessorEnablerForm, StepProcessorEnablerFormRecord, StepProcessorForm, StepProcessorFormRecord, StockBatchForm, StockForm, StoreBatchForm, StoreForm, SubjectBatchForm, SubjectForm, SubscriptionBatchForm, SubscriptionEnablerForm, SubscriptionEnablerFormRecord, SubscriptionForm, SupersedingEventEnablerForm, SupersedingEventEnablerFormRecord, SupersedingEventForm, SyllabusBatchForm, SyllabusForm, SystemBatchForm, SystemForm, TermBatchForm, TermForm, TimePeriodBatchForm, TimePeriodForm, TodoBatchForm, TodoForm, TodoProducerForm, TodoProducerFormRecord, TriggerBatchForm, TriggerEnablerForm, TriggerEnablerFormRecord, TriggerForm, TypeForm, UtilityBatchForm, UtilityForm, ValueBatchForm, ValueEnablerForm, ValueEnablerFormRecord, ValueForm, VaultBatchForm, VaultForm, VoteBatchForm, VoteForm, VoterAllocationForm, WarehouseForm, WorkBatchForm, WorkBatchForm, WorkForm, WorkForm

public interface OsidForm
extends Identifiable, Suppliable

The OsidForm is the vehicle used to create and update objects. The form is a container for data to be sent to an update or create method of a session. Applications should persist their own data until a form is successfully submitted in an update or create transaction.

The form may provide some feedback as to the validity of certain data updates before the update transaction is issued to the correspodning session but a successful modification of the form is not a guarantee of success for the update transaction. A consumer may elect to perform all updates within a single update transaction or break up a large update intio smaller units. The tradeoff is the granularity of error feedback vs. the performance gain of a single transaction.

OsidForms are Identifiable. The Id of the OsidForm is used to uniquely identify the update or create transaction and not that of the object being updated. Currently, it is not necessary to have these Ids persisted.

As with all aspects of the OSIDs, nulls cannot be used. Methods to clear values are also defined in the form.

A new OsidForm should be acquired for each transaction upon an OsidObject. Forms should not be reused from one object to another even if the supplied data is the same as the forms may encapsulate data specific to the object requested. Example of changing a display name and a color defined in a color interface extension:

       
       
       ObjectForm form = session.getObjectFormForUpdate(objectId);
       form.setDisplayName("new name");
       ColorForm recordForm = form.getFormRecord(colorRecordType);
       recordForm.setColor("green");
       session.updateObject(objectId, form);
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Locale	getDefaultLocale() Gets a default locale for DisplayTexts when a locale is not specified.
Metadata[]	getInvalidMetadata() Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata() Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales() Gets a list of locales for available DisplayText translations that can be performed using this form.
DisplayText[]	getValidationMessages() Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate() Tests if this form is for an update operation.
boolean	isValid() Tests if ths form is in a valid state for submission.
void	setJournalComment(java.lang.String comment) Sets a comment.
void	setLocale(Type languageType, Type scriptType) Specifies a language and script type for DisplayText fields in this form.

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

isForUpdate

boolean isForUpdate()

Tests if this form is for an update operation.

Returns:

true if this form is for an update operation, false if for a create operation

Compliance:

mandatory - This method must be implemented.

getDefaultLocale

Locale getDefaultLocale()

Gets a default locale for DisplayTexts when a locale is not specified.

Returns:

the default locale

Compliance:

mandatory - This method must be implemented.

getLocales

LocaleList getLocales()

Gets a list of locales for available DisplayText translations that can be performed using this form.

Returns:

a list of available locales or an empty list if no translation operations are available

Compliance:

mandatory - This method must be implemented.

setLocale

void setLocale(Type languageType,
             Type scriptType)

Specifies a language and script type for DisplayText fields in this form. Setting a locale to something other than the default locale may affect the Metadata in this form. If multiple locales are available for managing translations, the Metadata indicates the fields are unset as they may be returning a defeult value based on the default locale.

Parameters:

languageType - the language type

scriptType - the script type

Throws:

NullArgumentException - languageType or scriptType is null

UnsupportedException - languageType and scriptType not available from getLocales()

Compliance:

mandatory - This method must be implemented.

getJournalCommentMetadata

Metadata getJournalCommentMetadata()

Gets the metadata for the comment corresponding to this form submission. The comment is used for describing the nature of the change to the corresponding object for the purposes of logging and auditing.

Returns:

metadata for the comment

Compliance:

mandatory - This method must be implemented.

setJournalComment

void setJournalComment(java.lang.String comment)

Sets a comment.

Parameters:

comment - the new comment

Throws:

InvalidArgumentException - comment is invalid

NoAccessException - Metadata.isReadonly() is true

NullArgumentException - comment is null

Compliance:

mandatory - This method must be implemented.

isValid

boolean isValid()
                throws OperationFailedException

Tests if ths form is in a valid state for submission. A form is valid if all required data has been supplied compliant with any constraints.

Returns:

false if there is a known error in this form, true otherwise

Throws:

OperationFailedException - attempt to perform validation failed

Compliance:

mandatory - This method must be implemented.

getValidationMessages

DisplayText[] getValidationMessages()

Gets text messages corresponding to additional instructions to pass form validation.

Returns:

a list of messages

Compliance:

mandatory - This method must be implemented.

getInvalidMetadata

Metadata[] getInvalidMetadata()

Gets a list of metadata for the elements in this form which are not valid.

Returns:

invalid metadata

Compliance:

mandatory - This method must be implemented.