%ZEN.Mobile.RSS.Feed

deprecated persistent class %ZEN.Mobile.RSS.Feed extends %Library.Persistent

SQL Table Name: %ZEN_Mobile_RSS.Feed

This represents an RSS feed

Property Inventory

Application
Description
Items
Link
Tag
Title
URL

Method Inventory

%OnNew()
BuildItem()
ExtractItemsFromResults()
FetchNetURL()
Refresh()

Parameters

parameter DEFAULTGLOBAL = ^ZEN.Mobile.RSS.Feed;

Inherited description:

If a persistent class uses %Storage.Persistent then the DEFAULTGLOBAL parameter is used as the default global root for the values of the storage keywords COUNTERLOCATION, DATALOCATION, IDLOCATION, INDEXLOCATION and STREAMLOCATION in the active storage definition. DEFAULTGLOBAL is only used to generate location keyword values that are not already defined. The location value is constructed by adding a location type to the end of DEFAULTGLOBAL. For example, if DEFAULTGLOBAL = "^GL.Account" the compiler will generate DATALOCATION = ^GL.AccountD.

If USEEXTENTSET is true, then DEFAULTGLOBAL is used as the default extent location.

The location types are:

Location	Type
COUNTERLOCATION	C
DATALOCATION	D
IDLOCATION	D
INDEXLOCATION	I
STREAMLOCATION	S

Properties

relationship Application as Application [ Required , Inverse = Feeds , Cardinality = parent ];

This defines the relationship to the parent

Property methods: ApplicationGet(), ApplicationGetObject(), ApplicationGetObjectId(), ApplicationGetStored(), ApplicationGetSwizzled(), ApplicationIsValid(), ApplicationNewObject(), ApplicationOnDelete(), ApplicationRClose(), ApplicationRExec(), ApplicationRFetch(), ApplicationRelate(), ApplicationSQLCompute(), ApplicationSet(), ApplicationSetObject(), ApplicationSetObjectId(), ApplicationUnRelate(), ApplicationUnSwizzle()

property Description as %String) [ Required ];

This is a description of the contents of the feed

Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionGetStored(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()

relationship Items as array of Item [ InitialExpression = $listbuild("%ZEN.Mobile.RSS.Item","Feed",+$this,"children",1,1) , Transient , Inverse = Feed , Cardinality = children ];

This represents the collection of items which makes up the feed

Property methods: ItemsGet(), ItemsGetObject(), ItemsGetObjectId(), ItemsGetSwizzled(), ItemsIsEmpty(), ItemsIsValid(), ItemsNewObject(), ItemsRClose(), ItemsRExec(), ItemsRFetch(), ItemsRelate(), ItemsSQLCompute(), ItemsSet(), ItemsUnRelate()

property Link as %String) [ Required ];

This represents the URL at which the feed presents itself (derived from Channel/link)

Property methods: LinkDisplayToLogical(), LinkGet(), LinkGetStored(), LinkIsValid(), LinkLogicalToDisplay(), LinkLogicalToOdbc(), LinkNormalize(), LinkSet()

property Tag as %String);

This holds whatever data the user wishes to add to categorize this feed

Property methods: TagDisplayToLogical(), TagGet(), TagGetStored(), TagIsValid(), TagLogicalToDisplay(), TagLogicalToOdbc(), TagNormalize(), TagSet()

property Title as %String) [ Required ];

This is the Title of the feed (derived from Channel/title)

Property methods: TitleDisplayToLogical(), TitleGet(), TitleGetStored(), TitleIsValid(), TitleLogicalToDisplay(), TitleLogicalToOdbc(), TitleNormalize(), TitleSet()

property URL as %String) [ Required ];

This is the feed URL

Property methods: URLDisplayToLogical(), URLGet(), URLGetStored(), URLIsValid(), URLLogicalToDisplay(), URLLogicalToOdbc(), URLNormalize(), URLSet()

Methods

method %OnNew(pURL As %String, pTag As %String = "", pTimeout As %Integer = -1, pHttpRequest As %Net.HttpRequest = "") as %Status

Inherited description: This callback method is invoked by the %New() method to provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the %New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from %New(). For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:

Method %OnNew(dob as %Date = "", name as %Name = "") as %Status If instead of returning a %Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of %New method.

classmethod BuildItem(ByRef pItem As %String) as %ZEN.Mobile.RSS.Item

classmethod ExtractItemsFromResults(pResults As %ListOfObjects(CLASSNAME="%XML.XPATH.Result"), Output pItems) as %Status

This method extracts the retrieve item objects from the XPATH results

classmethod FetchNetURL(pURL As %Status, Output pStream As %BinaryStream, pTimeout As %Integer = -1, pHttpRequest As %Net.HttpRequest = "") as %Status

Fetch the contents of a net URL

method Refresh(Output pItemsFiled As %Integer, pPurgeCurrent As %Boolean, pTimeout As %Integer = -1, pHttpRequest As %Net.HttpRequest = "") as %Status

Call this method to refresh the items from the feed

Indexes

index (IDKEY on ) [IdKey, Type = key];

Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (%ZEN.Mobile.RSS.Feed)

{%%PARENT}("Feeds")(ID)

%%CLASSNAME

URL

Title

Link

Description

Tag