OSID Logo
OSID Specifications
osid package
Version 3.1.0
Interfaceosid.Metadata
Used Byosid.OsidCompendiumForm
osid.OsidContainableForm
osid.OsidEffectuatorForm
osid.OsidEnablerForm
osid.OsidForm
osid.OsidObjectForm
osid.OsidOperableForm
osid.OsidRelationshipForm
osid.OsidRequestForm
osid.OsidRuleApplicatorForm
show 226 more…
osid.OsidRuleForm
osid.OsidSourceableForm
osid.OsidTemporalForm
osid.acknowledgement.batch.BillingBatchForm
osid.assessment.AssessmentForm
osid.assessment.AssessmentOfferedForm
osid.assessment.AssessmentTakenForm
osid.assessment.ItemForm
osid.assessment.authoring.AssessmentPartForm
osid.assessment.authoring.SequenceRuleForm
osid.assessment.batch.BankBatchForm
osid.authentication.batch.AgencyBatchForm
osid.authorization.FunctionForm
osid.authorization.batch.QualifierBatchForm
osid.authorization.batch.VaultBatchForm
osid.bidding.AuctionForm
osid.bidding.BidForm
osid.bidding.batch.AuctionHouseBatchForm
osid.billing.CustomerForm
osid.billing.EntryForm
osid.billing.ItemForm
osid.billing.PeriodForm
osid.billing.batch.BusinessBatchForm
osid.billing.payment.PayerForm
osid.billing.payment.PaymentForm
osid.blogging.EntryForm
osid.blogging.batch.BlogBatchForm
osid.calendaring.EventForm
osid.calendaring.OffsetEventForm
osid.calendaring.RecurringEventForm
osid.calendaring.ScheduleForm
osid.calendaring.ScheduleSlotForm
osid.calendaring.SupersedingEventForm
osid.calendaring.TimePeriodForm
osid.calendaring.batch.CalendarBatchForm
osid.checklist.TodoForm
osid.checklist.batch.ChecklistBatchForm
osid.checklist.batch.TodoBatchForm
osid.checklist.mason.TodoProducerForm
osid.commenting.CommentForm
osid.commenting.batch.BookBatchForm
osid.communication.ResponseForm
osid.configuration.ConfigurationForm
osid.configuration.ParameterForm
osid.configuration.ValueForm
osid.configuration.batch.ConfigurationBatchForm
osid.contact.AddressForm
osid.contact.ContactForm
osid.contact.batch.AddressBookBatchForm
osid.control.ActionForm
osid.control.ControllerForm
osid.control.SceneForm
osid.control.SettingForm
osid.control.TriggerForm
osid.course.ActivityForm
osid.course.ActivityUnitForm
osid.course.CourseForm
osid.course.CourseOfferingForm
osid.course.TermForm
osid.course.batch.CourseCatalogBatchForm
osid.course.batch.TermBatchForm
osid.course.chronicle.AssessmentEntryForm
osid.course.chronicle.AwardEntryForm
osid.course.chronicle.CourseEntryForm
osid.course.chronicle.CredentialEntryForm
osid.course.chronicle.ProgramEntryForm
osid.course.plan.LessonForm
osid.course.plan.PlanForm
osid.course.program.CredentialForm
osid.course.program.EnrollmentForm
osid.course.program.ProgramForm
osid.course.program.ProgramOfferingForm
osid.course.registration.RegistrationForm
osid.course.registration.RegistrationTargetForm
osid.course.registration.request.RegistrationRequestItemForm
osid.course.requisite.AssessmentRequirementForm
osid.course.requisite.AwardRequirementForm
osid.course.requisite.CourseRequirementForm
osid.course.requisite.CredentialRequirementForm
osid.course.requisite.LearningObjectiveRequirementForm
osid.course.requisite.ProgramRequirementForm
osid.course.syllabus.DocetForm
osid.dictionary.EntryForm
osid.dictionary.batch.DictionaryBatchForm
osid.filing.DirectoryEntryForm
osid.filing.allocation.AllocationForm
osid.financials.AccountForm
osid.financials.ActivityForm
osid.financials.FiscalPeriodForm
osid.financials.batch.AccountBatchForm
osid.financials.batch.ActivityBatchForm
osid.financials.batch.BusinessBatchForm
osid.financials.budgeting.BudgetEntryForm
osid.financials.posting.PostEntryForm
osid.financials.posting.PostForm
osid.forum.PostForm
osid.forum.ReplyForm
osid.forum.batch.ForumBatchForm
osid.grading.GradeEntryForm
osid.grading.GradeForm
osid.grading.GradeSystemForm
osid.grading.GradebookColumnForm
osid.grading.batch.GradebookBatchForm
osid.grading.calculation.GradebookColumnCalculationForm
osid.grading.transform.GradeSystemTransformForm
osid.hold.BlockForm
osid.hold.batch.OublietteBatchForm
osid.id.IdForm
osid.inquiry.InquiryForm
osid.inquiry.ResponseForm
osid.inquiry.batch.InquestBatchForm
osid.installation.InstallationContentForm
osid.installation.InstallationPackageForm
osid.installation.batch.DepotBatchForm
osid.inventory.InventoryForm
osid.inventory.ItemForm
osid.inventory.ModelForm
osid.inventory.StockForm
osid.inventory.batch.InventoryBatchForm
osid.inventory.shipment.EntryForm
osid.inventory.shipment.ShipmentForm
osid.journaling.batch.JournalBatchForm
osid.learning.ActivityForm
osid.learning.ObjectiveForm
osid.learning.ProficiencyForm
osid.learning.batch.ObjectiveBankBatchForm
osid.learning.batch.ObjectiveBatchForm
osid.lexicon.IdiomForm
osid.lexicon.ParameterForm
osid.lexicon.batch.PressBatchForm
osid.logging.LogEntryForm
osid.logging.batch.LogBatchForm
osid.mapping.LocationForm
osid.mapping.batch.LocationBatchForm
osid.mapping.batch.MapBatchForm
osid.mapping.path.ObstacleForm
osid.mapping.path.SignalForm
osid.mapping.path.SpeedZoneForm
osid.mapping.route.RouteSegmentForm
osid.messaging.MessageForm
osid.messaging.batch.MailboxBatchForm
osid.metering.batch.UtilityBatchForm
osid.offering.CanonicalUnitForm
osid.offering.OfferingForm
osid.offering.ParticipantForm
osid.offering.ResultForm
osid.offering.batch.CatalogueBatchForm
osid.offering.rules.OfferingConstrainerForm
osid.ontology.SubjectForm
osid.ontology.batch.OntologyBatchForm
osid.ontology.batch.SubjectBatchForm
osid.ordering.ItemForm
osid.ordering.OrderForm
osid.ordering.PriceForm
osid.ordering.ProductForm
osid.ordering.batch.StoreBatchForm
osid.ordering.rules.PriceEnablerForm
osid.personnel.AppointmentForm
osid.personnel.OrganizationForm
osid.personnel.PersonForm
osid.personnel.PositionForm
osid.personnel.batch.OrganizationBatchForm
osid.personnel.batch.RealmBatchForm
osid.profile.batch.ProfileBatchForm
osid.provisioning.BrokerForm
osid.provisioning.PoolForm
osid.provisioning.ProvisionForm
osid.provisioning.QueueForm
osid.provisioning.RequestForm
osid.provisioning.RequestTransactionForm
osid.provisioning.batch.DistributorBatchForm
osid.provisioning.rules.BrokerProcessorForm
osid.provisioning.rules.PoolProcessorForm
osid.provisioning.rules.QueueConstrainerForm
osid.provisioning.rules.QueueProcessorForm
osid.recipe.DirectionForm
osid.recipe.IngredientForm
osid.recipe.RecipeForm
osid.recipe.batch.CookbookBatchForm
osid.recognition.ConferralForm
osid.recognition.ConvocationForm
osid.recognition.batch.AcademyBatchForm
osid.relationship.batch.FamilyBatchForm
osid.repository.AssetContentForm
osid.repository.AssetForm
osid.repository.batch.CompositionBatchForm
osid.repository.batch.RepositoryBatchForm
osid.resource.ResourceForm
osid.resource.batch.BinBatchForm
osid.resource.batch.ResourceBatchForm
osid.resource.demographic.DemographicForm
osid.resourcing.AvailabilityForm
osid.resourcing.CommissionForm
osid.resourcing.EffortForm
osid.resourcing.JobForm
osid.resourcing.WorkForm
osid.resourcing.batch.FoundryBatchForm
osid.room.BuildingForm
osid.room.FloorForm
osid.room.RoomForm
osid.room.batch.CampusBatchForm
osid.room.construction.ProjectForm
osid.room.construction.RenovationForm
osid.rules.check.CheckForm
osid.rules.check.InstructionForm
osid.sequencing.ChainForm
osid.subscription.DispatchForm
osid.subscription.SubscriptionForm
osid.subscription.batch.PublisherBatchForm
osid.topology.EdgeForm
osid.topology.batch.GraphBatchForm
osid.tracking.IssueForm
osid.tracking.LogEntryForm
osid.tracking.QueueForm
osid.tracking.batch.FrontOfficeBatchForm
osid.type.TypeForm
osid.voting.BallotForm
osid.voting.CandidateForm
osid.voting.VoteForm
osid.voting.VoterAllocationForm
osid.voting.batch.PollsBatchForm
osid.voting.rules.RaceProcessorForm
osid.workflow.ProcessForm
osid.workflow.StepForm
osid.workflow.batch.OfficeBatchForm
osid.workflow.event.WorkflowEventForm
Description

