org.osid

Interface Identifiable

All Known Subinterfaces:

Academy, AcademyBatchForm, AcademyForm, AcademyNode, Account, AccountBatchForm, AccountForm, AccountNode, Action, ActionBatchForm, ActionEnabler, ActionEnablerForm, ActionEnablerFormRecord, ActionForm, ActionGroup, ActionGroupBatchForm, ActionGroupForm, Activity, Activity, Activity, ActivityBatchForm, ActivityBatchForm, ActivityBatchForm, ActivityBundle, ActivityBundleBatchForm, ActivityBundleForm, ActivityForm, ActivityForm, ActivityForm, ActivityNode, ActivityRegistration, ActivityRegistrationBatchForm, ActivityRegistrationForm, ActivityUnit, ActivityUnitBatchForm, ActivityUnitForm, Address, AddressBatchForm, AddressBook, AddressBookBatchForm, AddressBookForm, AddressBookNode, AddressForm, Agency, AgencyBatchForm, AgencyForm, AgencyNode, Agenda, AgendaForm, Agent, AgentBatchForm, AgentForm, AllocationForm, Answer, AnswerBatchForm, AnswerForm, Antimatroid, AntimatroidForm, AntimatroidNode, Appointment, AppointmentBatchForm, AppointmentForm, Assessment, AssessmentBatchForm, AssessmentEntry, AssessmentEntryBatchForm, AssessmentEntryForm, AssessmentForm, AssessmentOffered, AssessmentOfferedBatchForm, AssessmentOfferedForm, AssessmentPart, AssessmentPartForm, AssessmentRequirement, AssessmentRequirementForm, AssessmentSection, AssessmentTaken, AssessmentTakenBatchForm, AssessmentTakenForm, Asset, AssetBatchForm, AssetContent, AssetContentForm, AssetForm, Auction, AuctionBatchForm, AuctionConstrainer, AuctionConstrainerEnabler, AuctionConstrainerEnablerForm, AuctionConstrainerEnablerFormRecord, AuctionConstrainerForm, AuctionConstrainerFormRecord, AuctionForm, AuctionHouse, AuctionHouseBatchForm, AuctionHouseForm, AuctionHouseNode, AuctionProcessor, AuctionProcessorEnabler, AuctionProcessorEnablerForm, AuctionProcessorEnablerFormRecord, AuctionProcessorForm, AuctionProcessorFormRecord, Audit, AuditBatchForm, AuditEnabler, AuditEnablerForm, AuditEnablerFormRecord, AuditForm, Authentication, Authorization, AuthorizationBatchForm, AuthorizationEnabler, AuthorizationEnablerForm, AuthorizationEnablerFormRecord, AuthorizationForm, Availability, AvailabilityBatchForm, AvailabilityEnabler, AvailabilityEnablerForm, AvailabilityForm, Award, AwardBatchForm, AwardEntry, AwardEntryBatchForm, AwardEntryForm, AwardForm, AwardRequirement, AwardRequirementForm, Ballot, BallotBatchForm, BallotConstrainer, BallotConstrainerEnabler, BallotConstrainerEnablerForm, BallotConstrainerEnablerFormRecord, BallotConstrainerForm, BallotConstrainerFormRecord, BallotForm, Bank, BankBatchForm, BankForm, BankNode, Bid, BidBatchForm, BidForm, Billing, BillingBatchForm, BillingForm, BillingNode, Bin, BinBatchForm, BinForm, BinNode, Block, BlockBatchForm, BlockForm, Blog, BlogBatchForm, BlogForm, BlogNode, Book, BookBatchForm, BookForm, BookNode, Branch, BranchBatchForm, BranchForm, Broker, BrokerBatchForm, BrokerConstrainer, BrokerConstrainerEnabler, BrokerConstrainerEnablerForm, BrokerConstrainerEnablerFormRecord, BrokerConstrainerForm, BrokerConstrainerFormRecord, BrokerForm, BrokerProcessor, BrokerProcessorEnabler, BrokerProcessorEnablerForm, BrokerProcessorEnablerFormRecord, BrokerProcessorForm, BrokerProcessorFormRecord, Budget, BudgetBatchForm, BudgetEntry, BudgetEntryBatchForm, BudgetEntryForm, BudgetForm, Building, BuildingBatchForm, BuildingForm, Business, Business, BusinessBatchForm, BusinessBatchForm, BusinessForm, BusinessForm, BusinessNode, BusinessNode, Calendar, CalendarBatchForm, CalendarForm, CalendarNode, Campus, CampusBatchForm, CampusForm, CampusNode, Candidate, CandidateBatchForm, CandidateForm, CanonicalUnit, CanonicalUnitBatchForm, CanonicalUnitEnabler, CanonicalUnitEnablerForm, CanonicalUnitEnablerFormRecord, CanonicalUnitForm, CanonicalUnitProcessor, CanonicalUnitProcessorEnabler, CanonicalUnitProcessorEnablerForm, CanonicalUnitProcessorEnablerFormRecord, CanonicalUnitProcessorForm, CanonicalUnitProcessorFormRecord, Catalog, CatalogEnabler, CatalogEnablerForm, CatalogEnablerFormRecord, CatalogForm, CatalogNode, Catalogue, CatalogueBatchForm, CatalogueForm, CatalogueNode, Category, CategoryBatchForm, CategoryForm, Chain, ChainForm, Challenge, Check, CheckForm, Checklist, ChecklistBatchForm, ChecklistForm, ChecklistNode, Comment, CommentBatchForm, CommentForm, Commission, CommissionBatchForm, CommissionEnabler, CommissionEnablerForm, CommissionForm, Commitment, CommitmentBatchForm, CommitmentEnabler, CommitmentEnablerForm, CommitmentEnablerFormRecord, CommitmentForm, Communique, Competency, CompetencyBatchForm, CompetencyForm, Composition, CompositionBatchForm, CompositionEnabler, CompositionEnablerForm, CompositionEnablerFormRecord, CompositionForm, Conferral, ConferralBatchForm, ConferralForm, Configuration, ConfigurationBatchForm, ConfigurationForm, ConfigurationNode, Contact, ContactBatchForm, ContactEnabler, ContactEnablerForm, ContactEnablerFormRecord, ContactForm, Controller, ControllerBatchForm, ControllerForm, Convocation, ConvocationBatchForm, ConvocationForm, Cookbook, CookbookBatchForm, CookbookForm, CookbookNode, Course, CourseBatchForm, CourseCatalog, CourseCatalogBatchForm, CourseCatalogForm, CourseCatalogNode, CourseEntry, CourseEntryBatchForm, CourseEntryForm, CourseForm, CourseOffering, CourseOfferingBatchForm, CourseOfferingForm, CourseRequirement, CourseRequirementForm, Credential, CredentialBatchForm, CredentialEntry, CredentialEntryBatchForm, CredentialEntryForm, CredentialForm, CredentialRequirement, CredentialRequirementForm, Credit, CreditBatchForm, CreditForm, Customer, CustomerBatchForm, CustomerForm, CyclicEvent, CyclicEventBatchForm, CyclicEventForm, CyclicTimePeriod, CyclicTimePeriodBatchForm, CyclicTimePeriodForm, Deed, DeedBatchForm, DeedForm, Demographic, DemographicEnabler, DemographicEnablerForm, DemographicEnablerFormRecord, DemographicForm, DemographicFormRecord, Depot, DepotBatchForm, DepotForm, DepotNode, Device, DeviceBatchForm, DeviceEnabler, DeviceEnablerForm, DeviceEnablerFormRecord, DeviceForm, Dictionary, DictionaryBatchForm, DictionaryForm, DictionaryNode, Direction, DirectionBatchForm, DirectionForm, Directory, DirectoryEntry, DirectoryEntryForm, DirectoryForm, Dispatch, DispatchBatchForm, DispatchForm, Distributor, DistributorBatchForm, DistributorForm, DistributorNode, Docet, DocetBatchForm, DocetForm, Edge, EdgeBatchForm, EdgeEnabler, EdgeEnablerForm, EdgeEnablerFormRecord, EdgeForm, Effort, EffortBatchForm, EffortForm, Endpoint, Engine, Engine, EngineForm, EngineForm, EngineNode, EngineNode, Enrollment, EnrollmentBatchForm, EnrollmentForm, Entry, Entry, Entry, Entry, EntryBatchForm, EntryBatchForm, EntryBatchForm, EntryBatchForm, EntryForm, EntryForm, EntryForm, EntryForm, Event, EventBatchForm, EventForm, Family, FamilyBatchForm, FamilyForm, FamilyNode, File, FileForm, FiscalPeriod, FiscalPeriodBatchForm, FiscalPeriodForm, Floor, FloorBatchForm, FloorForm, Forum, ForumBatchForm, ForumForm, ForumNode, Foundry, FoundryBatchForm, FoundryForm, FoundryNode, FrontOffice, FrontOfficeBatchForm, FrontOfficeForm, FrontOfficeNode, Function, FunctionBatchForm, FunctionForm, Grade, GradeBatchForm, Gradebook, GradebookBatchForm, GradebookColumn, GradebookColumnBatchForm, GradebookColumnCalculation, GradebookColumnCalculationForm, GradebookColumnForm, GradebookColumnSummary, GradebookForm, GradebookNode, GradeEntry, GradeEntryBatchForm, GradeEntryForm, GradeForm, GradeSystem, GradeSystemBatchForm, GradeSystemForm, GradeSystemTransform, GradeSystemTransformForm, Graph, GraphBatchForm, GraphForm, GraphNode, Hierarchy, HierarchyForm, Hold, HoldBatchForm, HoldEnabler, HoldEnablerForm, HoldEnablerFormRecord, HoldForm, IdBatchForm, IdForm, Ingredient, IngredientBatchForm, IngredientForm, Input, InputBatchForm, InputEnabler, InputEnablerForm, InputEnablerFormRecord, InputForm, Inquest, InquestBatchForm, InquestForm, InquestNode, Inquiry, InquiryBatchForm, InquiryEnabler, InquiryEnablerForm, InquiryEnablerFormRecord, InquiryForm, Installation, InstallationContent, InstallationContentForm, Instruction, InstructionForm, Intersection, IntersectionBatchForm, IntersectionForm, Inventory, InventoryBatchForm, InventoryForm, Issue, Issue, IssueBatchForm, IssueBatchForm, IssueForm, IssueForm, Item, Item, Item, Item, ItemBatchForm, ItemBatchForm, ItemBatchForm, ItemBatchForm, ItemForm, ItemForm, ItemForm, ItemForm, Job, JobBatchForm, JobConstrainer, JobConstrainerEnabler, JobConstrainerEnablerForm, JobConstrainerForm, JobForm, JobProcessor, JobProcessorEnabler, JobProcessorEnablerForm, JobProcessorForm, Journal, JournalBatchForm, JournalEntry, JournalEntryBatchForm, JournalEntryForm, JournalForm, JournalNode, Key, KeyBatchForm, KeyForm, LearningObjectiveRequirement, LearningObjectiveRequirementForm, Lease, LeaseBatchForm, LeaseForm, Lesson, LessonForm, Location, LocationBatchForm, LocationForm, LocationNode, Log, LogBatchForm, LogEntry, LogEntry, LogEntryBatchForm, LogEntryForm, LogEntryForm, LogForm, LogNode, Mailbox, MailboxBatchForm, MailboxForm, MailboxNode, Map, MapBatchForm, MapForm, MapNode, Message, MessageBatchForm, MessageForm, Meter, MeterBatchForm, MeterForm, Model, ModelBatchForm, ModelForm, Module, ModuleBatchForm, ModuleForm, Node, Node, NodeBatchForm, NodeForm, Objective, ObjectiveBank, ObjectiveBankBatchForm, ObjectiveBankForm, ObjectiveBankNode, ObjectiveBatchForm, ObjectiveForm, ObjectiveNode, Obstacle, ObstacleBatchForm, ObstacleEnabler, ObstacleEnablerForm, ObstacleEnablerFormRecord, ObstacleForm, Offering, OfferingBatchForm, OfferingConstrainer, OfferingConstrainerEnabler, OfferingConstrainerEnablerForm, OfferingConstrainerEnablerFormRecord, OfferingConstrainerForm, OfferingConstrainerFormRecord, OfferingForm, Office, OfficeBatchForm, OfficeForm, OfficeNode, OffsetEvent, OffsetEventBatchForm, OffsetEventEnabler, OffsetEventEnablerForm, OffsetEventEnablerFormRecord, OffsetEventForm, Ontology, OntologyBatchForm, OntologyForm, OntologyNode, Order, OrderBatchForm, OrderForm, Organization, OrganizationBatchForm, OrganizationForm, OrganizationNode, OsidAggregateableForm, OsidBrowsableForm, OsidCapsuleForm, OsidCatalog, OsidCatalogForm, OsidCompendium, OsidCompendiumForm, OsidConstrainer, OsidConstrainerForm, OsidContainableForm, OsidEnabler, OsidEnablerForm, OsidExtensibleForm, OsidFederateableForm, OsidForm, OsidGovernator, OsidGovernatorForm, OsidIdentifiableForm, OsidNode, OsidObject, OsidObjectForm, OsidOperableForm, OsidProcessor, OsidProcessorForm, OsidRelationship, OsidRelationshipForm, OsidRule, OsidRuleForm, OsidSourceableForm, OsidSubjugateableForm, OsidTemporalForm, Oubliette, OublietteBatchForm, OublietteForm, OublietteNode, Package, PackageBatchForm, PackageForm, Parameter, ParameterBatchForm, ParameterForm, ParameterProcessor, ParameterProcessorEnabler, ParameterProcessorEnablerForm, ParameterProcessorEnablerFormRecord, ParameterProcessorForm, ParameterProcessorFormRecord, Participant, ParticipantBatchForm, ParticipantForm, Path, Path, PathBatchForm, PathForm, PathForm, Payer, PayerBatchForm, PayerForm, Payment, PaymentBatchForm, PaymentForm, Period, PeriodBatchForm, PeriodForm, Person, PersonBatchForm, PersonForm, Plan, PlanForm, Polls, PollsBatchForm, PollsForm, PollsNode, Pool, PoolBatchForm, PoolConstrainer, PoolConstrainerEnabler, PoolConstrainerEnablerForm, PoolConstrainerEnablerFormRecord, PoolConstrainerForm, PoolConstrainerFormRecord, PoolForm, PoolProcessor, PoolProcessorEnabler, PoolProcessorEnablerForm, PoolProcessorEnablerFormRecord, PoolProcessorForm, PoolProcessorFormRecord, Position, PositionBatchForm, PositionForm, Post, Post, PostBatchForm, PostBatchForm, PostEntry, PostEntryBatchForm, PostEntryForm, PostForm, PostForm, Price, PriceBatchForm, PriceEnabler, PriceEnablerForm, PriceEnablerFormRecord, PriceForm, PriceSchedule, PriceScheduleBatchForm, PriceScheduleForm, Procedure, ProcedureBatchForm, ProcedureForm, Process, Process, ProcessBatchForm, ProcessEnabler, ProcessEnablerForm, ProcessEnablerFormRecord, ProcessForm, ProcessForm, ProcessNode, Product, ProductBatchForm, ProductForm, Proficiency, ProficiencyBatchForm, ProficiencyForm, Profile, ProfileBatchForm, ProfileEntry, ProfileEntryBatchForm, ProfileEntryEnabler, ProfileEntryEnablerForm, ProfileEntryEnablerFormRecord, ProfileEntryForm, ProfileForm, ProfileItem, ProfileItemBatchForm, ProfileItemForm, ProfileNode, Program, ProgramBatchForm, ProgramEntry, ProgramEntryBatchForm, ProgramEntryForm, ProgramForm, ProgramOffering, ProgramOfferingBatchForm, ProgramOfferingForm, ProgramRequirement, ProgramRequirementForm, Project, ProjectBatchForm, ProjectForm, Provision, Provisionable, ProvisionableBatchForm, ProvisionableForm, ProvisionBatchForm, ProvisionForm, ProvisionReturn, ProvisionReturnForm, Publisher, PublisherBatchForm, PublisherForm, PublisherNode, Qualifier, QualifierBatchForm, QualifierForm, QualifierNode, Question, QuestionBatchForm, QuestionForm, Queue, Queue, QueueBatchForm, QueueBatchForm, QueueConstrainer, QueueConstrainer, QueueConstrainerEnabler, QueueConstrainerEnabler, QueueConstrainerEnablerForm, QueueConstrainerEnablerForm, QueueConstrainerEnablerFormRecord, QueueConstrainerEnablerFormRecord, QueueConstrainerForm, QueueConstrainerForm, QueueConstrainerFormRecord, QueueConstrainerFormRecord, QueueForm, QueueForm, QueueProcessor, QueueProcessor, QueueProcessorEnabler, QueueProcessorEnabler, QueueProcessorEnablerForm, QueueProcessorEnablerForm, QueueProcessorEnablerFormRecord, QueueProcessorEnablerFormRecord, QueueProcessorForm, QueueProcessorForm, QueueProcessorFormRecord, QueueProcessorFormRecord, Race, RaceBatchForm, RaceConstrainer, RaceConstrainerEnabler, RaceConstrainerEnablerForm, RaceConstrainerEnablerFormRecord, RaceConstrainerForm, RaceConstrainerFormRecord, RaceForm, RaceProcessor, RaceProcessorEnabler, RaceProcessorEnablerForm, RaceProcessorEnablerFormRecord, RaceProcessorForm, RaceProcessorFormRecord, RaceResult, Realm, RealmBatchForm, RealmForm, RealmNode, Receipt, ReceiptBatchForm, ReceiptForm, Recipe, RecipeBatchForm, RecipeForm, RecurringEvent, RecurringEventBatchForm, RecurringEventEnabler, RecurringEventEnablerForm, RecurringEventEnablerFormRecord, RecurringEventForm, Registration, RegistrationBatchForm, RegistrationForm, Relationship, RelationshipBatchForm, RelationshipEnabler, RelationshipEnablerForm, RelationshipEnablerFormRecord, RelationshipForm, Relevancy, RelevancyBatchForm, RelevancyEnabler, RelevancyEnablerForm, RelevancyEnablerFormRecord, RelevancyForm, Renovation, RenovationBatchForm, RenovationForm, Reply, ReplyBatchForm, ReplyForm, Repository, RepositoryBatchForm, RepositoryForm, RepositoryNode, Request, RequestBatchForm, RequestForm, RequestTransaction, RequestTransactionBatchForm, RequestTransactionForm, Requisite, RequisiteForm, Resource, ResourceBatchForm, ResourceForm, ResourceLocation, ResourceNode, ResourceRelationship, ResourceRelationshipBatchForm, ResourceRelationshipForm, ResourceVelocity, Response, Response, ResponseBatchForm, ResponseForm, ResponseForm, ResponseOption, Result, ResultBatchForm, ResultForm, Room, RoomBatchForm, RoomForm, Route, RouteForm, RouteProgress, RouteSegment, RouteSegmentForm, Rule, RuleForm, Scene, SceneBatchForm, SceneForm, Schedule, ScheduleBatchForm, ScheduleForm, ScheduleSlot, ScheduleSlotBatchForm, ScheduleSlotForm, SequenceRule, SequenceRuleEnabler, SequenceRuleEnablerForm, SequenceRuleEnablerFormRecord, SequenceRuleForm, Setting, SettingBatchForm, SettingForm, Shipment, ShipmentBatchForm, ShipmentForm, Signal, SignalBatchForm, SignalEnabler, SignalEnablerForm, SignalEnablerFormRecord, SignalForm, Site, SpeedZone, SpeedZoneBatchForm, SpeedZoneEnabler, SpeedZoneEnablerForm, SpeedZoneEnablerFormRecord, SpeedZoneForm, State, StateForm, Statistic, Step, StepBatchForm, StepConstrainer, StepConstrainerEnabler, StepConstrainerEnablerForm, StepConstrainerEnablerFormRecord, StepConstrainerForm, StepConstrainerFormRecord, StepForm, StepProcessor, StepProcessorEnabler, StepProcessorEnablerForm, StepProcessorEnablerFormRecord, StepProcessorForm, StepProcessorFormRecord, Stock, StockBatchForm, StockForm, StockNode, Store, StoreBatchForm, StoreForm, StoreNode, Subject, SubjectBatchForm, SubjectForm, SubjectNode, Subscription, SubscriptionBatchForm, SubscriptionEnabler, SubscriptionEnablerForm, SubscriptionEnablerFormRecord, SubscriptionForm, Summary, Summary, SupersedingEvent, SupersedingEventEnabler, SupersedingEventEnablerForm, SupersedingEventEnablerFormRecord, SupersedingEventForm, Syllabus, SyllabusBatchForm, SyllabusForm, System, SystemBatchForm, SystemForm, SystemNode, Term, TermBatchForm, TermForm, TermNode, TimePeriod, TimePeriodBatchForm, TimePeriodForm, Todo, TodoBatchForm, TodoForm, TodoNode, TodoProducer, TodoProducerForm, TodoProducerFormRecord, Trigger, TriggerBatchForm, TriggerEnabler, TriggerEnablerForm, TriggerEnablerFormRecord, TriggerForm, Trust, TypeForm, Utility, UtilityBatchForm, UtilityForm, UtilityNode, Value, ValueBatchForm, ValueEnabler, ValueEnablerForm, ValueEnablerFormRecord, ValueForm, Vault, VaultBatchForm, VaultForm, VaultNode, Vote, VoteBatchForm, VoteForm, VoterAllocation, VoterAllocationForm, Warehouse, WarehouseForm, WarehouseNode, Work, Work, WorkBatchForm, WorkBatchForm, WorkflowEvent, WorkForm, WorkForm

