Utility Class Properties

In this section, the Utility class properties are presented in alphabetical order.

Note: Properties in this class with capitalized names—such as, ATTACHMENT_URL, AUTHTYPE_PERM, and so on—are constants.

Some properties of the Utility class—such as, QUERYPARAMETER_FEEDID , QUERYPARAMETER_FEEDFORMAT, and so on—are referred to as query parameters. Typically, these query parameters are used in the implementation of a feed request handler. An example of a feed request handler that uses query parameters is provided at the end of this chapter.

Description

Use this property to return the attachment location from the PTFP_DOCINDB URL definition, as a string.

This property is read-only.

Description

Use this property to return the value that represents the permission list-based authentication type, as a string.

This property is read-only.

Description

Use this property to return the value that represents the role-based authentication type, as a string.

This property is read-only.

Description

Use this property to return a string representing the name of the incremental feed data source parameter.

This property is read-only.

Description

Use this property to return a string representing the name of the maximum rows data source parameter for scheduled feeds.

Note: Use either the SF_MAXROWOPTION_ALLMSGS property or the SF_MAXROWOPTION_LATESTMSG property to return the value of the maximum rows data source parameter for scheduled feeds.

This property is read-only.

Description

Use this property to return a string representing the name of the maximum minutes data source parameter for scheduled feeds.

Note: Use the SF_MAXMINUTES_ALLMSGS property to return the value of the maximum minutes data source parameter for scheduled feeds.

This property is read-only.

Description

Use this property to return a string representing the name of the paging data source parameter for scheduled feeds.

Note: Use either the SF_PAGINGOPTION_NOPAGING property or the SF_PAGINGOPTION_SEGMENTED property to return the value of the paging data source parameter for scheduled feeds.

This property is read-only.

Description

Use this property to return a number representing the field edit type as no prompt table edit.

This property is read-only.

Description

Use this property to return a number representing the field edit type as prompt table edit.

This property is read-only.

Description

Use this property to return a number representing the field edit type as translate table edit.

This property is read-only.

Description

Use this property to return a number representing the field edit type as a Yes/No edit.

This property is read-only.

Description

Use this property to return the AUTHOR feed attribute name as a string.

This property is read-only.

Description

Use this property to return the CLOUD feed attribute name as a string.

This property is read-only.

Description

Use this property to return the COMPLETE feed attribute name as a string.

This property is read-only.

Description

Use this property to return the CONTRIBUTOR feed attribute name as a string.

This property is read-only.

Description

Use this property to return the COPYRIGHT feed attribute name as a string.

This property is read-only.

Description

Use this property to return the EXPIRES feed attribute name as a string.

This property is read-only.

Description

Use this property to return the ICONURL feed attribute name as a string.

This property is read-only.

Description

Use this property to return the LOGOURL feed attribute name as a string.

This property is read-only.

Description

Use this property to return the MANAGINGEDITOR feed attribute name as a string.

This property is read-only.

Description

Use this property to return the MAXAGE feed attribute name as a string.

This property is read-only.

Description

Use this property to return the PERSINSTRUCTION feed attribute name as a string.

This property is read-only.

Description

Use this property to return the RATING feed attribute name as a string.

This property is read-only.

Description

Use this property to return the SKIPDAYS feed attribute name as a string.

This property is read-only.

Description

Use this property to return the SKIPHOURS feed attribute name as a string.

This property is read-only.

Description

Use this property to return the TEXTINPUT feed attribute name as a string.

This property is read-only.

Description

Use this property to return the TTL feed attribute name as a string.

This property is read-only.

Description

Use this property to return the WEBMASTER feed attribute name as a string.

This property is read-only.

Description

Use this property to return the XSL feed attribute name as a string.

This property is read-only.

Description

Use this property to return a string representing the feed authorization type as all.

This property is read-only.

Description

Use this property to return a string representing the feed authorization type as anonymous.

This property is read-only.

Description

Use this property to return a string representing the feed authorization type as default.

This property is read-only.

Description

Use this property to return a string representing the feed cache type as none.

This property is read-only.

Description

Use this property to return a string representing the feed cache type as private.

This property is read-only.

Description

Use this property to return a string representing the feed cache type as public.

This property is read-only.

Description

Use this property to return a string representing the feed cache type as role-based.

This property is read-only.

Description

Use this property to return a string representing the feed format as Atom 1.0.

This property is read-only.

Description

Use this property to return a string representing the feed security type as public access.