The Metadata interface defines a set of methods describing a the syntax and rules for creating and updating a data element inside an OsidForm. Metadata provides the means to retrieve restrictions placed upon data elements such as sizes and ranges and help guide user input.

Example:

getElementLabel() = "primary color" // input label
getInstructions() = "Supply a primary color, I really need one."
getSyntax() = DISPLAYTEXT
isArray() = false                 // single value allowed
isRequired() = true               // not optional
isReadOnly() = false              // element can be updated
isLinked() = false                // no side effects
isValueKnown() = true             // known that no value exists
hasSuppliedValue() = false        // no value exists
getMinimumElements() = 1          // must have at least one value
getMaximumElements() = 1          // no more than one value
isEnumerated() = true             // value must be one of an enumerated set
getDisplayTextLanguageTypes() = { EN/US }
getDisplayTextScriptTypes() = { LATN }
getDisplayTextFormatTypes() = { plain }
isMultilineDisplayText() = false  // value must be on a single line
getMinimumStringLength() = 3      // no fewer than three characters
getMaximumStringLength() = 6      // no more than 6 characters
getStringMatchTypes() = {}
getDisplayTextSet() = { "red", "yellow", "blue" }  // enumerated list
getDefaultDisplayTextValues() = {} // no defaulting available
                

An application may display a one-line text input box sized up to 6 characters in English or it may display a drop-down menu with the enumerated values or it may use a radio box to select from the enumeration. Following a create transaction, the Metadata for update now has:

