Interface CMSItemAttributeFilterEnablerService

All Known Implementing Classes:
DefaultCMSItemAttributeFilterEnablerService

public interface CMSItemAttributeFilterEnablerService
Service to provide list of fields that should be returned by CMS Item API.
  • Method Details

    • getAttributes

      List<String> getAttributes(String typeCode, String mode)
      Returns the list of attributes by mode.
      Parameters:
      typeCode - the type for which the list of attributes should be returned
      mode - the mode that represents the list of fields.
      Returns:
      the list of fields.
    • getAttributes

      List<String> getAttributes(String typeCode)
      Returns the list of attributes. The mode is retrieved from the session if it was set by setMode(String).
      Parameters:
      typeCode - the type for which the list of attributes should be returned
      Returns:
      the list of fields.
    • clearCache

      void clearCache() throws InterruptedException
      Clear the cache that stores the configuration.
      Throws:
      InterruptedException - if thread is interrupted
    • setMode

      void setMode(String mode)
      Method saves the mode that should be used to retrieve the list of attributes to the session.
      Parameters:
      mode - the mode that should be used to retrieve the list of attributes.
    • getMode

      String getMode()
      Method retrieves the attribute mode from the session.
      Returns:
      the mode, null if mode has not been set.
    • isAttributeAllowed

      boolean isAttributeAllowed(String typeCode, String attribute)
      Verifies whether the attribute is allowed or not.
      Parameters:
      typeCode - the type code where the attribute exists
      attribute - the attribute qualifier.
      Returns:
      true if the attribute is allowed, false otherwise