Interface IdMethod

    • Method Detail

      • getMethod

        String getMethod()
        The name of this method, which should be unique among the methods that can be used at a given time.
        Returns:
        The method name
      • getTitle

        String getTitle()
        The display title of the method.
      • isTrulyUnique

        boolean isTrulyUnique()
        If the identification method is truly unique or not. If this method returns true, the find(DbControl, ItemQuery, String) method will never ever return a list with more than one item.
      • getColumnMappingParameterName

        String getColumnMappingParameterName()
      • prepareQuery

        <I extends BasicItemItemQuery<I> prepareQuery​(DbControl dc,
                                                        ItemQuery<I> query)
        Initialise a query to be used by this identification method. The query should be a fresh query without any previous restrictions or other modifications.
        Parameters:
        query - The query to prepare
        Returns:
        The query that is used for item lookup
      • setIdentifierOnNewItem

        default <I extends BasicItem> boolean setIdentifierOnNewItem​(DbControl dc,
                                                                     I item,
                                                                     String identifier)
        Set the ID on a newly created item when this is not done by other regular column mappers. The default implementation of this method does nothing.
        Returns:
        TRUE if the identifier was set, FALSE if not
        Since:
        3.15