isValueKnown() = true                       // known that a value exists
hasSuppliedValue() = true                   // a value exists
getExistingDisplayTextValues() = { "red" }  // existing value
                
MethodgetElementId
Description

Gets a unique Id for the data element.

Returnosid.id.Id an Id
Compliancemandatory This method must be implemented.
MethodgetElementLabel
Description

Gets a display label for the data element.

Returnosid.locale.DisplayText a display label
Compliancemandatory This method must be implemented.
MethodgetInstructions
Description

Gets instructions for updating this element value. This is a human readable description of the data element or property that may include special instructions or caveats to the end-user above and beyond what this interface provides.

Returnosid.locale.DisplayText instructions
Compliancemandatory This method must be implemented.
MethodgetSyntax
Description

Gets the syntax of this data.

Returnosid.Syntax an enumeration indicating the type of value
Compliancemandatory This method must be implemented.
MethodisArray
Description

Tests if this data element is an array.

Returnboolean true if this data is an array, false if a single element
Compliancemandatory This method must be implemented.
MethodisRequired
Description

Tests if this data element is required to be supplied when creating new objects and cannot be cleared when updating objects. Elements that implement a fallback to default values are not required in this sense.

Returnboolean true if this element value is required, false otherwise
Compliancemandatory This method must be implemented.
MethodisReadOnly
Description

Tests if this data can be updated. This may indicate the result of a pre-authorization but is not a guarantee that an authorization failure will not occur when the create or update transaction is issued.

Returnboolean true if this data is not updatable, false otherwise
Compliancemandatory This method must be implemented.
MethodisLinked
Description

Tests if this data element is linked to other data in the object. Updating linked data elements should refresh all metadata and revalidate object elements.

Returnboolean true if this element is linked, false if updates have no side effect
Compliancemandatory This method must be implemented.
MethodisValueKnown
Description

Tests if an existing value is known for this data element. If it is known that a value does not exist, then this method returns true.

Returnboolean true if the element value is known, false if the element value is not known
Compliancemandatory This method must be implemented.
MethodhasValue
Description

Tests if this data element has a value.

Returnboolean true if this element has a value, false otherwise
ErrorsILLEGAL_STATE isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetUnits
Description

Gets the units of this data for display purposes ('lbs', 'gills', 'furlongs').

Returnosid.locale.DisplayText the display units of this data or an empty string if not applicable
Compliancemandatory This method must be implemented.
MethodgetMinimumElements
Description

In the case where an array or list of elements is specified in an OsidForm, this specifies the minimum number of elements that must be included.

Returncardinal the minimum elements or 1 if isArray() is false
Compliancemandatory This method must be implemented.
MethodgetMaximumElements
Description

In the case where an array or list of elements is specified in an OsidForm, this specifies the maximum number of elements that can be specified.

Returncardinal the maximum elements or 1 if isArray() is false
Compliancemandatory This method must be implemented.
MethodgetMinimumCardinal
Description

Gets the minimum cardinal value.

Returncardinal the minimum cardinal
ErrorsILLEGAL_STATE syntax is not a CARDINAL
Compliancemandatory This method must be implemented.
MethodgetMaximumCardinal
Description

Gets the maximum cardinal value.

Returncardinal the maximum cardinal
ErrorsILLEGAL_STATE syntax is not a CARDINAL
Compliancemandatory This method must be implemented.
MethodgetCardinalSet
Description

