Class %DeepSee.Model.SubjectArea.listing

class %DeepSee.Model.SubjectArea.listing extends %DeepSee.Model.SubjectArea.node

Meta-data object that represents a listing for a DeepSee SubjectArea.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
	10	1

Summary

Properties
description	disabled	displayName	fieldList	formatList
hidden	listingType	name	orderBy	resource
selectMode	sourceClass	sql	subjectArea

Methods
%AddToSaveSet	%BindExport	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%Extends	%GetParameter	%IsA	%IsModified
%New	%NormalizeObject	%ObjectModified	%OriginalNamespace
%PackageName	%QuoteList	%QuoteValue	%QuoteValueL10N
%RemoveFromSaveSet	%SerializeObject	%SetModified	%Validate
%ValidateObject	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType

Properties

• property fieldList as %String(MAXLEN=1000,XMLPROJECTION="attribute");

Optional. If specified, this is used as the RETURN clause for the DRILLTHROUGH query used for this listing.

• property formatList as %String(MAXLEN=5000,XMLPROJECTION="attribute");

Optional. This is a "^" delimited list of css formatting instructions for the listing. Each piece of the list is applied to its corresponding column in the listing.

• property hidden as %Boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];

Hidden flag. If true, then this listing will be hidden (not part of the subject area model).

• property listingType as %String(MAXLEN=50,VALUELIST=",table,map",XMLPROJECTION="attribute") [ InitialExpression = "table" ];

Indicates how to display this listing.
"table" (the default) shows the listing as a table.
"map" shows the listing within a map view. For this case, your listing must contain a columns called "Latitude" and "Longitude".

• property orderBy as %String(MAXLEN=1000,XMLPROJECTION="attribute");

Optional. If specified, this is used as the %ORDER BY clause for the DRILLTHROUGH query used for this listing.

• property resource as %String(MAXLEN=255,XMLPROJECTION="attribute");

Optional. The resource needed to view this listing:
If defined and the current user holds the USE privilege on this resource, then the user may view this listing.

• property selectMode as %String(DISPLAYLIST=",Logical,ODBC,Display",VALUELIST=",0,1,2",XMLPROJECTION="attribute") [ InitialExpression = 2 ];

SQL selectMode which this SQL listing will use to execute.
Possible values are:

0 for LOGICAL mode.

1 for ODBC mode.

2 for DISPLAY mode.

• property sourceClass as %DeepSee.Datatype.className(XMLPROJECTION="attribute");

Name of the %DeepSee.DataConnector class that provides the listing data.
If the cube uses a data connector as its sourceClass, then you must specify this value if you wish to show listings for the cube.

• property sql as %String(MAXLEN=5000,XMLPROJECTION="attribute");

Optional. If specified, this is the sql statement used for this listing.

• relationship subjectArea as %DeepSee.Model.SubjectArea.subjectArea(XMLPROJECTION="none") [ Inverse = listings,Cardinality = one ];

Subject area that this listing belongs to.

Methods

• method %Validate() as %Status

Test if this listing's definition is valid.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search