Interface OsidNode

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

A node interface for hierarchical objects. The Id of the node is the Id of the object represented at this node.

  • Method Summary

    Modifier and Type
    Method
    Description
    IdList
    getChildIds()
    Gets the children of this node.
    IdList
    getParentIds()
    Gets the parents of this node.
    boolean
    hasChildren()
    Tests if any children are available in this node structure.
    boolean
    hasParents()
    Tests if any parents are available in this node structure.
    boolean
    isLeaf()
    Tests if this node is a leaf in the hierarchy (has no children).
    boolean
    isRoot()
    Tests if this node is a root in the hierarchy (has no parents).

    Methods inherited from interface Containable

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

    Methods inherited from interface Identifiable

    getId, isCurrent
    Modifier and Type
    Method
    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 Details

    • isRoot

      boolean isRoot()
      Tests if this node is a root in the hierarchy (has no parents). A node may have no more parents available in this node structure but is not a root in the hierarchy. If both isRoot() and hasParents() is false, the parents of this node may be accessed thorugh another node structure retrieval.
      Returns:
      true if this node is a root in the hierarchy, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • hasParents

      boolean hasParents()
      Tests if any parents are available in this node structure. There may be no more parents in this node structure however there may be parents that exist in the hierarchy.
      Returns:
      true if this node has parents, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getParentIds

      IdList getParentIds()
      Gets the parents of this node.
      Returns:
      the parents of this node
      Compliance:
      mandatory - This method must be implemented.

    • isLeaf

      boolean isLeaf()
      Tests if this node is a leaf in the hierarchy (has no children). A node may have no more children available in this node structure but is not a leaf in the hierarchy. If both isLeaf() and hasChildren() is false, the children of this node may be accessed thorugh another node structure retrieval.
      Returns:
      true if this node is a leaf in the hierarchy, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • hasChildren

      boolean hasChildren()
      Tests if any children are available in this node structure. There may be no more children available in this node structure but this node may have children in the hierarchy.
      Returns:
      true if this node has children, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getChildIds

      IdList getChildIds()
      Gets the children of this node.
      Returns:
      the children of this node
      Compliance:
      mandatory - This method must be implemented.