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

Testcases:
No testcase defined.

news::sc::unregister_news_fts_impl (private)

 news::sc::unregister_news_fts_impl

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>

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

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>

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

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)

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)

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)

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)

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:

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

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

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:

Testcases:
No testcase defined.
[ show source ]