Gets the set of acceptable cardinal values.

Returncardinal[] a set of cardinals or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a CARDINAL or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultCardinalValues
Description

Gets the default cardinal values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returncardinal[] the default cardinal values
ErrorsILLEGAL_STATE syntax is not a CARDINAL
Compliancemandatory This method must be implemented.
MethodgetExistingCardinalValues
Description

Gets the existing cardinal values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returncardinal[] the existing cardinal values
ErrorsILLEGAL_STATE syntax is not a CARDINAL or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetCoordinateTypes
Description

Gets the set of acceptable coordinate types.

Returnosid.type.Type[] the set of coordinate types
ErrorsILLEGAL_STATE syntax is not a COORDINATE or SPATIALUNIT
Compliancemandatory This method must be implemented.
MethodsupportsCoordinateType
Description

Tests if the given coordinate type is supported.

Parametersosid.type.TypecoordinateType a coordinate Type
Returnboolean true if the type is supported, false otherwise
ErrorsILLEGAL_STATE syntax is not a COORDINATE
NULL_ARGUMENT coordinateType is null
Compliancemandatory This method must be implemented.
MethodgetAxesForCoordinateType
Description

Gets the number of axes for a given supported coordinate type.

Parametersosid.type.TypecoordinateType a coordinate Type
Returncardinal the number of axes
ErrorsILLEGAL_STATE syntax is not a COORDINATE
NULL_ARGUMENT coordinateType is null
UNSUPPORTED supportsCoordinateType(coordinateType) is false
Compliancemandatory This method must be implemented.
MethodgetMinimumCoordinateValues
Description

Gets the minimum coordinate values given supported coordinate type.

Parametersosid.type.TypecoordinateType a coordinate Type
Returndecimal[] the minimum coordinate values
ErrorsILLEGAL_STATE syntax is not a COORDINATE
NULL_ARGUMENT coordinateType is null
UNSUPPORTED supportsCoordinateType(coordinateType) is false
Compliancemandatory This method must be implemented.
MethodgetMaximumCoordinateValues
Description

Gets the maximum coordinate values given supported coordinate type.

Parametersosid.type.TypecoordinateType a coordinate Type
Returndecimal[] the maximum coordinate values
ErrorsILLEGAL_STATE syntax is not a COORDINATE
NULL_ARGUMENT coordinateType is null
UNSUPPORTED supportsCoordinateType(coordinateType) is false
Compliancemandatory This method must be implemented.
MethodgetCoordinateSet
Description

Gets the set of acceptable coordinate values.

Returnosid.mapping.Coordinate[] a set of coordinates or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a COORDINATE or isEnumerated() is false
UNSUPPORTED supportsCoordinateType(coordinateType) is false
Compliancemandatory This method must be implemented.
MethodgetDefaultCoordinateValues
Description

Gets the default coordinate values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returnosid.mapping.Coordinate[] the default coordinate values
ErrorsILLEGAL_STATE syntax is not a COORDINATE
Compliancemandatory This method must be implemented.
MethodgetExistingCoordinateValues
Description

Gets the existing coordinate values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returnosid.mapping.Coordinate[] the existing coordinate values
ErrorsILLEGAL_STATE syntax is not a COORDINATE or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetCurrencyTypes
Description

Gets the set of acceptable currency types.

Returnosid.type.Type[] the set of currency types
ErrorsILLEGAL_STATE syntax is not a CURRENCY
Compliancemandatory This method must be implemented.
MethodsupportsCurrencyType
Description

Tests if the given currency type is supported.

Parametersosid.type.TypecurrencyType a currency Type
Returnboolean true if the type is supported, false otherwise
ErrorsILLEGAL_STATE syntax is not a CURRENCY
NULL_ARGUMENT currencyType is null
Compliancemandatory This method must be implemented.
MethodgetMinimumCurrency
Description

Gets the minimum currency value.

Returnosid.financials.Currency the minimum currency
ErrorsILLEGAL_STATE syntax is not a CURRENCY
UNSUPPORTED supportsCurrencyType(currencyType) is false
Compliancemandatory This method must be implemented.
MethodgetMaximumCurrency
Description

Gets the maximum currency value.

Returnosid.financials.Currency the maximum currency
ErrorsILLEGAL_STATE syntax is not a CURRENCY
UNSUPPORTED supportsCurrencyType(currencyType) is false
Compliancemandatory This method must be implemented.
MethodgetCurrencySet
Description

Gets the set of acceptable currency values.

Returnosid.financials.Currency[] a set of currencies or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a CURRENCY or isEnumerated() is false
UNSUPPORTED supportsCurrencyType(currencyType) is false
Compliancemandatory This method must be implemented.
MethodgetDefaultCurrencyValues
Description

Gets the default currency values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returnosid.financials.Currency[] the default currency values
ErrorsILLEGAL_STATE syntax is not a CURRENCY
UNSUPPORTED supportsCurrencyType(currencyType) is false
Compliancemandatory This method must be implemented.
MethodgetExistingCurrencyValues
Description

