Interface DatabaseEntity

    • Method Detail

      • getDataSourceName

        String getDataSourceName()
        Returns data source name.
        Returns:
        data source name.
      • getDataSourceType

        String getDataSourceType()
        Returns data source type.
        Returns:
        data source type.
      • getDataSource

        DataSource getDataSource()
        Returns data source.
        Returns:
        data source.
      • getInfoQuery

        String getInfoQuery()
        Returns query which retrieves the information of the reference. This query is one of the setting to be entered when creating a database page model. It's typically something like 'SELECT id, name, .. FROM myTable WHERE id = @dbid@ Any column can be returned, though '@dbid@' is predefined and will be replaced on the fly by the database id of the reference.
        Returns:
        query which retrieves the information of the reference.
      • getInfoQueryById

        String getInfoQueryById​(int dbId)
        Returns query which retrieves the information of the reference. This query is one of the setting to be entered when creating a database page model. It's typically something like 'SELECT id, name, .. FROM myTable WHERE id = @dbid@ Any column can be returned, though '@dbid@' is predefined and will be replaced on the fly by the database id of the reference.
        Parameters:
        dbId - the dbId
        Returns:
        query which retrieves the information of the reference.
      • getSearchQuery

        String getSearchQuery()
        Returns query which is used to search for a reference, e.g. when making a link to a database page in the edit environment, the search string entered in the popup screen is the parameter for this query and its results are presented to the user. This query is one of the setting to be entered when creating a database page model. It's typically something like 'SELECT myId as id,myName as name FROM myTable WHERE myName LIKE '%@search@%' ORDER BY name' Returning both a 'id' and 'name' column is compulsory, the predefined '@search@' will be replaced by the search string.
        Returns:
        query which is used to search for reference.
      • getColumns

        QueryColumn[] getColumns()
        Returns the columns which are used for the detail screen.
        Returns:
        the columns which are used for the detail screen.
      • getQuery

        String getQuery()
        Returns the query which is used to retrieve the title of the database reference with the ID from the Querystring.
        Returns:
        the query which is used to retrieve the title of the database reference.
      • getQueryFromID

        String getQueryFromID​(int entryId)
        Returns the query which is used to retrieve the title of the database reference with a given ID.
        Returns:
        the query which is used to retrieve the title of the database reference.
      • getIdentifier

        String getIdentifier()
        Returns a string unique among all database entities.
        Specified by:
        getIdentifier in interface ResourceEntity
        Returns:
        a string unique among all database entities.
      • getSmallIcon

        String getSmallIcon()
        Returns the small icon location.
        Returns:
        the small icon location
      • getLargeIcon

        String getLargeIcon()
        Returns the large icon location.
        Returns:
        the large icon location
      • isAutomaticallyAvailable

        boolean isAutomaticallyAvailable()
        Returns whether the database entity is automatically available in the search. The default is true.
        Returns:
        whether the database entity is automatically available in the search