::xo::db::Class ::xo::db::sql::apm

Methods: All Methods Documented Methods Hide Methods
Source: Display Source Hide Source
Variables: Show Variables Hide Variables

Class ::xo::db::sql::apm

::xo::db::sql::apm

create ...

Defined in

Class Relations

class: ::xo::db::Class
superclass: ::xotcl::Object

::xo::db::Class create ::xo::db::sql::apm \
     -superclass ::xotcl::Object

Methods (to be applied on the object)

get_value (scripted, public)

 xo::db::sql::apm get_value [ -dbn dbn ] -package_id package_id  \
    -parameter_name parameter_name

Automatically generated method

Switches:

-dbn (optional)
-package_id (required)
-parameter_name (required)

Testcases:
No testcase defined.

#function_args: {PACKAGE_ID {}} {PARAMETER_NAME {}}
foreach var [list PACKAGE_ID PARAMETER_NAME]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__get_value($_PACKAGE_ID, $_PARAMETER_NAME) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

id_for_name (scripted, public)

 xo::db::sql::apm id_for_name [ -dbn dbn ] -package_key package_key  \
    -parameter_name parameter_name

Automatically generated method

Switches:

-dbn (optional)
-package_key (required)
-parameter_name (required)

Testcases:
No testcase defined.

#function_args: {PACKAGE_KEY {}} {PARAMETER_NAME {}}
foreach var [list PACKAGE_KEY PARAMETER_NAME]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__id_for_name($_PACKAGE_KEY, $_PARAMETER_NAME) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

parameter_p (scripted, public)

 xo::db::sql::apm parameter_p [ -dbn dbn ] -package_key package_key  \
    -parameter_name parameter_name

Automatically generated method

Switches:

-dbn (optional)
-package_key (required)
-parameter_name (required)

Testcases:
No testcase defined.

#function_args: {PACKAGE_KEY {}} {PARAMETER_NAME {}}
foreach var [list PACKAGE_KEY PARAMETER_NAME]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__parameter_p($_PACKAGE_KEY, $_PARAMETER_NAME) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

register_application (scripted, public)

 xo::db::sql::apm register_application [ -dbn dbn ] \
    -package_key package_key  -pretty_name pretty_name  \
    -pretty_plural pretty_plural  -package_uri package_uri  \
    [ -initial_install_p initial_install_p ] \
    [ -singleton_p singleton_p ] \
    [ -implements_subsite_p implements_subsite_p ] \
    [ -inherit_templates_p inherit_templates_p ] \
    [ -spec_file_path spec_file_path ] \
    [ -spec_file_mtime spec_file_mtime ]

Automatically generated method

Switches:

-dbn (optional)
-package_key (required)
-pretty_name (required)
-pretty_plural (required)
-package_uri (required)
-initial_install_p (optional, defaults to "f")
-singleton_p (optional, defaults to "f")
-implements_subsite_p (optional, defaults to "f")
-inherit_templates_p (optional, defaults to "f")
-spec_file_path (optional)
-spec_file_mtime (optional)

Testcases:
No testcase defined.

#function_args: {PACKAGE_KEY {}} {PRETTY_NAME {}} {PRETTY_PLURAL {}} {PACKAGE_URI {}} {INITIAL_INSTALL_P f} {SINGLETON_P f} {IMPLEMENTS_SUBSITE_P f} {INHERIT_TEMPLATES_P f} {SPEC_FILE_PATH null} {SPEC_FILE_MTIME null}
foreach var [list PACKAGE_KEY PRETTY_NAME PRETTY_PLURAL PACKAGE_URI INITIAL_INSTALL_P SINGLETON_P IMPLEMENTS_SUBSITE_P INHERIT_TEMPLATES_P SPEC_FILE_PATH SPEC_FILE_MTIME]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__register_application($_PACKAGE_KEY, $_PRETTY_NAME, $_PRETTY_PLURAL, $_PACKAGE_URI, $_INITIAL_INSTALL_P, $_SINGLETON_P, $_IMPLEMENTS_SUBSITE_P, $_INHERIT_TEMPLATES_P, $_SPEC_FILE_PATH, $_SPEC_FILE_MTIME) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

register_p (scripted, public)

 xo::db::sql::apm register_p [ -dbn dbn ] -package_key package_key

Automatically generated method

Switches:

-dbn (optional)
-package_key (required)

Testcases:
No testcase defined.

#function_args: {PACKAGE_KEY {}}
foreach var [list PACKAGE_KEY]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__register_p($_PACKAGE_KEY) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