Gets the existing currency values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returnosid.financials.Currency[] the existing currency values
ErrorsILLEGAL_STATE syntax is not a CURRENCY or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetDateTimeResolution
Description

Gets the smallest resolution of the date time value.

Returnosid.calendaring.DateTimeResolution the resolution
ErrorsILLEGAL_STATE syntax is not a DATETIME, DURATION, or TIME
Compliancemandatory This method must be implemented.
MethodgetCalendarTypes
Description

Gets the set of acceptable calendar types.

Returnosid.type.Type[] the set of calendar types
ErrorsILLEGAL_STATE syntax is not a DATETIME or DURATION
Compliancemandatory This method must be implemented.
MethodsupportsCalendarType
Description

Tests if the given calendar type is supported.

Parametersosid.type.TypecalendarType a calendar Type
Returnboolean true if the type is supported, false otherwise
ErrorsILLEGAL_STATE syntax is not a DATETIME or DURATION
NULL_ARGUMENT calendarType is null
Compliancemandatory This method must be implemented.
MethodgetTimeTypes
Description

Gets the set of acceptable time types.

Returnosid.type.Type[] a set of time types or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a DATETIME, DURATION, or TIME
Compliancemandatory This method must be implemented.
MethodsupportsTimeType
Description

Tests if the given time type is supported.

Parametersosid.type.TypetimeType a time Type
Returnboolean true if the type is supported, false otherwise
ErrorsILLEGAL_STATE syntax is not a DATETIME, DURATION, or TIME
NULL_ARGUMENT timeType is null
Compliancemandatory This method must be implemented.
MethodgetMinimumDateTime
Description

Gets the minimum date time value.

Returnosid.calendaring.DateTime the minimum value
ErrorsILLEGAL_STATE syntax is not a DATETIME
UNSUPPORTED supportsCalendarTimeType(calendarType, timeType) is false
Compliancemandatory This method must be implemented.
MethodgetMaximumDateTime
Description

Gets the maximum date time value.

Returnosid.calendaring.DateTime the maximum value
ErrorsILLEGAL_STATE syntax is not a DATETIME
UNSUPPORTED supportsCalendarTimeType(calendarType, timeType) is false
Compliancemandatory This method must be implemented.
MethodgetDateTimeSet
Description

Gets the set of acceptable date time values.

Returnosid.calendaring.DateTime[] a set of values or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a DATETIME or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultDateTimeValues
Description

Gets the default date time values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returnosid.calendaring.DateTime[] the default date time values
ErrorsILLEGAL_STATE syntax is not a DATETIME
Compliancemandatory This method must be implemented.
MethodgetExistingDateTimeValues
Description

Gets the existing date time values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returnosid.calendaring.DateTime[] the existing date time values
ErrorsILLEGAL_STATE syntax is not a DATETIME or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetDecimalScale
Description

Gets the number of digits to the right of the decimal point.

Returncardinal the scale
ErrorsILLEGAL_STATE syntax is not a DECIMAL
Compliancemandatory This method must be implemented.
MethodgetMinimumDecimal
Description

Gets the minimum decimal value.

Returndecimal the minimum decimal
ErrorsILLEGAL_STATE syntax is not a DECIMAL
Compliancemandatory This method must be implemented.
MethodgetMaximumDecimal
Description

Gets the maximum decimal value.

Returndecimal the maximum decimal
ErrorsILLEGAL_STATE syntax is not a DECIMAL
Compliancemandatory This method must be implemented.
MethodgetDecimalSet
Description

Gets the set of acceptable decimal values.

Returndecimal[] a set of decimals or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a DECIMAL or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultDecimalValues
Description

Gets the default decimal values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returndecimal[] the default decimal values
ErrorsILLEGAL_STATE syntax is not a DECIMAL
Compliancemandatory This method must be implemented.
MethodgetExistingDecimalValues
Description

Gets the existing decimal values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returndecimal[] the existing decimal values
ErrorsILLEGAL_STATE syntax is not a DECIMAL or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetDistanceResolution
Description

Gets the smallest resolution of the distance value.

Returnosid.mapping.DistanceResolution the resolution
ErrorsILLEGAL_STATE syntax is not a DISTANCE
Compliancemandatory This method must be implemented.
MethodgetMinimumDistance
Description

Gets the minimum distance value.

Returnosid.mapping.Distance the minimum value
ErrorsILLEGAL_STATE syntax is not a DISTANCE
Compliancemandatory This method must be implemented.
MethodgetMaximumDistance
Description

Gets the maximum distance value.

Returnosid.mapping.Distance the maximum value
ErrorsILLEGAL_STATE syntax is not a DISTANCE
Compliancemandatory This method must be implemented.
MethodgetDistanceSet
Description

