Interface Containable

All Known Subinterfaces:
AcademyNode, AccountNode, ActivityNode, AddressBookNode, AgencyNode, AntimatroidNode, AssessmentPart, AuctionHouseNode, BankNode, BillingNode, BinNode, BlogNode, BookNode, BusinessNode, BusinessNode, CalendarNode, CampusNode, CatalogNode, CatalogueNode, ChecklistNode, Composition, ConfigurationNode, CookbookNode, CourseCatalogNode, DepotNode, DictionaryNode, DistributorNode, EngineNode, EngineNode, Event, FamilyNode, ForumNode, FoundryNode, FrontOfficeNode, GradebookNode, GraphNode, InquestNode, JournalNode, LocationNode, LogNode, MailboxNode, MapNode, Node, ObjectiveBankNode, ObjectiveNode, OfficeNode, OntologyNode, OrganizationNode, OsidNode, OublietteNode, PollsNode, PressNode, ProcessNode, ProfileNode, PublisherNode, QualifierNode, RealmNode, RecurringEvent, Reply, RepositoryNode, Requisite, ResourceNode, ScheduleSlot, StockNode, StoreNode, SubjectNode, SystemNode, TermNode, Todo, TodoNode, UtilityNode, VaultNode, WarehouseNode
public interface Containable

A Containable is a kind of aggregate where an OsidObject is defined as a recursive composition of itself directly accessible without knowledge of the originating service.

Containables are rare because of the fulfillment of a recursive retrieval of OSID Ids . They are used only when independent references to a single container without its contained parts have no purpose and generic hierarchy services do not capture the meaning of the hierarchical structure.

Because of the hierarchical nature of Containables , sub-objects may be created for the sole purpose of creating the aggregate. It may be desirable to hide these building blocks from general view.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isSequestered()
    Tests if this Containable is sequestered in that it should not appear outside of its aggregated composition.

  • Method Details

    • isSequestered

      boolean isSequestered()
      Tests if this Containable is sequestered in that it should not appear outside of its aggregated composition.
      Returns:
      true if this containable is sequestered, false if this containable may appear outside its aggregate
      Compliance:
      mandatory - This method must be implemented.