• Publicity: Public Only All

content-keyword-procs.tcl

Procedures for content_keywords

Location:
packages/acs-content-repository/tcl/content-keyword-procs.tcl
Created:
2004-06-09
Author:
Dave Bauer <dave@thedesignexperience.org>
CVS Identification:
$Id: content-keyword-procs.tcl,v 1.6.2.1 2019/03/13 10:11:27 antoniop Exp $

Procedures in this file

Detailed information

content::keyword::delete (public)

 content::keyword::delete -keyword_id keyword_id
Switches:
-keyword_id (required)
Returns:
0

Testcases:
acs_content_repository_trivial_smoke_test, content_keyword

content::keyword::get_children (public)

 content::keyword::get_children [ -parent_id parent_id ]

Returns the ids of the keywords having the given parent_id. Returns an empty list if there are no children.

Switches:
-parent_id (optional)
Author:
Peter Marklund

Testcases:
acs_content_repository_trivial_smoke_test

content::keyword::get_description (public)

 content::keyword::get_description -keyword_id keyword_id
Switches:
-keyword_id (required)
Returns:
string with description

Testcases:
content_keyword

content::keyword::get_heading (public)

 content::keyword::get_heading -keyword_id keyword_id
Switches:
-keyword_id (required)
Returns:
string with heading

Testcases:
content_keyword

content::keyword::get_keyword_id (public)

 content::keyword::get_keyword_id -parent_id parent_id -heading heading

Get the keyword with the given heading under the given parent. Returns the empty string if none exists.

Switches:
-parent_id (required)
-heading (required)

Testcases:
No testcase defined.

content::keyword::get_options_flat (public)

 content::keyword::get_options_flat [ -parent_id parent_id ]

Returns a flat options list of the keywords with the given parent_id.

Switches:
-parent_id (optional)

Testcases:
No testcase defined.

content::keyword::get_path (public)

 content::keyword::get_path -keyword_id keyword_id
Switches:
-keyword_id (required)
Returns:
"/" delimited path in the keyword tree to the supplied keyword

Testcases:
No testcase defined.

content::keyword::is_assigned (public)

 content::keyword::is_assigned -item_id item_id -keyword_id keyword_id \
    [ -recurse recurse ]
Switches:
-item_id (required)
-keyword_id (required)
-recurse (optional)
Returns:
t or f

Testcases:
No testcase defined.

content::keyword::is_leaf (public)

 content::keyword::is_leaf -keyword_id keyword_id
Switches:
-keyword_id (required)
Returns:
t or f

Testcases:
No testcase defined.

content::keyword::item_assign (public)

 content::keyword::item_assign -item_id item_id -keyword_id keyword_id \
    [ -context_id context_id ] [ -creation_user creation_user ] \
    [ -creation_ip creation_ip ]
Switches:
-item_id (required)
-keyword_id (required)
-context_id (optional)
-creation_user (optional)
-creation_ip (optional)
Associate a keyword with a CR item.
Returns:
0

Testcases:
No testcase defined.

content::keyword::item_get_assigned (public)

 content::keyword::item_get_assigned -item_id item_id \
    [ -parent_id parent_id ]

Returns a list of all keywords assigned to the given cr_item. If parent_id is supplied, only keywords that are children of parent_id are listed.

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

Testcases:
No testcase defined.

content::keyword::item_unassign (public)

 content::keyword::item_unassign -item_id item_id \
    -keyword_id keyword_id
Switches:
-item_id (required)
-keyword_id (required)
Returns:
0

Testcases:
No testcase defined.

content::keyword::item_unassign_children (public)

 content::keyword::item_unassign_children -item_id item_id \
    -parent_id parent_id

Unassign all the keywords attached to a content item that are children of keyword parent_id. Returns the supplied item_id for convenience.

Switches:
-item_id (required)
-parent_id (required)

Testcases:
No testcase defined.

content::keyword::new (public)

 content::keyword::new -heading heading [ -description description ] \
    [ -parent_id parent_id ] [ -keyword_id keyword_id ] \
    [ -creation_date creation_date ] [ -creation_user creation_user ] \
    [ -creation_ip creation_ip ] [ -object_type object_type ]
Switches:
-heading (required)
-description (optional)
-parent_id (optional)
-keyword_id (optional)
-creation_date (optional)
-creation_user (optional)
-creation_ip (optional)
-object_type (optional)
Returns:
keyword_id of created keyword

Testcases:
acs_content_repository_trivial_smoke_test, content_keyword

content::keyword::set_description (public)

 content::keyword::set_description -keyword_id keyword_id \
    -description description
Switches:
-keyword_id (required)
-description (required)
Returns:
0

Testcases:
No testcase defined.

content::keyword::set_heading (public)

 content::keyword::set_heading -keyword_id keyword_id -heading heading
Switches:
-keyword_id (required)
-heading (required)
Returns:
0

Testcases:
No testcase defined.

content::keyword::write_to_file (public)

 content::keyword::write_to_file -item_id item_id -root_path root_path
Switches:
-item_id (required)
-root_path (required)

Testcases:
No testcase defined.
[ show source ]