Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

%DeepSee.Model.ListingGroup.listing

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

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

Property Inventory

Method Inventory

Properties

property fieldList as %String);
Optional. If specified, this is used as the RETURN clause for the DRILLTHROUGH query used for this listing.
Property methods: fieldListDisplayToLogical(), fieldListGet(), fieldListIsValid(), fieldListLogicalToDisplay(), fieldListLogicalToOdbc(), fieldListNormalize(), fieldListSet()
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 methods: formatListDisplayToLogical(), formatListGet(), formatListIsValid(), formatListLogicalToDisplay(), formatListLogicalToOdbc(), formatListNormalize(), formatListSet()
relationship listingGroup as %DeepSee.Model.ListingGroup.listingGroup (XMLPROJECTION = "none") [ Inverse = listings , Cardinality = one ];
Listing Group that this listing belongs to.
Property methods: listingGroupGet(), listingGroupGetObject(), listingGroupGetObjectId(), listingGroupGetSwizzled(), listingGroupIsValid(), listingGroupNewObject(), listingGroupRClose(), listingGroupRExec(), listingGroupRFetch(), listingGroupRelate(), listingGroupSQLCompute(), listingGroupSet(), listingGroupUnRelate()
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 methods: listingTypeDisplayToLogical(), listingTypeGet(), listingTypeIsValid(), listingTypeLogicalToDisplay(), listingTypeLogicalToOdbc(), listingTypeNormalize(), listingTypeSet()
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 methods: orderByDisplayToLogical(), orderByGet(), orderByIsValid(), orderByLogicalToDisplay(), orderByLogicalToOdbc(), orderByNormalize(), orderBySet()
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 methods: resourceDisplayToLogical(), resourceGet(), resourceIsValid(), resourceLogicalToDisplay(), resourceLogicalToOdbc(), resourceNormalize(), resourceSet()
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 methods: sourceClassDisplayToLogical(), sourceClassGet(), sourceClassIsValid(), sourceClassLogicalToDisplay(), sourceClassLogicalToOdbc(), sourceClassNormalize(), sourceClassSet()
property sql as %String);
Optional. If specified, this is the sql statement used for this listing.
Property methods: sqlDisplayToLogical(), sqlGet(), sqlIsValid(), sqlLogicalToDisplay(), sqlLogicalToOdbc(), sqlNormalize(), sqlSet()

Methods

method %Validate() as %Status
Test if this listing's definition is valid.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab