jACOB 2.7 API Documentation.

de.tif.jacob.core.definition
Interface IDefinition

All Known Subinterfaces:
IApplicationDefinition

public interface IDefinition

This interface represents an abstract definition used to fetch

  • table definitions
  • table aliases
  • browser definitions
  • relations
  • relation sets
  • domain definitions by name.


    Method Summary
     IBrowserDefinition getBrowserDefinition(java.lang.String name)
              Fetches a browser definition by means of a given name.
     IDomainDefinition getDomainDefinition(java.lang.String name)
              Fetches a domain definition by means of a given name.
     IRelation getRelation(java.lang.String name)
              Fetches a relation by means of a given name.
     IRelationSet getRelationSet(java.lang.String name)
              Fetches a relation set by means of a given name.
     ITableAlias getTableAlias(java.lang.String name)
              Fetches a table alias by means of a given name.
     ITableDefinition getTableDefinition(java.lang.String name)
              Fetches a table definition by means of a given name.
     

    Method Detail

    getBrowserDefinition

    IBrowserDefinition getBrowserDefinition(java.lang.String name)
                                            throws java.lang.RuntimeException
    Fetches a browser definition by means of a given name.

    Parameters:
    name - the name of the desired browser definition
    Returns:
    the desired browser definition
    Throws:
    java.lang.RuntimeException - if no such browser definition exists.

    getTableDefinition

    ITableDefinition getTableDefinition(java.lang.String name)
                                        throws java.lang.RuntimeException
    Fetches a table definition by means of a given name.

    Parameters:
    name - the name of the desired table definition
    Returns:
    the desired table definition
    Throws:
    java.lang.RuntimeException - if no such table definition exists.

    getTableAlias

    ITableAlias getTableAlias(java.lang.String name)
                              throws java.lang.RuntimeException
    Fetches a table alias by means of a given name.

    Parameters:
    name - the name of the desired table alias
    Returns:
    the desired table alias
    Throws:
    java.lang.RuntimeException - if no such table alias exists.

    getRelationSet

    IRelationSet getRelationSet(java.lang.String name)
                                throws java.lang.RuntimeException
    Fetches a relation set by means of a given name.

    Parameters:
    name - the name of the desired relation set
    Returns:
    the desired relation set
    Throws:
    java.lang.RuntimeException - if no such relation set exists.

    getRelation

    IRelation getRelation(java.lang.String name)
                          throws java.lang.RuntimeException
    Fetches a relation by means of a given name.

    Parameters:
    name - the name of the desired relation
    Returns:
    the desired relation
    Throws:
    java.lang.RuntimeException - if no such relation exists.

    getDomainDefinition

    IDomainDefinition getDomainDefinition(java.lang.String name)
                                          throws java.lang.RuntimeException
    Fetches a domain definition by means of a given name.

    Parameters:
    name - the name of the desired domain definition
    Returns:
    the desired domain definition
    Throws:
    java.lang.RuntimeException - if no such domain definition exists.

    jACOB 2.7 API Documentation.