register_package (scripted, public)

 xo::db::sql::apm register_package [ -dbn dbn ] \
    -package_key package_key  -pretty_name pretty_name  \
    -pretty_plural pretty_plural  -package_uri package_uri  \
    -package_type package_type  \
    [ -initial_install_p initial_install_p ] \
    [ -singleton_p singleton_p ] \
    [ -implements_subsite_p implements_subsite_p ] \
    [ -inherit_templates_p inherit_templates_p ] \
    [ -spec_file_path spec_file_path ] \
    [ -spec_file_mtime spec_file_mtime ]

Automatically generated method

Switches:

-dbn (optional)
-package_key (required)
-pretty_name (required)
-pretty_plural (required)
-package_uri (required)
-package_type (required)
-initial_install_p (optional, defaults to "f")
-singleton_p (optional, defaults to "f")
-implements_subsite_p (optional, defaults to "f")
-inherit_templates_p (optional, defaults to "f")
-spec_file_path (optional)
-spec_file_mtime (optional)

Testcases:
No testcase defined.

#function_args: {PACKAGE_KEY {}} {PRETTY_NAME {}} {PRETTY_PLURAL {}} {PACKAGE_URI {}} {PACKAGE_TYPE {}} {INITIAL_INSTALL_P f} {SINGLETON_P f} {IMPLEMENTS_SUBSITE_P f} {INHERIT_TEMPLATES_P f} {SPEC_FILE_PATH null} {SPEC_FILE_MTIME null}
foreach var [list PACKAGE_KEY PRETTY_NAME PRETTY_PLURAL PACKAGE_URI PACKAGE_TYPE INITIAL_INSTALL_P SINGLETON_P IMPLEMENTS_SUBSITE_P INHERIT_TEMPLATES_P SPEC_FILE_PATH SPEC_FILE_MTIME]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__register_package($_PACKAGE_KEY, $_PRETTY_NAME, $_PRETTY_PLURAL, $_PACKAGE_URI, $_PACKAGE_TYPE, $_INITIAL_INSTALL_P, $_SINGLETON_P, $_IMPLEMENTS_SUBSITE_P, $_INHERIT_TEMPLATES_P, $_SPEC_FILE_PATH, $_SPEC_FILE_MTIME) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

register_parameter (scripted, public)

 xo::db::sql::apm register_parameter [ -dbn dbn ] \
    [ -parameter_id parameter_id ] -package_key package_key  \
    -parameter_name parameter_name  [ -description description ] \
    -scope scope  [ -datatype datatype ] \
    [ -default_value default_value ] [ -section_name section_name ] \
    [ -min_n_values min_n_values ] [ -max_n_values max_n_values ]

Automatically generated method

Switches:

-dbn (optional)
-parameter_id (optional)
-package_key (required)
-parameter_name (required)
-description (optional)
-scope (required)
-datatype (optional, defaults to "string")
-default_value (optional)
-section_name (optional)
-min_n_values (optional, defaults to "1")
-max_n_values (optional, defaults to "1")

Testcases:
No testcase defined.

#function_args: {PARAMETER_ID null} {PACKAGE_KEY {}} {PARAMETER_NAME {}} {DESCRIPTION null} {SCOPE {}} {DATATYPE string} {DEFAULT_VALUE null} {SECTION_NAME null} {MIN_N_VALUES 1} {MAX_N_VALUES 1}
foreach var [list PARAMETER_ID PACKAGE_KEY PARAMETER_NAME DESCRIPTION SCOPE DATATYPE DEFAULT_VALUE SECTION_NAME MIN_N_VALUES MAX_N_VALUES]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__register_parameter($_PARAMETER_ID, $_PACKAGE_KEY, $_PARAMETER_NAME, $_DESCRIPTION, $_SCOPE, $_DATATYPE, $_DEFAULT_VALUE, $_SECTION_NAME, $_MIN_N_VALUES, $_MAX_N_VALUES) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

register_service (scripted, public)

 xo::db::sql::apm register_service [ -dbn dbn ] \
    -package_key package_key  -pretty_name pretty_name  \
    -pretty_plural pretty_plural  -package_uri package_uri  \
    [ -initial_install_p initial_install_p ] \
    [ -singleton_p singleton_p ] \
    [ -implements_subsite_p implements_subsite_p ] \
    [ -inherit_templates_p inherit_templates_p ] \
    [ -spec_file_path spec_file_path ] \
    [ -spec_file_mtime spec_file_mtime ]

Automatically generated method

Switches:

