Class CmsUrlNameMappingFilter

java.lang.Object
org.opencms.db.urlname.CmsUrlNameMappingFilter

public class CmsUrlNameMappingFilter extends Object
A class which contains filter criteria for reading or deleting URL name mapping entries.

Since:
8.0.0
  • Field Details

  • Constructor Details

  • Method Details

    • filterLocale

      Returns a new url name mapping filter based on the current one which also has to match a given locale.

      Parameters:
      locale - the locale to match
      Returns:
      the new filter
    • filterName

      Creates a new filter from the current filter which also has to match a given name.

      Parameters:
      name - the name to match
      Returns:
      a new filter
    • filterNamePattern

      Creates a new filter from the current filter which also has to match a given name pattern.

      Parameters:
      namePattern - the name pattern which should be matched
      Returns:
      a new filter
    • filterRejectStructureId

      Creates a new filter from the current filter which also must not match a given structure id.

      Parameters:
      id - the structure id to not match
      Returns:
      a new filter
    • filterStates

      public CmsUrlNameMappingFilter filterStates(int... states)
      Creates a new filter from the current filter which also has to match a given state.

      Parameters:
      states - the states to match
      Returns:
      the new filter
    • filterStructureId

      Creates a new filter from the current filter which also has to match a given structure id.

      Parameters:
      structureId - the structure id to match
      Returns:
      the new filter
    • getLocale

      public String getLocale()
      Returns the locale which should be matched by the filter.

      Returns:
      the locale
    • getName

      public String getName()
      Returns the name which should be matched by the filter.

      Returns:
      the name which should be matched by the filter
    • getNamePattern

      Returns the name pattern which should be matched by the filter.

      Returns:
      the name pattern which should be matched by the filter
    • getRejectStructureId

      Returns the structure id which should not be matched by the filter.

      Returns:
      a structure id
    • getStates

      public int[] getStates()
      Returns the state which should be matched by the filter.

      Returns:
      the state which should be matched by the filter
    • getStructureId

      Returns the structure id which should be matched by the filter.

      Returns:
      the structure id which should be matched by the filter
    • isIdFilter

      public boolean isIdFilter()
      Checks whether this is a filter which only filters by structure id.

      Returns:
      true if this is a filter which only filters by structure id
    • isNameFilter

      public boolean isNameFilter()
      Checks whether this is a filter which only filters by name.

      Returns:
      true if this is a filter which only filters by name
    • toString

      public String toString()
      Overrides:
      toString in class Object
      See Also: