Package org.faktorips.runtime

Interface IProductComponent

All Superinterfaces:
IProductComponentLinkSource, IProductObject, IRuntimeObject
All Known Implementing Classes:
ProductComponent
public interface IProductComponent extends IRuntimeObject, IProductObject
Interface for all product components.
Author:
Jan Ortmann

  • Field Details

  • Method Details

    • getRepository

      IRuntimeRepository getRepository()
      Returns the repository this product component belongs to. This method never returns null.
      Specified by:
      getRepository in interface IProductComponentLinkSource
      Returns:
      The IRuntimeRepository that was used to create this IProductComponentLinkSource

    • getId

      String getId()
      Returns the product component's id that uniquely identifies it in the repository it belongs to.

    • getKindId

      String getKindId()
      Returns the id of the product component kind that this product component belongs to.

    • getVersionId

      String getVersionId()
      Returns the version id that identifies this product component in its kind.

    • isVariant

      boolean isVariant()
      A variant is a product component that is based on another product component (hence varied base). It uses the varied base as a template and "changes" specific values.
      Returns:
      true if this is a variant of another IProductComponent, false for regular product components.
      See Also:

    • getVariedBase

      IProductComponent getVariedBase()
      Allows distinguishing variants not only by their product component type but also their varied base. isVariant() allows determining whether a product component is a variant.
      Returns:
      the IProductComponent this IProductComponent is based on. Returns null if it is a regular product component or the variedBase can not be found in the IRuntimeRepository.
      See Also:

    • getValidTo

      DateTime getValidTo()
      Returns the date when this product component expires. Returning null means no end of the validity period.

    • getGenerationBase

      IProductComponentGeneration getGenerationBase(Calendar effectiveDate)
      Returns the generation that is effective on the given date or null if no generation is effective on that date.
      Throws:
      UnsupportedOperationException - if this product component has no product component generations.
      NullPointerException - if effective date is null.

    • getLatestProductComponentGeneration

      IProductComponentGeneration getLatestProductComponentGeneration()
      Returns the latest product component generation of the provided product component or null if non available.
      Throws:
      UnsupportedOperationException - if this product component has no product component generations.

    • isChangingOverTime

      boolean isChangingOverTime()
      Returns true if this product component has product component generations.
      Since:
      3.15

    • getDescription

      String getDescription(Locale locale)
      Returns the description for this product component in the specified locale. If there is no description in the specified locale, it tries to find the description in the locale's language. If there is also no description in the locale's language it returns the empty string.
      Returns:
      the description for the given locale/language or an empty string if no description exists for the given locale

    • setDescription

      void setDescription(Locale locale, String newDescriptionText)
      Sets or updates the description for the given Locale.

      If the description for the locale already exists, it will be replaced. If no description exists, a new localized description entry will be added. If the component belongs to a read-only IRuntimeRepository, this method will throw an IllegalRepositoryModificationException.

      Parameters:
      locale - the locale for which the description is to be set (must not be null)
      newDescriptionText - the new description text for the given locale (must not be null)
      Throws:
      NullPointerException - if either parameter is null
      IllegalRepositoryModificationException - if the component is part of a read-only repository
      Since:
      25.7

    • setDescription

      void setDescription(org.faktorips.values.InternationalString newDescription)
      Replaces the current multi-language description with the given InternationalString.

      This method will overwrite all existing localized descriptions. If the component belongs to a read-only IRuntimeRepository, this method will throw an IllegalRepositoryModificationException.

      Parameters:
      newDescription - the new internationalized description to set (must not be null)
      Throws:
      NullPointerException - if newDescription is null
      IllegalRepositoryModificationException - if the component is part of a read-only repository
      Since:
      25.7

    • getQualifiedName

      default String getQualifiedName()
      Returns the qualified name of this product component. The qualified name is the name of the file this product component is read from, relative to the repository's root, if the repository uses files - otherwise the value's definition depends on the repository implementation.

      The qualified name may be null for newly created product components.

      Returns:
      the qualified name of this product component
      Since:
      24.1