public interface Identifiable

A marker interface for objects uniquely identified with an OSID Id.

Method Summary

Methods

Modifier and Type	Method and Description
Id	getId() Gets the Id associated with this instance of this OSID object.
boolean	isCurrent() Tests to see if the last method invoked retrieved up-to-date data.

Method Detail

getId

Id getId()

Gets the Id associated with this instance of this OSID object. Persisting any reference to this object is done by persisting the Id returned from this method. The Id returned may be different than the Id used to query this object. In this case, the new Id should be preferred over the old one for future queries.

Returns:

the Id

Compliance:

mandatory - This method must be implemented.

Notes:

The - Id is intended to be constant and persistent. A consumer may at any time persist the Id for retrieval at any future time. Ideally, the Id should consistently resolve into the designated object and not be reused. In cases where objects are deactivated after a certain lifetime the provider should endeavor not to obliterate the object or its Id but instead should update the properties of the object including the deactiavted status and the elimination of any unwanted pieces of data. As such, there is no means for updating an Id and providers should consider carefully the identification scheme to implement. Id assignments for objects are strictly in the realm of the provider and any errors should be fixed directly with the backend supporting system. Once an Id has been assigned in a production service it should be honored such that it may be necessary for the backend system to support Id aliasing to redirect the lookup to the current Id. Use of an Id OSID may be helpful to accomplish this task in a modular manner.

isCurrent

boolean isCurrent()

Tests to see if the last method invoked retrieved up-to-date data. Simple retrieval methods do not specify errors as, generally, the data is retrieved once at the time this object is instantiated. Some implementations may provide real-time data though the application may not always care. An implementation providing a real-time service may fall back to a previous snapshot in case of error. This method returns false if the data last retrieved was stale.

Returns:

true if the last data retrieval was up to date, false otherwise

Compliance:

mandatory - This method must be implemented.

Notes:

Providers - should return false unless all getters are implemented using real-time queries, or some trigger process keeps the data in this object current. Providers should populate basic data elements at the time this object is instantiated, or set an error, to ensure some data availability.