org.osid

Interface Browsable

All Known Subinterfaces:

Academy, AcademySearchResults, Account, AccountSearchResults, Action, ActionEnabler, ActionEnablerSearchResults, ActionGroup, ActionGroupSearchResults, Activity, Activity, Activity, ActivityBundle, ActivityBundleSearchResults, ActivityRegistration, ActivityRegistrationSearchResults, ActivitySearchResults, ActivitySearchResults, ActivitySearchResults, ActivityUnit, ActivityUnitSearchResults, Address, AddressBook, AddressBookSearchResults, AddressSearchResults, Agency, AgencySearchResults, Agenda, AgendaSearchResults, Agent, AgentSearchResults, Allocation, Answer, Antimatroid, AntimatroidSearchResults, Appointment, AppointmentSearchResults, Assessment, AssessmentEntry, AssessmentEntrySearchResults, AssessmentOffered, AssessmentOfferedSearchResults, AssessmentPart, AssessmentPartSearchResults, AssessmentRequirement, AssessmentSearchResults, AssessmentSection, AssessmentTaken, AssessmentTakenSearchResults, Asset, AssetContent, AssetSearchResults, Auction, AuctionConstrainer, AuctionConstrainerEnabler, AuctionConstrainerEnablerSearchResults, AuctionConstrainerSearchResults, AuctionHouse, AuctionHouseSearchResults, AuctionProcessor, AuctionProcessorEnabler, AuctionProcessorEnablerSearchResults, AuctionProcessorSearchResults, AuctionSearchResults, Audit, AuditEnabler, AuditEnablerSearchResults, AuditSearchResults, Authentication, Authorization, AuthorizationEnabler, AuthorizationEnablerSearchResults, AuthorizationSearchResults, Availability, AvailabilityEnabler, AvailabilityEnablerSearchResults, AvailabilitySearchResults, Award, AwardEntry, AwardEntrySearchResults, AwardRequirement, AwardSearchResults, Ballot, BallotConstrainer, BallotConstrainerEnabler, BallotConstrainerEnablerSearchResults, BallotConstrainerSearchResults, BallotSearchResults, Bank, BankSearchResults, Bid, BidSearchResults, Billing, BillingSearchResults, Bin, BinSearchResults, Block, BlockSearchResults, Blog, BlogSearchResults, Book, BookSearchResults, Branch, BranchSearchResults, Broker, BrokerConstrainer, BrokerConstrainerEnabler, BrokerConstrainerEnablerSearchResults, BrokerConstrainerSearchResults, BrokerProcessor, BrokerProcessorEnabler, BrokerProcessorEnablerSearchResults, BrokerProcessorSearchResults, BrokerSearchResults, Budget, BudgetEntry, BudgetEntrySearchResults, BudgetSearchResults, Building, BuildingSearchResults, Business, Business, BusinessSearchResults, BusinessSearchResults, Calendar, CalendarSearchResults, Campus, CampusSearchResults, Candidate, CandidateSearchResults, CanonicalUnit, CanonicalUnitEnabler, CanonicalUnitEnablerSearchResults, CanonicalUnitProcessor, CanonicalUnitProcessorEnabler, CanonicalUnitProcessorEnablerSearchResults, CanonicalUnitProcessorSearchResults, CanonicalUnitSearchResults, Catalog, CatalogEnabler, CatalogEnablerSearchResults, CatalogSearchResults, Catalogue, CatalogueSearchResults, Category, CategorySearchResults, Chain, ChainSearchResults, Challenge, Check, Checklist, ChecklistSearchResults, CheckResult, CheckSearchResults, Comment, CommentSearchResults, Commission, CommissionEnabler, CommissionEnablerSearchResults, CommissionSearchResults, Commitment, CommitmentEnabler, CommitmentEnablerSearchResults, CommitmentSearchResults, Communique, Competency, CompetencySearchResults, Composition, CompositionEnabler, CompositionEnablerSearchResults, CompositionSearchResults, Conferral, ConferralSearchResults, Configuration, ConfigurationSearchResults, Contact, ContactEnabler, ContactEnablerSearchResults, ContactSearchResults, Controller, ControllerSearchResults, Convocation, ConvocationSearchResults, Cookbook, CookbookSearchResults, Course, CourseCatalog, CourseCatalogSearchResults, CourseEntry, CourseEntrySearchResults, CourseOffering, CourseOfferingSearchResults, CourseRequirement, CourseSearchResults, Credential, CredentialEntry, CredentialEntrySearchResults, CredentialRequirement, CredentialSearchResults, Credit, CreditSearchResults, Customer, CustomerSearchResults, CyclicEvent, CyclicEventSearchResults, CyclicTimePeriod, CyclicTimePeriodSearchResults, Deed, DeedSearchResults, Demographic, DemographicEnabler, DemographicEnablerSearchResults, DemographicSearchResults, Depot, DepotSearchResults, Device, DeviceEnabler, DeviceEnablerSearchResults, DeviceSearchResults, Dictionary, DictionarySearchResults, Direction, DirectionSearchResults, Directory, DirectoryEntry, DirectorySearchResults, Dispatch, DispatchSearchResults, Distributor, DistributorSearchResults, Docet, DocetSearchResults, Edge, EdgeEnabler, EdgeEnablerSearchResults, EdgeSearchResults, Effort, EffortSearchResults, Endpoint, Engine, Engine, EngineSearchResults, EngineSearchResults, Enrollment, EnrollmentSearchResults, Entry, Entry, Entry, Entry, EntrySearchResults, EntrySearchResults, EntrySearchResults, EntrySearchResults, Event, EventSearchResults, Family, FamilySearchResults, File, FileSearchResults, FiscalPeriod, FiscalPeriodSearchResults, Floor, FloorSearchResults, Forum, ForumSearchResults, Foundry, FoundrySearchResults, FrontOffice, FrontOfficeSearchResults, Function, FunctionSearchResults, Grade, Gradebook, GradebookColumn, GradebookColumnCalculation, GradebookColumnSearchResults, GradebookColumnSummary, GradebookSearchResults, GradeEntry, GradeEntrySearchResults, GradeSystem, GradeSystemSearchResults, GradeSystemTransform, Graph, GraphSearchResults, Hierarchy, HierarchySearchResults, Hold, HoldEnabler, HoldEnablerSearchResults, HoldSearchResults, Ingredient, Input, InputEnabler, InputEnablerSearchResults, InputSearchResults, Inquest, InquestSearchResults, Inquiry, InquiryEnabler, InquiryEnablerSearchResults, InquirySearchResults, Installation, InstallationContent, InstallationSearchResults, Instruction, InstructionSearchResults, Intersection, IntersectionSearchResults, Inventory, InventorySearchResults, Issue, Issue, IssueSearchResults, IssueSearchResults, Item, Item, Item, Item, ItemSearchResults, ItemSearchResults, ItemSearchResults, Job, JobConstrainer, JobConstrainerEnabler, JobConstrainerEnablerSearchResults, JobConstrainerSearchResults, JobProcessor, JobProcessorEnabler, JobProcessorEnablerSearchResults, JobProcessorSearchResults, JobSearchResults, Journal, JournalEntry, JournalEntrySearchResults, JournalSearchResults, Key, KeySearchResults, LearningObjectiveRequirement, Lease, LeaseSearchResults, Lesson, LessonSearchResults, Location, LocationSearchResults, Log, LogEntry, LogEntry, LogEntrySearchResults, LogSearchResults, Mailbox, MailboxSearchResults, Map, MapSearchResults, Message, MessageSearchResults, Meter, MeterSearchResults, Model, ModelSearchResults, Module, ModuleSearchResults, Node, NodeSearchResults, Objective, ObjectiveBank, ObjectiveBankSearchResults, ObjectiveSearchResults, Obstacle, ObstacleEnabler, ObstacleEnablerSearchResults, ObstacleSearchResults, Offering, OfferingConstrainer, OfferingConstrainerEnabler, OfferingConstrainerEnablerSearchResults, OfferingConstrainerSearchResults, OfferingSearchResults, Office, OfficeSearchResults, OffsetEvent, OffsetEventEnabler, OffsetEventEnablerSearchResults, OffsetEventSearchResults, Ontology, OntologySearchResults, Order, OrderSearchResults, Organization, OrganizationSearchResults, OsidCatalog, OsidCompendium, OsidConstrainer, OsidEnabler, OsidGovernator, OsidObject, OsidProcessor, OsidRelationship, OsidResult, OsidRule, OsidSearchResults, Oubliette, OublietteSearchResults, Package, PackageSearchResults, Parameter, ParameterProcessor, ParameterProcessorEnabler, ParameterProcessorEnablerSearchResults, ParameterProcessorSearchResults, ParameterSearchResults, Participant, ParticipantSearchResults, Path, Path, PathSearchResults, PathSearchResults, Payer, PayerSearchResults, Payment, PaymentSearchResults, Period, PeriodSearchResults, Person, PersonSearchResults, Plan, PlanSearchResults, Polls, PollsSearchResults, Pool, PoolConstrainer, PoolConstrainerEnabler, PoolConstrainerEnablerSearchResults, PoolConstrainerSearchResults, PoolProcessor, PoolProcessorEnabler, PoolProcessorEnablerSearchResults, PoolProcessorSearchResults, PoolSearchResults, Position, PositionSearchResults, Post, Post, PostEntry, PostEntrySearchResults, PostSearchResults, PostSearchResults, Price, PriceEnabler, PriceEnablerSearchResults, PriceSchedule, PriceScheduleSearchResults, Procedure, ProcedureSearchResults, Process, Process, ProcessEnabler, ProcessEnablerSearchResults, ProcessSearchResults, ProcessSearchResults, Product, ProductSearchResults, Proficiency, ProficiencySearchResults, Profile, ProfileEntry, ProfileEntryEnabler, ProfileEntryEnablerSearchResults, ProfileEntrySearchResults, ProfileItem, ProfileItemSearchResults, ProfileSearchResults, Program, ProgramEntry, ProgramEntrySearchResults, ProgramOffering, ProgramOfferingSearchResults, ProgramRequirement, ProgramSearchResults, Project, ProjectSearchResults, Provision, Provisionable, ProvisionableSearchResults, ProvisionReturn, ProvisionSearchResults, Proxy, Publisher, PublisherSearchResults, Qualifier, QualifierSearchResults, Question, Queue, Queue, QueueConstrainer, QueueConstrainer, QueueConstrainerEnabler, QueueConstrainerEnabler, QueueConstrainerEnablerSearchResults, QueueConstrainerEnablerSearchResults, QueueConstrainerSearchResults, QueueConstrainerSearchResults, QueueProcessor, QueueProcessor, QueueProcessorEnabler, QueueProcessorEnabler, QueueProcessorEnablerSearchResults, QueueProcessorEnablerSearchResults, QueueProcessorSearchResults, QueueProcessorSearchResults, QueueSearchResults, QueueSearchResults, Race, RaceConstrainer, RaceConstrainerEnabler, RaceConstrainerEnablerSearchResults, RaceConstrainerSearchResults, RaceProcessor, RaceProcessorEnabler, RaceProcessorEnablerSearchResults, RaceProcessorSearchResults, RaceResult, RaceSearchResults, Realm, RealmSearchResults, Receipt, Recipe, RecipeSearchResults, RecurringEvent, RecurringEventEnabler, RecurringEventEnablerSearchResults, RecurringEventSearchResults, Registration, RegistrationSearchResults, Relationship, RelationshipEnabler, RelationshipEnablerSearchResults, RelationshipSearchResults, Relevancy, RelevancyEnabler, RelevancyEnablerSearchResults, RelevancySearchResults, Renovation, RenovationSearchResults, Reply, ReplySearchResults, Repository, RepositorySearchResults, Request, RequestSearchResults, RequestTransaction, Requisite, RequisiteSearchResults, Resource, ResourceLocation, ResourceRelationship, ResourceRelationshipSearchResults, ResourceSearchResults, ResourceVelocity, Response, Response, ResponseOption, ResponseSearchResults, Result, Result, ResultSearchResults, Room, RoomSearchResults, Route, RouteProgress, RouteSearchResults, RouteSegment, Rule, RuleSearchResults, Scene, SceneSearchResults, Schedule, ScheduleSearchResults, ScheduleSlot, ScheduleSlotSearchResults, SearchResults, SequenceRule, SequenceRuleEnabler, SequenceRuleEnablerSearchResults, SequenceRuleSearchResults, Setting, SettingSearchResults, Shipment, ShipmentSearchResults, Signal, SignalEnabler, SignalEnablerSearchResults, SignalSearchResults, Site, SpeedZone, SpeedZoneEnabler, SpeedZoneEnablerSearchResults, SpeedZoneSearchResults, State, StateSearchResults, Statistic, StatisticSearchResults, Step, StepConstrainer, StepConstrainerEnabler, StepConstrainerEnablerSearchResults, StepConstrainerSearchResults, StepProcessor, StepProcessorEnabler, StepProcessorEnablerSearchResults, StepProcessorSearchResults, StepSearchResults, Stock, StockSearchResults, Store, StoreSearchResults, Subject, SubjectSearchResults, Subscription, SubscriptionEnabler, SubscriptionEnablerSearchResults, SubscriptionSearchResults, Summary, Summary, SupersedingEvent, SupersedingEventEnabler, SupersedingEventEnablerSearchResults, SupersedingEventSearchResults, Syllabus, SyllabusSearchResults, System, SystemSearchResults, Term, TermSearchResults, TimePeriod, TimePeriodSearchResults, Todo, TodoProducer, TodoProducerSearchResults, TodoSearchResults, Trigger, TriggerEnabler, TriggerEnablerSearchResults, TriggerSearchResults, Trust, Utility, UtilitySearchResults, Value, ValueEnabler, ValueEnablerSearchResults, ValueSearchResults, Vault, VaultSearchResults, Vote, VoterAllocation, VoteSearchResults, Warehouse, WarehouseSearchResults, Work, Work, WorkflowEvent, WorkSearchResults, WorkSearchResults

public interface Browsable

A marker interface for objects that offer property inspection.

Method Summary

Methods

Modifier and Type	Method and Description
PropertyList	getProperties() Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType) Gets a list of properties corresponding to the specified record type.

Method Detail

getProperties

PropertyList getProperties()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets a list of properties. Properties provide a means for applications to display a representation of the contents of a record without understanding its Type specification. Applications needing to examine a specific property should use the extension interface defined by its Type.

Returns:

a list of properties

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

Compliance:

mandatory - This method must be implemented.

getPropertiesByRecordType

PropertyList getPropertiesByRecordType(Type recordType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Gets a list of properties corresponding to the specified record type. Properties provide a means for applications to display a representation of the contents of a record without understanding its record interface specification. Applications needing to examine a specific propertyshould use the methods defined by the record Type. The resulting set includes properties specified by parents of the record type in the case a record's interface extends another.

Parameters:

recordType - the record type corresponding to the properties set to retrieve

Returns:

a list of properties

Throws:

NullArgumentException - recordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - an authorization failure occurred

UnsupportedException - hasRecordType(recordType) is false

Compliance:

mandatory - This method must be implemented.