Gets the set of acceptable distance values.

Returnosid.mapping.Distance[] a set of values or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a DECIMAL or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultDistanceValues
Description

Gets the default distance values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returnosid.mapping.Distance[] the default distance values
ErrorsILLEGAL_STATE syntax is not a DISTANCE
Compliancemandatory This method must be implemented.
MethodgetExistingDistanceValues
Description

Gets the existing distance values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returnosid.mapping.Distance[] the existing distance values
ErrorsILLEGAL_STATE syntax is not a DISTANCE or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetMinimumDuration
Description

Gets the minimum duration.

Returnosid.calendaring.Duration the minimum duration
ErrorsILLEGAL_STATE syntax is not a DURATION
Compliancemandatory This method must be implemented.
MethodgetMaximumDuration
Description

Gets the maximum duration.

Returnosid.calendaring.Duration the maximum duration
ErrorsILLEGAL_STATE syntax is not a DURATION
Compliancemandatory This method must be implemented.
MethodgetDurationSet
Description

Gets the set of acceptable duration values.

Returnosid.calendaring.Duration[] a set of durations or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a DURATION or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultDurationValues
Description

Gets the default duration values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most at most a single value.

Returnosid.calendaring.Duration[] the default duration values
ErrorsILLEGAL_STATE syntax is not a DURATION
Compliancemandatory This method must be implemented.
MethodgetExistingDurationValues
Description

Gets the existing duration values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returnosid.calendaring.Duration[] the existing duration values
ErrorsILLEGAL_STATE syntax is not a DURATION or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetHeadingTypes
Description

Gets the set of acceptable heading types.

Returnosid.type.Type[] a set of heading types or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a HEADING
Compliancemandatory This method must be implemented.
MethodsupportsHeadingType
Description

Tests if the given heading type is supported.

Parametersosid.type.TypeheadingType a heading Type
Returnboolean true if the type is supported, false otherwise
ErrorsILLEGAL_STATE syntax is not a HEADING
NULL_ARGUMENT headingType is null
Compliancemandatory This method must be implemented.
MethodgetAxesForHeadingType
Description

Gets the number of axes for a given supported heading type.

Parametersosid.type.TypeheadingType a heading Type
Returncardinal the number of axes
ErrorsILLEGAL_STATE syntax is not a HEADING
NULL_ARGUMENT headingType is null
UNSUPPORTED supportsHeadingType(headingType) is false
Compliancemandatory This method must be implemented.
MethodgetMinimumHeadingValues
Description

Gets the minimum heading values given supported heading type.

Parametersosid.type.TypeheadingType a heading Type
Returndecimal[] the minimum heading values
ErrorsILLEGAL_STATE syntax is not a HEADING
NULL_ARGUMENT headingType is null
UNSUPPORTED supportsHeadingType(headingType) is false
Compliancemandatory This method must be implemented.
MethodgetMaximumHeadingValues
Description

Gets the maximum heading values given supported heading type.

Parametersosid.type.TypeheadingType a heading Type
Returndecimal[] the maximum heading values
ErrorsILLEGAL_STATE syntax is not a HEADING
NULL_ARGUMENT headingType is null
UNSUPPORTED supportsHeadingType(headingType) is false
Compliancemandatory This method must be implemented.
MethodgetHeadingSet
Description

Gets the set of acceptable heading values.

Returnosid.mapping.Heading[] the set of heading
ErrorsILLEGAL_STATE syntax is not a HEADING or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultHeadingValues
Description

Gets the default heading values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returnosid.mapping.Heading[] the default heading values
ErrorsILLEGAL_STATE syntax is not a HEADING
Compliancemandatory This method must be implemented.
MethodgetExistingHeadingValues
Description

Gets the existing heading values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returnosid.mapping.Heading[] the existing heading values
ErrorsILLEGAL_STATE syntax is not a HEADING or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetIdSet
Description

Gets the set of acceptable Ids.

Returnosid.id.Id[] a set of Ids or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not an ID or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultIdValues
Description

Gets the default Id values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returnosid.id.Id[] the default Id values
ErrorsILLEGAL_STATE syntax is not an ID
Compliancemandatory This method must be implemented.
MethodgetExistingIdValues
Description

Gets the existing Id values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returnosid.id.Id[] the existing Id values
ErrorsILLEGAL_STATE syntax is not an ID
Compliancemandatory This method must be implemented.
MethodgetMinimumInteger
Description

Gets the minimum integer value.

Returninteger the minimum value
ErrorsILLEGAL_STATE syntax is not an INTEGER
Compliancemandatory This method must be implemented.
MethodgetMaximumInteger
Description

Gets the maximum integer value.

Returninteger the maximum value
ErrorsILLEGAL_STATE syntax is not an INTEGER
Compliancemandatory This method must be implemented.
MethodgetIntegerSet
Description

Gets the set of acceptable integer values.

