%3 ::xotcl::Object ::xotcl::Object ::xo::db::sql::content_folder ::xo::db::sql::content_folder → copy → del → delete → edit_name → get_index_page → get_label → is_empty → is_folder → is_registered → is_root → is_sub_folder → move → new → register_content_type → rename → unregister_content_type ::xo::db::sql::content_folder->::xotcl::Object

Class ::xo::db::sql::content_folder

::xo::db::sql::content_folder[i] create ...
Defined in

Class Relations

  • class: ::xo::db::Class[i]
  • superclass: ::xotcl::Object[i]
::xo::db::Class create ::xo::db::sql::content_folder \
     -superclass ::xotcl::Object

Methods (to be applied on the object)

  • copy (scripted, public)

     xo::db::sql::content_folder[i] copy [ -dbn dbn ] -folder_id folder_id  \
    -target_folder_id target_folder_id  -creation_user creation_user  \
    [ -creation_ip creation_ip ] [ -name name ] [ -label label ]

    Automatically generated method

    Switches:
    -dbn (optional)
    -folder_id (required)
    -target_folder_id (required)
    -creation_user (required)
    -creation_ip (optional)
    -name (optional)
    -label (optional)

    Testcases:
    No testcase defined.
    #function_args: {FOLDER_ID {}} {TARGET_FOLDER_ID {}} {CREATION_USER {}} {CREATION_IP null} {NAME null} {LABEL null}
foreach var [list FOLDER_ID TARGET_FOLDER_ID CREATION_USER CREATION_IP NAME LABEL]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select content_folder__copy($_FOLDER_ID, $_TARGET_FOLDER_ID, $_CREATION_USER, $_CREATION_IP, $_NAME, $_LABEL) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • del (scripted, public)

     xo::db::sql::content_folder[i] del [ -dbn dbn ] -folder_id folder_id  \
    [ -cascade_p cascade_p ]

    Automatically generated method

    Switches:
    -dbn (optional)
    -folder_id (required)
    -cascade_p (optional, defaults to "f")

    Testcases:
    No testcase defined.
    #function_args: {FOLDER_ID {}} {CASCADE_P f}
