news-procs.tcl

Utility functions for News Application

Location:
packages/news/tcl/news-procs.tcl
Created:
12-14-00
Author:
stefan@arsdigita.com
CVS Identification:
$Id: news-procs.tcl,v 1.41.2.3 2023/02/20 17:40:07 antoniop Exp $

Procedures in this file

Detailed information

news::sc::register_news_fts_impl (private)

 news::sc::register_news_fts_impl

Partial Call Graph (max 5 caller/called nodes):
%3 news::install::after_install news::install::after_install (private) news::sc::register_news_fts_impl news::sc::register_news_fts_impl news::install::after_install->news::sc::register_news_fts_impl acs_sc::impl::new_from_spec acs_sc::impl::new_from_spec (public) news::sc::register_news_fts_impl->acs_sc::impl::new_from_spec

Testcases:
No testcase defined.

news::sc::unregister_news_fts_impl (private)

 news::sc::unregister_news_fts_impl

Partial Call Graph (max 5 caller/called nodes):
%3 acs_sc::impl::delete acs_sc::impl::delete (public) db_transaction db_transaction (public) news::sc::unregister_news_fts_impl news::sc::unregister_news_fts_impl news::sc::unregister_news_fts_impl->acs_sc::impl::delete news::sc::unregister_news_fts_impl->db_transaction

Testcases:
No testcase defined.

news__datasource (private)

 news__datasource object_id

This proc implements the 'datasource' operation of the FtsContentProvider Service Contract and should not be invoke directly.

Parameters:
object_id (required)
Author:
Jeff Davis <davis@xarg.net>

Partial Call Graph (max 5 caller/called nodes):
%3 ad_url ad_url (public) db_1row db_1row (public) news_util_get_url news_util_get_url (public) template::adp_include template::adp_include (public) news__datasource news__datasource news__datasource->ad_url news__datasource->db_1row news__datasource->news_util_get_url news__datasource->template::adp_include

Testcases:
No testcase defined.

news__last_updated (private)

 news__last_updated package_id

Return the timestamp of the most recent item in this news instance. This proc implements the 'lastUpdated' operation of the 'RssGenerationSubscriber' Service Contract and should not be invoked directly.

Parameters:
package_id (required)
Author:
Dave Bauer <dave@thedesignexperience.org>
Created:
2005-01-22

Partial Call Graph (max 5 caller/called nodes):
%3 AcsSc.rssgenerationsubscriber.lastupdated.news AcsSc.rssgenerationsubscriber.lastupdated.news (private) news__last_updated news__last_updated AcsSc.rssgenerationsubscriber.lastupdated.news->news__last_updated db_string db_string (public) news__last_updated->db_string

Testcases:
No testcase defined.

news__rss_datasource (private)

 news__rss_datasource summary_context_id

This procedure implements the 'datasource' operation of the 'RssGenerationSubscriber' Service Contract and should not be invoked directly.

Parameters:
summary_context_id (required)
Author:
Dave Bauer <dave@thedesignexperience.org>

Partial Call Graph (max 5 caller/called nodes):
%3 AcsSc.rssgenerationsubscriber.datasource.news AcsSc.rssgenerationsubscriber.datasource.news (private) news__rss_datasource news__rss_datasource AcsSc.rssgenerationsubscriber.datasource.news->news__rss_datasource _ _ (public) news__rss_datasource->_ ad_html_text_convert ad_html_text_convert (public) news__rss_datasource->ad_html_text_convert ad_system_name ad_system_name (public) news__rss_datasource->ad_system_name ad_url ad_url (public) news__rss_datasource->ad_url db_foreach db_foreach (public) news__rss_datasource->db_foreach

Testcases:
No testcase defined.

news__url (private)

 news__url object_id

Returns the URL for specified news object. This proc implements the 'url' operation of the 'FtsContentProvider' Service Contract and should not be invoked directly.

Parameters:
object_id (required)
Author:
Robert Locke

Partial Call Graph (max 5 caller/called nodes):
%3 ad_url ad_url (public) apm_package_url_from_id apm_package_url_from_id (public) db_1row db_1row (public) news__url news__url news__url->ad_url news__url->apm_package_url_from_id news__url->db_1row

Testcases:
No testcase defined.

news_do_notification (public)

 news_do_notification news_package_id news_id

Sends notifications for specified news item.

Parameters:
news_package_id (required)
news_id (required)

Partial Call Graph (max 5 caller/called nodes):
%3 packages/news/www/item-create-3.tcl packages/news/ www/item-create-3.tcl news_do_notification news_do_notification packages/news/www/item-create-3.tcl->news_do_notification ad_conn ad_conn (public) news_do_notification->ad_conn ad_html_text_convert ad_html_text_convert (public) news_do_notification->ad_html_text_convert apm_package_url_from_id apm_package_url_from_id (public) news_do_notification->apm_package_url_from_id application_group::closest_ancestor_element application_group::closest_ancestor_element (public) news_do_notification->application_group::closest_ancestor_element db_0or1row db_0or1row (public) news_do_notification->db_0or1row

