getFeed method: FeedFactory class

Syntax

getFeed(feed_ID, mode)

Description

Use this method to create a Feed object with the given feed ID.

Parameters

Parameter	Description
feed_ID	Specifies the feed ID as a string.
mode	Specifies the operating mode for the feed as a number. See the values below.

The values for the mode parameter are:

Numeric Value	Constant Value	Description
0	&utility.OPERATINGMODE_DEFAULT	A Feed object in this mode allows all operations such as save, delete, and so on.
10	&utility.OPERATINGMODE_EXECUTION	A Feed object in this mode is for execution to get the feed document. Other operations such as save and delete are not allowed.
11	&utility.OPERATINGMODE_EXECUTION_NOENTRY	A Feed object in this mode is for execution to get a feed document with just an empty feed header (that is, without feed entries). Otherwise, this mode is the same as the OPERATINGMODE_EXECUTION mode.
100	&utility.OPERATINGMODE_AUTHORIZATION	A Feed object in this mode is for validating user access to the feed. Most other operations such as execute, save, and delete are not allowed.
1000	&utility.OPERATINGMODE_DELETION	A Feed object in this mode is to delete the feed definition. Most other operations such as execute and save are not allowed.

Returns

A Feed object if successful, null otherwise.

Example

import PTFP_FEED:FeedFactory;
import PTFP_FEED:Feed;

Local PTFP_FEED:FeedFactory &thisFeedFactory = create PTFP_FEED:FeedFactory();
Local PTFP_FEED:Feed &thisFeed;

&thisFeed = &thisFeedFactory.getFeed("feed_ID", &thisFeedFactory.Utility.⇒
OPERATINGMODE_DEFAULT);