This property is read-only.

Description

Use this property to return a string representing the feed security type as real-time security.

This property is read-only.

Description

Use this property to return a string representing the feed security type as select security access.

This property is read-only.

Description

Use this property to return a string indicating that the feed definition is not a feed template definition—that is, it is the definition for a feed.

This property is read-only.

Description

Use this property to return a string indicating that the feed definition is a feed template definition.

This property is read-only.

Description

Use this property to return a string representing the feed type as real time (formerly known as dynamic).

This property is read-only.

Description

Use this property to return a string representing the feed type as scheduled (formerly known as prepublished).

This property is read-only.

Description

Use this property to return a number representing the field type as character.

This property is read-only.

Description

Use this property to return a number representing the field type as date.

This property is read-only.

Description

Use this property to return a number representing the field type as DateTime.

This property is read-only.

Description

Use this property to return a number representing the field type as long character.

This property is read-only.

Description

Use this property to return a number representing the field type as number.

This property is read-only.

Description

Use this property to return a number representing the field type as signed number.

This property is read-only.

Description

Use this property to return a number representing the field type as time.

This property is read-only.

Description

Use this property to return a string representing the Integration Broker service operation type as asynchronous.

This property is read-only.

Description

Use this property to return a string representing the Integration Broker service operation type as synchronous.

This property is read-only.

Description

Use this property to return a string representing the Integration Broker service operation type as unknown.

This property is read-only.

Description

Use this property to return the active feed icon URL for PTFP_FEED_ACTIVE, as a string.

This property is read-only.

Description

Use this property to return the inactive feed icon URL for PTFP_FEED_INACTIVE, as a string.

This property is read-only.

Description

Use this property to return an integer indicating that the feed is not an incremental feed.

This property is read-only.

Description

Use this property to return an integer indicating that the feed is an incremental feed.

This property is read-only.

Description

Use this property for a paged feed to return a string indicating that link type is first.

This property is read-only.

Description

Use this property for a paged feed to return a string indicating that link type is last.

This property is read-only.

Description

Use this property for a paged feed to return a string indicating that link type is next.

This property is read-only.

Description

Use this property for a paged feed to return a string indicating that link type is previous.

This property is read-only.

Description

Use this property to return a string containing the MIME type for Atom feed format data.

This property is read-only.

Description

Use this property to return a string containing the MIME type for OPML format data.

This property is read-only.

Description

Use this property to return a string containing the MIME type as XML for unknown feed format data.

This property is read-only.

Description

Use this property to return a number representing the Feed object operating mode as for user authorization only.

Note: Most other operations such as execute, save, and delete are not allowed.

This property is read-only.

Description

Use this property to return a number representing the Feed object operating mode as default.

Note: A Feed object in this mode allows all operations such as save, delete, and so on.

This property is read-only.

Description

Use this property to return a number representing the Feed object operating mode as for feed deletion only.

Note: Most other operations such as execute and save are not allowed.

This property is read-only.

Description

Use this property to return a number representing the Feed object operating mode as for feed execution only.

Note: Other operations such as save and delete are not allowed.

This property is read-only.

Description

Use this property to return a number representing the Feed object operating mode as for feed execution only to return just an empty feed header (that is, without feed entries).

Note: Otherwise, this mode is the same as the OPERATINGMODE_EXECUTION mode.

This property is read-only.

Description

Use this property to return the ChildFeedID query parameter name as a string.

This property is read-only.

Description

Use this property to return the PTFP_DATA_TYPE query parameter as a string.

This property is read-only.

Description

Use this property to return the To query parameter as a string.

This property is read-only.

Description

Use this property to return the PTFP_DSS_COUNT query parameter as a string.

This property is read-only.

Description

Use this property to return the PTFP_DSS_NAME query parameter as a string.

This property is read-only.

Description

Use this property to return the PTFP_DSS_VALUE query parameter as a string.

This property is read-only.

Description

Use this property to return the FeedFormat query parameter as a string.

This property is read-only.

Description

Use this property to return the FEED_ID query parameter as a string.

This property is read-only.

Description

Use this property to return the FEEDLIST query parameter as a string.

This property is read-only.

Description

Use this property to return the PTFP_FEED_TYPE query parameter as a string.

This property is read-only.

Description

Use this property to return the IB_TRANS_ID query parameter as a string.

This property is read-only.

Description

Use this property to return the If-None-Match query parameter as a string.

