Package org.faktorips.runtime.internal.toc

Class ProductCmptTocEntry

    • Field Detail

      • PROPERTY_KIND_ID

        public static final java.lang.String PROPERTY_KIND_ID
        See Also:
        Constant Field Values

      • PROPERTY_VERSION_ID

        public static final java.lang.String PROPERTY_VERSION_ID
        See Also:
        Constant Field Values

      • PROPERTY_VALID_TO

        public static final java.lang.String PROPERTY_VALID_TO
        See Also:
        Constant Field Values

      • PROPERTY_GENERATION_IMPL_CLASS_NAME

        public static final java.lang.String PROPERTY_GENERATION_IMPL_CLASS_NAME
        See Also:
        Constant Field Values

    • Constructor Detail

      • ProductCmptTocEntry

        public ProductCmptTocEntry​(java.lang.String ipsObjectId,
                           java.lang.String ipsObjectQualifiedName,
                           java.lang.String kindId,
                           java.lang.String versionId,
                           java.lang.String xmlResourceName,
                           java.lang.String implementationClassName,
                           java.lang.String generationImplClassName,
                           DateTime validTo)

    • Method Detail

      • getKindId

        public java.lang.String getKindId()
        Returns the id of the product component kind, if this entry describes a product component, otherwise an empty string.

      • getVersionId

        public java.lang.String getVersionId()
        Returns the version id if this entry describes a product component, otherwise an empty string.

      • getValidTo

        public DateTime getValidTo()
        Returns the validTo date or null if the object doesn't supports a valid to attribute.

      • getGenerationEntries

        public java.util.List<GenerationTocEntry> getGenerationEntries()
        Returns the generation entries or an empty array if this entry does not contain any generation entries.

      • getNumberOfGenerationEntries

        public int getNumberOfGenerationEntries()
        Returns the number of generation entries.

      • getGenerationImplClassName

        public java.lang.String getGenerationImplClassName()
        Returns the name of the generation implementation class

      • setGenerationEntries

        public void setGenerationEntries​(java.util.List<GenerationTocEntry> entries)
        Sets the generation entries.

      • findNextGenerationEntry

        public java.util.Optional<GenerationTocEntry> findNextGenerationEntry​(java.util.Calendar validFrom)
        Returns an Optional containing the GenerationTocEntry successor of the one that is found for the provided validity date. Returns an empty Optional if either no entry is found for the provided date or if the found one doesn't have a successor.

      • findPreviousGenerationEntry

        public java.util.Optional<GenerationTocEntry> findPreviousGenerationEntry​(java.util.Calendar validFrom)
        Returns an Optional containing the GenerationTocEntry that is prior to the one that is found for the provided validity date. Returns an empty Optional if either no entry is found for the provided date or if the found one doesn't have a predecessor.

      • findLatestGenerationEntry

        public java.util.Optional<GenerationTocEntry> findLatestGenerationEntry()
        Returns an Optional containing the latest GenerationTocEntry with respect to the generations validity date.

      • findGenerationEntry

        public java.util.Optional<GenerationTocEntry> findGenerationEntry​(java.util.Calendar effectiveDate)
        Returns an Optional containing the toc entry for the generation valid on the given effective date, or an empty Optional if no generation is effective on the given date or the effective is null.

      • findGenerationEntry

        public java.util.Optional<GenerationTocEntry> findGenerationEntry​(DateTime validAt)
        Return an Optional containing the Generation Toc Entry for the exact valid at DateTime. This is the most effective way to get a generation toc entry.

      • addToXml

        protected void addToXml​(org.w3c.dom.Element entryElement)
        Description copied from class: TocEntry
        Adds this instance's property values to the xml element.
        Overrides:
        addToXml in class TocEntryObject

      • getXmlElementTag

        protected java.lang.String getXmlElementTag()
        Description copied from class: TocEntry
        Getting the xml element tag for this toc entry
        Specified by:
        getXmlElementTag in class TocEntry

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class TocEntryObject