-dbn (optional)
-package_key (required)
-pretty_name (required)
-pretty_plural (required)
-package_uri (required)
-initial_install_p (optional, defaults to "f")
-singleton_p (optional, defaults to "f")
-implements_subsite_p (optional, defaults to "f")
-inherit_templates_p (optional, defaults to "f")
-spec_file_path (optional)
-spec_file_mtime (optional)

Testcases:
No testcase defined.

#function_args: {PACKAGE_KEY {}} {PRETTY_NAME {}} {PRETTY_PLURAL {}} {PACKAGE_URI {}} {INITIAL_INSTALL_P f} {SINGLETON_P f} {IMPLEMENTS_SUBSITE_P f} {INHERIT_TEMPLATES_P f} {SPEC_FILE_PATH null} {SPEC_FILE_MTIME null}
foreach var [list PACKAGE_KEY PRETTY_NAME PRETTY_PLURAL PACKAGE_URI INITIAL_INSTALL_P SINGLETON_P IMPLEMENTS_SUBSITE_P INHERIT_TEMPLATES_P SPEC_FILE_PATH SPEC_FILE_MTIME]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__register_service($_PACKAGE_KEY, $_PRETTY_NAME, $_PRETTY_PLURAL, $_PACKAGE_URI, $_INITIAL_INSTALL_P, $_SINGLETON_P, $_IMPLEMENTS_SUBSITE_P, $_INHERIT_TEMPLATES_P, $_SPEC_FILE_PATH, $_SPEC_FILE_MTIME) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

set_global_value (scripted, public)

 xo::db::sql::apm set_global_value [ -dbn dbn ] \
    -package_key package_key  -parameter_name parameter_name  \
    -attr_value attr_value

Automatically generated method

Switches:

-dbn (optional)
-package_key (required)
-parameter_name (required)
-attr_value (required)

Testcases:
No testcase defined.

#function_args: {PACKAGE_KEY {}} {PARAMETER_NAME {}} {ATTR_VALUE {}}
foreach var [list PACKAGE_KEY PARAMETER_NAME ATTR_VALUE]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__set_global_value($_PACKAGE_KEY, $_PARAMETER_NAME, $_ATTR_VALUE) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

set_value (scripted, public)

 xo::db::sql::apm set_value [ -dbn dbn ] -package_id package_id  \
    -parameter_name parameter_name  -attr_value attr_value

Automatically generated method

Switches:

-dbn (optional)
-package_id (required)
-parameter_name (required)
-attr_value (required)

Testcases:
No testcase defined.

#function_args: {PACKAGE_ID {}} {PARAMETER_NAME {}} {ATTR_VALUE {}}
foreach var [list PACKAGE_ID PARAMETER_NAME ATTR_VALUE]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__set_value($_PACKAGE_ID, $_PARAMETER_NAME, $_ATTR_VALUE) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

unregister_application (scripted, public)

 xo::db::sql::apm unregister_application [ -dbn dbn ] \
    -package_key package_key  [ -cascade_p cascade_p ]

Automatically generated method

Switches:

-dbn (optional)
-package_key (required)
-cascade_p (optional, defaults to "f")

Testcases:
No testcase defined.

#function_args: {PACKAGE_KEY {}} {CASCADE_P f}
foreach var [list PACKAGE_KEY CASCADE_P]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__unregister_application($_PACKAGE_KEY, $_CASCADE_P) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

unregister_package (scripted, public)

 xo::db::sql::apm unregister_package [ -dbn dbn ] \
    -package_key package_key  [ -cascade_p cascade_p ]

Automatically generated method

Switches:

-dbn (optional)
-package_key (required)
-cascade_p (optional, defaults to "t")

Testcases:
No testcase defined.

#function_args: {PACKAGE_KEY {}} {CASCADE_P t}
foreach var [list PACKAGE_KEY CASCADE_P]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__unregister_package($_PACKAGE_KEY, $_CASCADE_P) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

unregister_parameter (scripted, public)

 xo::db::sql::apm unregister_parameter [ -dbn dbn ] \
    [ -parameter_id parameter_id ]

Automatically generated method

Switches:

-dbn (optional)
-parameter_id (optional)

Testcases:
No testcase defined.

#function_args: {PARAMETER_ID null}
foreach var [list PARAMETER_ID]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__unregister_parameter($_PARAMETER_ID) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

unregister_service (scripted, public)

 xo::db::sql::apm unregister_service [ -dbn dbn ] \
    -package_key package_key  [ -cascade_p cascade_p ]

Automatically generated method

Switches:

-dbn (optional)
-package_key (required)
-cascade_p (optional, defaults to "f")

Testcases:
No testcase defined.

