Package org.faktorips.runtime.internal.toc

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 Detail

      • getProductCmptTocEntry

        ProductCmptTocEntry getProductCmptTocEntry​(java.lang.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​(java.lang.String kindId,
                                           java.lang.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

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

      • getProductCmptTocEntries

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

      • getTableTocEntries

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

      • getTestCaseTocEntries

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

      • getTestCaseTocEntryByQName

        TestCaseTocEntry getTestCaseTocEntryByQName​(java.lang.String qName)
        Returns a toc entry representing a test case for the given qualified name.

      • getTableTocEntryByClassname

        TableContentTocEntry getTableTocEntryByClassname​(java.lang.String implementationClass)
        Returns a toc entry representing a table for the table's class object.

      • getTableTocEntryByQualifiedTableName

        TableContentTocEntry getTableTocEntryByQualifiedTableName​(java.lang.String qualifiedTableName)
        Returns a toc entry representing a table for this table's qualified table name.

      • getModelTypeTocEntries

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

      • getEnumContentTocEntries

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

      • getEnumContentTocEntry

        EnumContentTocEntry getEnumContentTocEntry​(java.lang.String className)
        Returns the toc entry representing enum contents for the specified implementation class.

      • getEnumXmlAdapterTocEntries

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

      • getProductDataVersion

        java.lang.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​(java.lang.Class<T> type,
                                              java.lang.String ipsObjectQualifiedName)