Returninteger[] a set of values or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not an INTEGER or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultIntegerValues
Description

Gets the default integer values. These are the values used if the element value is not provided or is cleared. If isArray() is false then this method returns at most a single value.

Returninteger[] the default integer values
ErrorsILLEGAL_STATE syntax is not an INTEGER
Compliancemandatory This method must be implemented.
MethodgetExistingIntegerValues
Description

Gets the existing integer values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returninteger[] the existing integer values
ErrorsILLEGAL_STATE syntax is not a INTEGER or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetObjectTypes
Description

Gets the set of acceptable Types for an arbitrary object.

Returnosid.type.Type[] a set of Types or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not an OBJECT
Compliancemandatory This method must be implemented.
MethodsupportsObjectType
Description

Tests if the given object type is supported.

Parametersosid.type.TypeobjectType an object Type
Returnboolean true if the type is supported, false otherwise
ErrorsILLEGAL_STATE syntax is not an OBJECT
NULL_ARGUMENT objectType is null
Compliancemandatory This method must be implemented.
MethodgetObjectSet
Description

Gets the set of acceptable object values.

Returnobject[] a set of values or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not an OBJECT or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultObjectValues
Description

Gets the default object values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returnobject[] the default object values
ErrorsILLEGAL_STATE syntax is not an OBJECT
Compliancemandatory This method must be implemented.
MethodgetExistingObjectValues
Description

Gets the existing object values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returnobject[] the existing object values
ErrorsILLEGAL_STATE syntax is not an OBJECT or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetSpatialUnitRecordTypes
Description

Gets the set of acceptable spatial unit record types.

Returnosid.type.Type[] the set of spatial unit types
ErrorsILLEGAL_STATE syntax is not SPATIALUNIT
Compliancemandatory This method must be implemented.
MethodsupportsSpatialUnitRecordType
Description

Tests if the given spatial unit record type is supported.

Parametersosid.type.TypespatialUnitRecordType a spatial unit record Type
Returnboolean true if the type is supported, false otherwise
ErrorsILLEGAL_STATE syntax is not an SPATIALUNIT
NULL_ARGUMENT spatialUnitRecordType is null
Compliancemandatory This method must be implemented.
MethodgetSpatialUnitSet
Description

Gets the set of acceptable spatial unit values.

Returnosid.mapping.SpatialUnit[] a set of spatial units or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a SPATIALUNIT or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultSpatialUnitValues
Description

Gets the default spatial unit values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returnosid.mapping.SpatialUnit[] the default spatial unit values
ErrorsILLEGAL_STATE syntax is not a SPATIALUNIT
Compliancemandatory This method must be implemented.
MethodgetExistingSpatialUnitValues
Description

Gets the existing spatial unit values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returnosid.mapping.SpatialUnit[] the existing spatial unit values
ErrorsILLEGAL_STATE syntax is not a SPATIALUNIT or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetMinimumSpeed
Description

Gets the minimum speed value.

Returnosid.mapping.Speed the minimum speed
ErrorsILLEGAL_STATE syntax is not a SPEED
Compliancemandatory This method must be implemented.
MethodgetMaximumSpeed
Description

Gets the maximum speed value.

Returnosid.mapping.Speed the maximum speed
ErrorsILLEGAL_STATE syntax is not a SPEED
Compliancemandatory This method must be implemented.
MethodgetSpeedSet
Description

Gets the set of acceptable speed values.

Returnosid.mapping.Speed[] a set of speeds or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a SPEED or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultSpeedValues
Description

Gets the default speed values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returnosid.mapping.Speed[] the default speed values
ErrorsILLEGAL_STATE syntax is not a SPEED
Compliancemandatory This method must be implemented.
MethodgetExistingSpeedValues
Description

Gets the existing speed values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returnosid.mapping.Speed[] the existing speed values
ErrorsILLEGAL_STATE syntax is not a SPEED or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetMinimumStringLength
Description

Gets the minimum string length.

Returncardinal the minimum string length
ErrorsILLEGAL_STATE syntax is not a STRING or DISPLAYTEXT
Compliancemandatory This method must be implemented.
MethodgetMaximumStringLength
Description

Gets the maximum string length.

Returncardinal the maximum string length
ErrorsILLEGAL_STATE syntax is not a STRING or DISPLAYTEXT
Compliancemandatory This method must be implemented.
MethodgetStringMatchTypes
Description

Gets the set of valid string match types for use in validating a string. If the string match type indicates a regular expression then getStringExpression() returns a regular expression.

Returnosid.type.Type[] the set of string match types
ErrorsILLEGAL_STATE syntax is not a STRING or DISPLAYTEXT
Compliancemandatory This method must be implemented.
MethodsupportsStringMatchType
Description

Tests if the given string match type is supported.