foreach var [list FOLDER_ID 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 content_folder__del($_FOLDER_ID, $_CASCADE_P) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • delete (scripted, public)

     xo::db::sql::content_folder[i] delete [ -dbn dbn ] -folder_id folder_id  \
    [ -cascade_p cascade_p ]

    Automatically generated method

    Switches:
    -dbn (optional)
    -folder_id (required)
    -cascade_p (optional, defaults to "f")

    Testcases:
    No testcase defined.
    #function_args: {FOLDER_ID {}} {CASCADE_P f}
foreach var [list FOLDER_ID 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 content_folder__delete($_FOLDER_ID, $_CASCADE_P) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • edit_name (scripted, public)

     xo::db::sql::content_folder[i] edit_name [ -dbn dbn ] \
    -folder_id folder_id  [ -name name ] [ -label label ] \
    [ -description description ]

    Automatically generated method

    Switches:
    -dbn (optional)
    -folder_id (required)
    -name (optional)
    -label (optional)
    -description (optional)

    Testcases:
    No testcase defined.
    #function_args: {FOLDER_ID {}} {NAME null} {LABEL null} {DESCRIPTION null}
foreach var [list FOLDER_ID NAME LABEL DESCRIPTION]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select content_folder__edit_name($_FOLDER_ID, $_NAME, $_LABEL, $_DESCRIPTION) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • get_index_page (scripted, public)

     xo::db::sql::content_folder[i] get_index_page [ -dbn dbn ] \
    -folder_id folder_id

    Automatically generated method

    Switches:
    -dbn (optional)
    -folder_id (required)

    Testcases:
    No testcase defined.
    #function_args: {FOLDER_ID {}}
foreach var [list FOLDER_ID]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select content_folder__get_index_page($_FOLDER_ID) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • get_label (scripted, public)

     xo::db::sql::content_folder[i] get_label [ -dbn dbn ] \
    -folder_id folder_id

    Automatically generated method

    Switches:
    -dbn (optional)
    -folder_id (required)

    Testcases:
    No testcase defined.
    #function_args: {FOLDER_ID {}}
foreach var [list FOLDER_ID]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select content_folder__get_label($_FOLDER_ID) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • is_empty (scripted, public)

     xo::db::sql::content_folder[i] is_empty [ -dbn dbn ] \
    -folder_id folder_id

    Automatically generated method

    Switches:
    -dbn (optional)
    -folder_id (required)

    Testcases:
    No testcase defined.
    #function_args: {FOLDER_ID {}}
foreach var [list FOLDER_ID]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select content_folder__is_empty($_FOLDER_ID) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • is_folder (scripted, public)

     xo::db::sql::content_folder[i] is_folder [ -dbn dbn ] -item_id item_id

    Automatically generated method

    Switches:
    -dbn (optional)
    -item_id (required)

    Testcases:
    No testcase defined.
    #function_args: {ITEM_ID {}}
foreach var [list ITEM_ID]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select content_folder__is_folder($_ITEM_ID) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • is_registered (scripted, public)

     xo::db::sql::content_folder[i] is_registered [ -dbn dbn ] \
    -folder_id folder_id  -content_type content_type  \
    [ -include_subtypes include_subtypes ]

    Automatically generated method

    Switches:
    -dbn (optional)
    -folder_id (required)
    -content_type (required)
    -include_subtypes (optional, defaults to "f")

    Testcases:
    No testcase defined.
    #function_args: {FOLDER_ID {}} {CONTENT_TYPE {}} {INCLUDE_SUBTYPES f}
foreach var [list FOLDER_ID CONTENT_TYPE INCLUDE_SUBTYPES]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select content_folder__is_registered($_FOLDER_ID, $_CONTENT_TYPE, $_INCLUDE_SUBTYPES) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • is_root (scripted, public)

     xo::db::sql::content_folder[i] is_root [ -dbn dbn ] -folder_id folder_id

    Automatically generated method

    Switches:
    -dbn (optional)
    -folder_id (required)

    Testcases:
    No testcase defined.
    #function_args: {FOLDER_ID {}}
foreach var [list FOLDER_ID]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select content_folder__is_root($_FOLDER_ID) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • is_sub_folder (scripted, public)

     xo::db::sql::content_folder[i] is_sub_folder [ -dbn dbn ] \
    -folder_id folder_id  -target_folder_id target_folder_id

    Automatically generated method

    Switches:
    -dbn (optional)
    -folder_id (required)
    -target_folder_id (required)

    Testcases:
    No testcase defined.
    #function_args: {FOLDER_ID {}} {TARGET_FOLDER_ID {}}
foreach var [list FOLDER_ID TARGET_FOLDER_ID]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select content_folder__is_sub_folder($_FOLDER_ID, $_TARGET_FOLDER_ID) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • move (scripted, public)

     xo::db::sql::content_folder[i] move [ -dbn dbn ] -folder_id folder_id  \
    -target_folder_id target_folder_id  [ -name name ]

    Automatically generated method

    Switches:
    -dbn (optional)
    -folder_id (required)
    -target_folder_id (required)
    -name (optional)

    Testcases:
    No testcase defined.
    #function_args: {FOLDER_ID {}} {TARGET_FOLDER_ID {}} {NAME null}
foreach var [list FOLDER_ID TARGET_FOLDER_ID NAME]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select content_folder__move($_FOLDER_ID, $_TARGET_FOLDER_ID, $_NAME) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • new (scripted, public)

     xo::db::sql::content_folder[i] new [ -dbn dbn ] -name name  -label label  \
    [ -description description ] [ -parent_id parent_id ] \
    [ -context_id context_id ] [ -folder_id folder_id ] \
    [ -creation_date creation_date ] [ -creation_user creation_user ] \
    [ -creation_ip creation_ip ] \
    [ -security_inherit_p security_inherit_p ] \
    [ -package_id package_id ] [ -childof childof ]

    Automatically generated method

    Switches:
    -dbn (optional)
    -name (required)
    -label (required)
    -description (optional)
    -parent_id (optional)
    -context_id (optional)
    -folder_id (optional)
    -creation_date (optional, defaults to "now")
    -creation_user (optional)
    -creation_ip (optional)
    -security_inherit_p (optional, defaults to "t")
    -package_id (optional)
    -childof (optional)

    Testcases:
    xowiki_test_cases
    #function_args: {NAME {}} {LABEL {}} {DESCRIPTION null} {PARENT_ID null} {CONTEXT_ID null} {FOLDER_ID null} {CREATION_DATE now} {CREATION_USER null} {CREATION_IP null} {SECURITY_INHERIT_P t} {PACKAGE_ID null}
foreach var [list NAME LABEL DESCRIPTION PARENT_ID CONTEXT_ID FOLDER_ID CREATION_DATE CREATION_USER CREATION_IP SECURITY_INHERIT_P PACKAGE_ID]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select content_folder__new($_NAME, $_LABEL, $_DESCRIPTION, $_PARENT_ID, $_CONTEXT_ID, $_FOLDER_ID, $_CREATION_DATE, $_CREATION_USER, $_CREATION_IP, $_SECURITY_INHERIT_P, $_PACKAGE_ID) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • register_content_type (scripted, public)

     xo::db::sql::content_folder[i] register_content_type [ -dbn dbn ] \
    -folder_id folder_id  -content_type content_type  \
    [ -include_subtypes include_subtypes ]

    Automatically generated method

    Switches:
    -dbn (optional)
    -folder_id (required)
    -content_type (required)
    -include_subtypes (optional, defaults to "f")

    Testcases:
    No testcase defined.
    #function_args: {FOLDER_ID {}} {CONTENT_TYPE {}} {INCLUDE_SUBTYPES f}
foreach var [list FOLDER_ID CONTENT_TYPE INCLUDE_SUBTYPES]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select content_folder__register_content_type($_FOLDER_ID, $_CONTENT_TYPE, $_INCLUDE_SUBTYPES) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • rename (scripted, public)

     xo::db::sql::content_folder[i] rename [ -dbn dbn ] -folder_id folder_id  \
    [ -name name ] [ -label label ] [ -description description ]

    Automatically generated method

    Switches:
    -dbn (optional)
    -folder_id (required)
    -name (optional)
    -label (optional)
    -description (optional)

    Testcases:
    No testcase defined.
    #function_args: {FOLDER_ID {}} {NAME null} {LABEL null} {DESCRIPTION null}
foreach var [list FOLDER_ID NAME LABEL DESCRIPTION]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select content_folder__rename($_FOLDER_ID, $_NAME, $_LABEL, $_DESCRIPTION) 
    "
db_with_handle -dbn $dbn db {
  #ns_log notice "--sql=$sql"
  return [ ns_set value [ns_pg_bind 0or1row $db $sql] 0 ]
}

  • unregister_content_type (scripted, public)

     xo::db::sql::content_folder[i] unregister_content_type [ -dbn dbn ] \
    -folder_id folder_id  -content_type content_type  \
    [ -include_subtypes include_subtypes ]

    Automatically generated method

    Switches:
    -dbn (optional)
    -folder_id (required)
    -content_type (required)
    -include_subtypes (optional, defaults to "f")

    Testcases:
    No testcase defined.
    #function_args: {FOLDER_ID {}} {CONTENT_TYPE {}} {INCLUDE_SUBTYPES f}
foreach var [list FOLDER_ID CONTENT_TYPE INCLUDE_SUBTYPES]  {
  set varname [string tolower $var]
  if {[info exists $varname]} {
    set $var [set $varname]
    set _$var :$var
  } else {
    set _$var null
  }
}
set sql "
select content_folder__unregister_content_type($_FOLDER_ID, $_CONTENT_TYPE, $_INCLUDE_SUBTYPES) 
    "
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::content_folder set __default_metaclass ::xotcl::Class
::xo::db::sql::content_folder set __default_superclass ::xotcl::Object
::xo::db::sql::content_folder set abstract_p f
::xo::db::sql::content_folder set auto_save false
::xo::db::sql::content_folder set name_method {}
::xo::db::sql::content_folder set object_type ::xo::db::sql::content_folder
::xo::db::sql::content_folder set security_inherit_p t
::xo::db::sql::content_folder set sql_package_name content_folder
::xo::db::sql::content_folder set supertype acs_object
::xo::db::sql::content_folder set with_table true