This property is read-only.

Description

Use this property to return the PAGE_NUM query parameter as a string.

This property is read-only.

Description

Use this property to return the PTFP_FEED_KEYWORD query parameter as a string.

This property is read-only.

Description

Use this property to return the languageCd query parameter as a string.

This property is read-only.

Description

Use this property to return the NODE_NAME query parameter as a string.

This property is read-only.

Description

Use this property to return this query parameter as a string.

This property is read-only.

Description

Use this property to return the PORTAL_NAME query parameter as a string.

This property is read-only.

Description

Use this property to return the PTPPB_SEARCH_MODE query parameter as a string.

This property is read-only.

Description

Use this property to return the SEARCH_TEXT query parameter as a string.

This property is read-only.

Description

Use this property to set or return a FeedRequest object.

This property is read/write.

Description

Use this property to return a number representing all messages as the value for the maximum minutes data source parameter for scheduled feeds.

Note: Use the DSPARAMETER_SF_MAXMINUTES property to return the name of the maximum minutes data source parameter for scheduled feeds.

This property is read-only.

Description

Use this property to return a number representing all messages as the value for the maximum row data source parameter for scheduled feeds.

Note: Use the DSPARAMETER_MAXROW property to return the name of the maximum row data source parameter for scheduled feeds.

This property is read-only.

Description

Use this property to return a number representing latest message as the value for the maximum row data source parameter for scheduled feeds.

Note: Use the DSPARAMETER_MAXROW property to return the name of the maximum row data source parameter for scheduled feeds.

This property is read-only.

Description

Use this property to return a number representing no paging as the value for the paging data source parameter for scheduled feeds.

Note: Use the DSPARAMETER_SF_PAGING property to return the name of the paging data source parameter for scheduled feeds.

This property is read-only.

Description

Use this property to return a number representing segmented message as the value for the paging data source parameter for scheduled feeds.

Note: Use the DSPARAMETER_SF_PAGING property to return the name of the paging data source parameter for scheduled feeds.

Important! Using SF_PAGINGOPTION_SEGMENTED returns the oldest page (message segment) as the initial page of the feed. The links to the other pages (next, previous, first, and last) are available in the FeedDoc wherever applicable.

This option is best suited for when the feed output is large and the feed itself is to be consumed by a crawler or a feed reader application that understand these links.

This property is read-only.

Description

Use this property to return the string that indicates that a system variable is invalid.

This property is read-only.

Description

Use this property to return a string indicating that the data source parameter usage type is administrator specified.

This property is read-only.

Description

Use this property to return a string indicating that the data source parameter usage type is fixed.

This property is read-only.

Description

Use this property to return a string indicating that the data source parameter usage type is internal.

This property is read-only.

Description

Use this property to return a string indicating that the data source parameter usage type is not used.

This property is read-only.

Description

Use this property to return a string indicating that the data source parameter usage type is system variable.

This property is read-only.

Description

Use this property to return a string indicating that the data source parameter usage type is user specified.

This property is read-only.

Description

Use this property to return an array of string containing the list of children XML tags used by the FEEDATTRIBUTE_CLOUD feed attribute.

This property is read-only.

Description

Use this property to return an array of string containing the list of children XML tags used by the FEEDATTRIBUTE_AUTHOR and FEEDATTRIBUTE_CONTRIBUTOR feed attributes.

This property is read-only.

Description

Use this property to return an array of string containing the list of children XML tags used by the FEEDATTRIBUTE_TEXTINPUT feed attribute.

This property is read-only.

Description

Use this property to return as a string the representing the day XML element.

This property is read-only.

Description

Use this property to return as a string the representing the description XML element.

This property is read-only.

Description

Use this property to return as a string the representing the domain XML element.

This property is read-only.

Description

Use this property to return as a string the representing the email XML element.

This property is read-only.

Description

Use this property to return as a string the representing the hour XML element.

This property is read-only.

Description

Use this property to return as a string the representing the link XML element.

This property is read-only.

Description

Use this property to return as a string the representing the name XML element.

This property is read-only.

Description

Use this property to return as a string the representing the path XML element.

This property is read-only.

Description

Use this property to return as a string the representing the port XML element.

This property is read-only.

Description

Use this property to return as a string the representing the protocol XML element.

This property is read-only.

Description

Use this property to return as a string the representing the register protocol XML element.

This property is read-only.

Description

Use this property to return as a string the representing the title XML element.

This property is read-only.