Parametersosid.type.TypestringMatchType a string match type
Returnboolean true if the given string match type Is supported, false otherwise
ErrorsILLEGAL_STATE syntax is not a STRING or DISPLAYTEXT
NULL_ARGUMENT stringMatchType is null
Compliancemandatory This method must be implemented.
MethodgetStringExpression
Description

Gets the regular expression of an acceptable string for the given string match type.

Parametersosid.type.TypestringMatchType a string match type
Returnstring the regular expression
ErrorsNULL_ARGUMENT stringMatchType is null
ILLEGAL_STATE syntax is not a STRING or DISPLAYTEXT
UNSUPPORTED supportsStringMatchType(stringMatchType) is false
Compliancemandatory This method must be implemented.
MethodgetStringFormatTypes
Description

Gets the set of valid string formats.

Returnosid.type.Type[] the set of valid text format types
ErrorsILLEGAL_STATE syntax is not a STRING
Compliancemandatory This method must be implemented.
MethodgetStringSet
Description

Gets the set of acceptable string values.

Returnstring[] a set of strings or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a STRING or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultStringValues
Description

Gets the default string values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returnstring[] the default string values
ErrorsILLEGAL_STATE syntax is not a STRING
Compliancemandatory This method must be implemented.
MethodgetExistingStringValues
Description

Gets the existing string values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returnstring[] the existing string values
ErrorsILLEGAL_STATE syntax is not a STRING or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetMinimumTime
Description

Gets the minimum time value.

Returnosid.calendaring.Time the minimum time
ErrorsILLEGAL_STATE syntax is not a TIME
Compliancemandatory This method must be implemented.
MethodgetMaximumTime
Description

Gets the maximum time value.

Returnosid.calendaring.Time the maximum time
ErrorsILLEGAL_STATE syntax is not a TIME
Compliancemandatory This method must be implemented.
MethodgetTimeSet
Description

Gets the set of acceptable time values.

Returnosid.calendaring.Time[] a set of times or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a TIME or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultTimeValues
Description

Gets the default time values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returnosid.calendaring.Time[] the default time values
ErrorsILLEGAL_STATE syntax is not a TIME
Compliancemandatory This method must be implemented.
MethodgetExistingTimeValues
Description

Gets the existing time values. If hasSuppliedValue() are false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returnosid.calendaring.Time[] the existing time values
ErrorsILLEGAL_STATE syntax is not a TIME
Compliancemandatory This method must be implemented.
MethodgetTypeSet
Description

Gets the set of acceptable Types.

Returnosid.type.Type[] a set of Types or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a TYPE or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultTypeValues
Description

Gets the default type values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returnosid.type.Type[] the default type values
ErrorsILLEGAL_STATE syntax is not a TYPE
Compliancemandatory This method must be implemented.
MethodgetExistingTypeValues
Description

Gets the existing type values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returnosid.type.Type[] the existing type values
ErrorsILLEGAL_STATE syntax is not a TYPE or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetVersionTypes
Description

Gets the set of acceptable version types.

Returnosid.type.Type[] the set of version types
ErrorsILLEGAL_STATE syntax is not a VERSION
Compliancemandatory This method must be implemented.
MethodsupportsVersionType
Description

Tests if the given version type is supported.

Parametersosid.type.TypeversionType a version Type
Returnboolean true if the type is supported, false otherwise
ErrorsILLEGAL_STATE syntax is not a VERSION
NULL_ARGUMENT versionType is null
Compliancemandatory This method must be implemented.
MethodgetMinimumVersion
Description

Gets the minumim acceptable Version.

Returnosid.installation.Version the minumim Version
ErrorsILLEGAL_STATE syntax is not a VERSION
Compliancemandatory This method must be implemented.
MethodgetMaximumVersion
Description

Gets the maximum acceptable Version.

Returnosid.installation.Version the maximum Version
ErrorsILLEGAL_STATE syntax is not a VERSION
Compliancemandatory This method must be implemented.
MethodgetVersionSet
Description

Gets the set of acceptable Versions.

Returnosid.installation.Version[] a set of Versions or an empty array if not restricted
ErrorsILLEGAL_STATE syntax is not a VERSION or isEnumerated() is false
Compliancemandatory This method must be implemented.
MethodgetDefaultVersionValues
Description

Gets the default version values. These are the values used if the element value is not provided or is cleared. If isArray() is false, then this method returns at most a single value.

Returnosid.installation.Version[] the default version values
ErrorsILLEGAL_STATE syntax is not a TIME or isValueKnown() is false
Compliancemandatory This method must be implemented.
MethodgetExistingVersionValues
Description

Gets the existing version values. If hasSuppliedValue() is false, then these values are the default values. If isArray() is false and hasValidValue() is true, then this method returns at most a single value.

Returnosid.installation.Version[] the existing version values
ErrorsILLEGAL_STATE syntax is not a VERSION or isValueKnown() is false
Compliancemandatory This method must be implemented.