Interface IReadonlyTableOfContents

All Known Implementing Classes:
AbstractReadonlyTableOfContents, ReadonlyTableOfContents

public interface IReadonlyTableOfContents
This is the interface for readonly table of contents used by the runtime repositories. With the methods in this interface you could find a single entry in the table of contents or the list of entries of a special type
Author:
dirmeier
  • Method Details

    • getProductCmptTocEntry

      ProductCmptTocEntry getProductCmptTocEntry(String id)
      Returns the toc entry representing a product component for the given id or null if no entry exists for the given id.
    • getProductCmptTocEntry

      ProductCmptTocEntry getProductCmptTocEntry(String kindId, String versionId)
      Returns the toc entry representing a product component for the given product component kind id and versionId or null if no such entry exists.
    • getProductCmptTocEntries

      List<ProductCmptTocEntry> getProductCmptTocEntries()
      Returns all toc's entries representing product components.
    • getProductCmptTocEntries

      List<ProductCmptTocEntry> getProductCmptTocEntries(String kindId)
      Returns all toc's entries representing product components that belong to the indicated product component kind.
    • getTableTocEntries

      List<TableContentTocEntry> getTableTocEntries()
      Returns all toc's entries representing tables.
    • getTestCaseTocEntries

      List<TestCaseTocEntry> getTestCaseTocEntries()
      Returns all toc's entries representing test cases.
    • getTestCaseTocEntryByQName

      TestCaseTocEntry getTestCaseTocEntryByQName(String qName)
      Returns a toc entry representing a test case for the given qualified name.
    • getTableTocEntryByClassname

      TableContentTocEntry getTableTocEntryByClassname(String implementationClass)
      Returns a toc entry representing a table for the table's class object.
    • getTableTocEntryByQualifiedTableName

      TableContentTocEntry getTableTocEntryByQualifiedTableName(String qualifiedTableName)
      Returns a toc entry representing a table for this table's qualified table name.
    • getModelTypeTocEntries

      Set<ModelTypeTocEntry> getModelTypeTocEntries()
      Returns all toc's entries representing model types.
    • getEnumContentTocEntries

      List<EnumContentTocEntry> getEnumContentTocEntries()
      Returns all toc's entries representing enum contents.
    • getEnumContentTocEntry

      EnumContentTocEntry getEnumContentTocEntry(String className)
      Returns the toc entry representing enum contents for the specified implementation class.
    • getEnumXmlAdapterTocEntries

      Set<EnumXmlAdapterTocEntry> getEnumXmlAdapterTocEntries()
      Returns all toc entries that link to an enumeration xml adapter.
    • getProductDataVersion

      String getProductDataVersion()
      Return the version of the product data in this table of content. This may be a version numbe or a timestamp
      Returns:
      The version of the table of content
    • getCustomTocEntry

      <T> CustomTocEntryObject<T> getCustomTocEntry(Class<T> type, String ipsObjectQualifiedName)