Testcases:
No testcase defined.

news_items_archive (public)

 news_items_archive id_list when

Immediately gives all news items in list id_list a status of archived as of ANSI date in when, i.e. when must be like 2000-10-11.

Parameters:
id_list (required)
when (required)

Partial Call Graph (max 5 caller/called nodes):
%3 packages/news/www/admin/process-2.tcl packages/news/ www/admin/process-2.tcl news_items_archive news_items_archive packages/news/www/admin/process-2.tcl->news_items_archive db_exec_plsql db_exec_plsql (public) news_items_archive->db_exec_plsql

Testcases:
No testcase defined.

news_items_delete (public)

 news_items_delete id_list

Deletes all news items with news_id in id_list.

Parameters:
id_list (required)

Partial Call Graph (max 5 caller/called nodes):
%3 news::install::before_uninstantiate news::install::before_uninstantiate (private) news_items_delete news_items_delete news::install::before_uninstantiate->news_items_delete packages/news/www/admin/process-2.tcl packages/news/ www/admin/process-2.tcl packages/news/www/admin/process-2.tcl->news_items_delete db_exec_plsql db_exec_plsql (public) news_items_delete->db_exec_plsql

Testcases:
No testcase defined.

news_items_make_permanent (public)

 news_items_make_permanent id_list

Immediately gives all news items in list id_list a status of permanently published.

Parameters:
id_list (required)

Partial Call Graph (max 5 caller/called nodes):
%3 packages/news/www/admin/process-2.tcl packages/news/ www/admin/process-2.tcl news_items_make_permanent news_items_make_permanent packages/news/www/admin/process-2.tcl->news_items_make_permanent db_exec_plsql db_exec_plsql (public) news_items_make_permanent->db_exec_plsql

Testcases:
No testcase defined.

news_notification_get_url (public)

 news_notification_get_url news_package_id

Get package URL from package_id. If this was mounted multiple times, only the first occurrence will be returned. This proc could be deprecated in the future.

Parameters:
news_package_id (required)
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 AcsSc.notificationtype.geturl.news_item_notif_type AcsSc.notificationtype.geturl.news_item_notif_type (private) news_notification_get_url news_notification_get_url AcsSc.notificationtype.geturl.news_item_notif_type->news_notification_get_url apm_package_url_from_id apm_package_url_from_id (public) news_notification_get_url->apm_package_url_from_id

Testcases:
No testcase defined.

news_pretty_status (public)

 news_pretty_status -publish_date publish_date \
    -archive_date archive_date -status status

Given the publish status of a news items return a localization human readable sentence for the status.

Switches:
-publish_date (required)
-archive_date (required)
-status (required)
Publish status short name. Valid values are returned by the plsql function news_status.
Author:
Peter Marklund

Partial Call Graph (max 5 caller/called nodes):
%3 test_news_pretty_status news_pretty_status (test news) news_pretty_status news_pretty_status test_news_pretty_status->news_pretty_status _ _ (public) news_pretty_status->_ news::test::assert_status_pretty news::test::assert_status_pretty (private) news::test::assert_status_pretty->news_pretty_status packages/news/www/admin/index.tcl packages/news/ www/admin/index.tcl packages/news/www/admin/index.tcl->news_pretty_status

Testcases:
news_pretty_status

news_update_rss (private)

 news_update_rss [ -summary_context_id summary_context_id ]

Regenerate RSS feed

Switches:
-summary_context_id (optional)
Returns:
Error:
Author:
Dave Bauer <dave@thedesignexperience.org>
Created:
2005-02-04

Partial Call Graph (max 5 caller/called nodes):
%3 packages/news/www/admin/approve-2.tcl packages/news/ www/admin/approve-2.tcl news_update_rss news_update_rss packages/news/www/admin/approve-2.tcl->news_update_rss packages/news/www/item-create-3.tcl packages/news/ www/item-create-3.tcl packages/news/www/item-create-3.tcl->news_update_rss rss_gen_report rss_gen_report (public) news_update_rss->rss_gen_report rss_support::get_subscr_id rss_support::get_subscr_id (public) news_update_rss->rss_support::get_subscr_id

Testcases:
No testcase defined.

news_util_get_url (public)

 news_util_get_url package_id

Get package URL from package_id. If this was mounted multiple times, only the first occurrence will be returned. This proc could be deprecated in the future.

Parameters:
package_id (required)
Author:
Robert Locke
See Also:

Partial Call Graph (max 5 caller/called nodes):
%3 news__datasource news__datasource (private) news_util_get_url news_util_get_url news__datasource->news_util_get_url news__rss_datasource news__rss_datasource (private) news__rss_datasource->news_util_get_url packages/news/www/admin/index.tcl packages/news/ www/admin/index.tcl packages/news/www/admin/index.tcl->news_util_get_url packages/news/www/index.tcl packages/news/ www/index.tcl packages/news/www/index.tcl->news_util_get_url apm_package_url_from_id apm_package_url_from_id (public) news_util_get_url->apm_package_url_from_id

Testcases:
No testcase defined.
[ show source ]