Page Comparison

edm.edom3

Interface EDMDatabase

• ---

  
  

  public interface EDMDatabase

  
  The EDMDatabase interface is used to 
  - retrieve info about an EDM database without opening it - open / close / create / delete EDM database

• • Method Summary

    All Methods Instance Methods Abstract Methods 

    Modifier and Type	Method and Description
    void	close() Closes an open EDMdatabase.
    void	create() Creates a new EDMdatabase and attach the actual EDMdatabase to the EDMserver used by the caller.
    void	delete() Delete an existing EDMdatabase, i.e.
    boolean	exists() Check database existance
    int	getBlockSize() Get database block size.
    int	getMaxModels() Get database max models.
    int	getVersion() Get database version
    void	open() Opens an existing EDMdatabase and attach the actual EDMdatabase to the EDMserver used by the caller.

    
    

• • Method Detail

    • close

      void close()
          throws EdmiException

      
      Closes an open EDMdatabase. No access to the actual EDMdatabase is permitted until the EDMdatabase is opened by the openDatabase() call. To ensure database consistency, an invocation of the closeDatabase call should always be performed to terminate the access to an EDMdatabase from an application program. Before the current open EDMdatabase is closed, all open repositories and all open models in the actual EDMdatabase will be closed to ensure database consistency. When an open EDMserver session exists upon call to closeDatabase(), the open EDMserver session will be closed. If the calling user is connected to the EDMserver the closeDatabase() call will disconnect the calling user from the EDMserver.

      Throws:EdmiException - If the method fails.

    • open

      void open()
         throws EdmiException

      
      Opens an existing EDMdatabase and attach the actual EDMdatabase to the EDMserver used by the caller. An EDMdatabase must be open before any access to the database is permitted. In a single-user system the EDMserver is embedded in the EDMinterface, in a multi-user system the EDMserver is running as a separate process on the same system or on another system than the caller. One EDMServer can handle only one single EDMdatabase at a time, i.e. the currently opened database must be closed before another one can be opened.

      Throws:EdmiException - If the method fails.

    • create

      void create()
           throws EdmiException

      
      Creates a new EDMdatabase and attach the actual EDMdatabase to the EDMserver used by the caller. No EDMdatabase can be open when this call is used.

      Throws:EdmiException - If the method fails.

    • delete

      void delete()
           throws EdmiException

      
      Delete an existing EDMdatabase, i.e. delete all data belonging to the actual database. After this function is performed, the actual database is non existing, hence the data in a deleted EDMdatabase cannot be recovered. Only closed databases can be deleted.

      Throws:EdmiException - If the method fails.

    • exists

      boolean exists()
              throws EdmiException

      
      Check database existance

      Returns:true if the database existsThrows:EdmiException - if the method fails.

    • getVersion

      int getVersion()
              throws EdmiException

      
      Get database version

      Returns:database versionThrows:EdmiException - if the method fails.

    • getBlockSize

      int getBlockSize()
                throws EdmiException

      
      Get database block size.

      Returns:database block sizeThrows:EdmiException - if the method fails.

    • getMaxModels

      int getMaxModels()
                throws EdmiException

      
      Get database max models.

      Returns:database max models sizeThrows:EdmiException - if the method fails.