org.osid

Interface OsidObjectForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, 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, 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, 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, OsidCatalogForm, OsidCompendiumForm, OsidConstrainerForm, OsidEnablerForm, OsidGovernatorForm, OsidProcessorForm, OsidRelationshipForm, OsidRuleForm, 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, 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, UtilityBatchForm, UtilityForm, ValueBatchForm, ValueEnablerForm, ValueEnablerFormRecord, ValueForm, VaultBatchForm, VaultForm, VoteBatchForm, VoteForm, VoterAllocationForm, WarehouseForm, WorkBatchForm, WorkBatchForm, WorkForm, WorkForm

public interface OsidObjectForm
extends OsidIdentifiableForm, OsidExtensibleForm, OsidBrowsableForm

The OsidObjectForm is used to create and update OsidObjects. The form is not an OsidObject but merely a container for data to be sent to an update or create method of a session. A provider may or may not combine the OsidObject and OsidObjectForm interfaces into a single object.

Generally, a set method parallels each get method of an OsidObject. Additionally, Metadata may be examined for each data element to assist in understanding particular rules concerning acceptable data.

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.

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
void	clearDescription() Clears the description.
void	clearDisplayName() Clears the display name.
void	clearGenusType() Clears the genus type.
Metadata	getDescriptionMetadata() Gets the metadata for a description.
Metadata	getDisplayNameMetadata() Gets the metadata for a display name.
Metadata	getGenusTypeMetadata() Gets the metadata for a genus type.
void	setDescription(java.lang.String description) Sets a description.
void	setDisplayName(java.lang.String displayName) Sets a display name.
void	setGenusType(Type genusType) Sets a genus.

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getDisplayNameMetadata

Metadata getDisplayNameMetadata()

Gets the metadata for a display name.

Returns:

metadata for the display name

Compliance:

mandatory - This method must be implemented.

setDisplayName

void setDisplayName(java.lang.String displayName)

Sets a display name. A display name is required and if not set, will be set by the provider.

Parameters:

displayName - the new display name

Throws:

InvalidArgumentException - displayName is invalid

NoAccessException - Metadata.isReadonly() is true

NullArgumentException - displayName is null

Compliance:

mandatory - This method must be implemented.

clearDisplayName

void clearDisplayName()

Clears the display name.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getDescriptionMetadata

Metadata getDescriptionMetadata()

Gets the metadata for a description.

Returns:

metadata for the description

Compliance:

mandatory - This method must be implemented.

setDescription

void setDescription(java.lang.String description)

Sets a description.

Parameters:

description - the new description

Throws:

InvalidArgumentException - description is invalid

NoAccessException - Metadata.isReadonly() is true

NullArgumentException - description is null

Compliance:

mandatory - This method must be implemented.

clearDescription

void clearDescription()

Clears the description.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getGenusTypeMetadata

Metadata getGenusTypeMetadata()

Gets the metadata for a genus type.

Returns:

metadata for the genus

Compliance:

mandatory - This method must be implemented.

setGenusType

void setGenusType(Type genusType)

Sets a genus. A genus cannot be cleared because all objects have at minimum a root genus.

Parameters:

genusType - the new genus

Throws:

InvalidArgumentException - genusType is invalid

NoAccessException - Metadata.isReadonly() is true

NullArgumentException - genusType is null

Compliance:

mandatory - This method must be implemented.

clearGenusType

void clearGenusType()

Clears the genus type.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.