#function_args: {PACKAGE_KEY {}} {CASCADE_P f}
foreach var [list PACKAGE_KEY CASCADE_P]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__unregister_service($_PACKAGE_KEY, $_CASCADE_P) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

update_package (scripted, public)

 xo::db::sql::apm update_package [ -dbn dbn ] -package_key package_key  \
    [ -pretty_name pretty_name ] [ -pretty_plural pretty_plural ] \
    [ -package_uri package_uri ] [ -package_type package_type ] \
    [ -initial_install_p initial_install_p ] \
    [ -singleton_p singleton_p ] \
    [ -implements_subsite_p implements_subsite_p ] \
    [ -inherit_templates_p inherit_templates_p ] \
    [ -spec_file_path spec_file_path ] \
    [ -spec_file_mtime spec_file_mtime ]

Automatically generated method

Switches:

-dbn (optional)
-package_key (required)
-pretty_name (optional)
-pretty_plural (optional)
-package_uri (optional)
-package_type (optional)
-initial_install_p (optional)
-singleton_p (optional)
-implements_subsite_p (optional, defaults to "f")
-inherit_templates_p (optional, defaults to "f")
-spec_file_path (optional)
-spec_file_mtime (optional)

Testcases:
No testcase defined.

#function_args: {PACKAGE_KEY {}} {PRETTY_NAME null} {PRETTY_PLURAL null} {PACKAGE_URI null} {PACKAGE_TYPE null} {INITIAL_INSTALL_P null} {SINGLETON_P null} {IMPLEMENTS_SUBSITE_P f} {INHERIT_TEMPLATES_P f} {SPEC_FILE_PATH null} {SPEC_FILE_MTIME null}
foreach var [list PACKAGE_KEY PRETTY_NAME PRETTY_PLURAL PACKAGE_URI PACKAGE_TYPE INITIAL_INSTALL_P SINGLETON_P IMPLEMENTS_SUBSITE_P INHERIT_TEMPLATES_P SPEC_FILE_PATH SPEC_FILE_MTIME]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__update_package($_PACKAGE_KEY, $_PRETTY_NAME, $_PRETTY_PLURAL, $_PACKAGE_URI, $_PACKAGE_TYPE, $_INITIAL_INSTALL_P, $_SINGLETON_P, $_IMPLEMENTS_SUBSITE_P, $_INHERIT_TEMPLATES_P, $_SPEC_FILE_PATH, $_SPEC_FILE_MTIME) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

update_parameter (scripted, public)

 xo::db::sql::apm update_parameter [ -dbn dbn ] \
    -parameter_id parameter_id  [ -parameter_name parameter_name ] \
    [ -description description ] [ -datatype datatype ] \
    [ -default_value default_value ] [ -section_name section_name ] \
    [ -min_n_values min_n_values ] [ -max_n_values max_n_values ]

Automatically generated method

Switches:

-dbn (optional)
-parameter_id (required)
-parameter_name (optional)
-description (optional)
-datatype (optional, defaults to "string")
-default_value (optional)
-section_name (optional)
-min_n_values (optional, defaults to "1")
-max_n_values (optional, defaults to "1")

Testcases:
No testcase defined.

#function_args: {PARAMETER_ID {}} {PARAMETER_NAME null} {DESCRIPTION null} {DATATYPE string} {DEFAULT_VALUE null} {SECTION_NAME null} {MIN_N_VALUES 1} {MAX_N_VALUES 1}
foreach var [list PARAMETER_ID PARAMETER_NAME DESCRIPTION DATATYPE DEFAULT_VALUE SECTION_NAME MIN_N_VALUES MAX_N_VALUES]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select apm__update_parameter($_PARAMETER_ID, $_PARAMETER_NAME, $_DESCRIPTION, $_DATATYPE, $_DEFAULT_VALUE, $_SECTION_NAME, $_MIN_N_VALUES, $_MAX_N_VALUES) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

Variables

::xo::db::sql::apm set __default_metaclass ::xotcl::Class
::xo::db::sql::apm set __default_superclass ::xotcl::Object
::xo::db::sql::apm set abstract_p f
::xo::db::sql::apm set auto_save false
::xo::db::sql::apm set name_method {}
::xo::db::sql::apm set object_type ::xo::db::sql::apm
::xo::db::sql::apm set security_inherit_p t
::xo::db::sql::apm set sql_package_name apm
::xo::db::sql::apm set supertype acs_object
::xo::db::sql::apm set with_table true

Methods: All Methods Documented Methods Hide Methods
Source: Display Source Hide Source
Variables: Show Variables Hide Variables