Formspider APIs


Package api_versioncontrol


Method Summary
  adddbobject(in_schema_cd IN varchar2, in_type_cd IN varchar2, in_name_tx IN varchar2, in_reponame_tx IN varchar2)
           Registers a Database Object to the Formspider Version Control System.
  checkoutdbobject(in_schema_cd IN varchar2, in_type_cd IN varchar2, in_name_tx IN varchar2)
           Locks a Database Object for the logged in user to edit.
  dropdbobject(in_schema_cd IN varchar2, in_type_cd IN varchar2, in_name_tx IN varchar2)
          
 number getcurrentuserid()
           Returns the current signed in Formspider user id.
  login(in_user_cd IN varchar2, in_password_tx IN varchar2)
           Signs in a Formspider User to the version control system.
  logout()
           Signs out the Formspider User out of the version control system.
  modifydbobject(in_schema_cd IN varchar2, in_type_cd IN varchar2, in_name_tx IN varchar2, in_gettriggeringddl_yn IN varchar2 DEFAULT 'Y')
          
  releasedbobject(in_schema_cd IN varchar2, in_type_cd IN varchar2, in_name_tx IN varchar2)
           Unlocks the database object and make it available for other developers.
 varchar2 type_function()
           Constant that represents the FUNCTION object type.
 varchar2 type_package()
           Constant that represents the PACKAGE object type.
 varchar2 type_procedure()
           Constant that represents the PROCEDURE object type.
 varchar2 type_synonym()
           Constant that represents the SYNONYM object type.
 varchar2 type_trigger()
           Constant that represents the TRIGGER object type.
 varchar2 type_view()
           Constant that represents the VIEW object type.

Method Detail

adddbobject

public  adddbobject(in_schema_cd IN varchar2, 
in_type_cd IN varchar2,
in_name_tx IN varchar2,
in_reponame_tx IN varchar2)
Registers a Database Object to the Formspider Version Control System.
Parameters:
in_schema_cd - The Oracle schema the database object is in.
in_type_cd - The type of the database object.
in_name_tx - The name of the database object.
in_reponame_tx - The name of the Git repository to add the database object. An applications name is identical to its Git repo name.
Throws:
ora-20001 - Raised when the log in attempt is not successful.


checkoutdbobject

public  checkoutdbobject(in_schema_cd IN varchar2, 
in_type_cd IN varchar2,
in_name_tx IN varchar2)
Locks a Database Object for the logged in user to edit.
Parameters:
in_schema_cd - The Oracle schema the database object is in.
in_type_cd - The type of the database object.
in_name_tx - The name of the database object.
Throws:
ora-20001 - Raised when the checkout attempt is not successful.


dropdbobject

public  dropdbobject(in_schema_cd IN varchar2, 
in_type_cd IN varchar2,
in_name_tx IN varchar2)


getcurrentuserid

public number getcurrentuserid()
Returns the current signed in Formspider user id.


login

public  login(in_user_cd IN varchar2, 
in_password_tx IN varchar2)
Signs in a Formspider User to the version control system.
Parameters:
in_user_cd - Formspider user name. The user name used to log in to Formspider IDE
in_password_tx - the user's password
Throws:
ora-20001 - Raised when the log in attempt is not successful.


logout

public  logout()
Signs out the Formspider User out of the version control system.


modifydbobject

public  modifydbobject(in_schema_cd IN varchar2, 
in_type_cd IN varchar2,
in_name_tx IN varchar2,
in_gettriggeringddl_yn IN varchar2 DEFAULT 'Y')


releasedbobject

public  releasedbobject(in_schema_cd IN varchar2, 
in_type_cd IN varchar2,
in_name_tx IN varchar2)
Unlocks the database object and make it available for other developers. ReleaseDBObject only works if the database object is not modified since the checkout.
Parameters:
in_schema_cd - The Oracle schema the database object is in.
in_type_cd - The type of the database object.
in_name_tx - The name of the database object.
Throws:
ora-20001 - Raised when the release attempt is not successful.


type_function

public varchar2 type_function()
Constant that represents the FUNCTION object type.


type_package

public varchar2 type_package()
Constant that represents the PACKAGE object type.


type_procedure

public varchar2 type_procedure()
Constant that represents the PROCEDURE object type.


type_synonym

public varchar2 type_synonym()
Constant that represents the SYNONYM object type.


type_trigger

public varchar2 type_trigger()
Constant that represents the TRIGGER object type.


type_view

public varchar2 type_view()
Constant that represents the VIEW object type.


Formspider APIs