Controls Documentation

Controls  Complex Types  Show Hierarchies  Show Full Hierarchies 

Complex Type: xe:viewItemFileService

f:com.ibm.xsp.BaseComplexType
   xe:com.ibm.xsp.extlib.component.rest.IRestService
      xe:com.ibm.xsp.extlib.component.rest.AbstractRestService
         xe:com.ibm.xsp.extlib.component.rest.DominoService
            xe:com.ibm.xsp.extlib.component.rest.DominoViewService
               xe:viewItemFileService

Description

Domino Json Item File View service implementation

Properties

Java

Java Class: com.ibm.xsp.extlib.component.rest.DominoViewItemFileService


loaded, boolean  [Inherited]
Loaded
Specifies whether or not the tag instance should be created when the page is loading. Value defaults to 'true'.
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
dojoType, string  [Inherited]
Dojo Type
Sets the default Dojo Type used to create this control in the browser.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
dojoAttributes, Collection of xp:dojoAttribute - com.ibm.xsp.dojo.DojoAttribute  [Inherited]
Dojo Attributes
Specifies a list of Dojo attributes.
Required Attribute false
databaseName, string  [Inherited]
Database Name
Domino Database Name
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
var, string  [Inherited]
var
Request scope attribute under which a view row will be made available
Required Attribute false
Localizable false
Allow Runtime Binding false
Allow Load Time Binding true
Allow Non Binding true
viewName, string  [Inherited]
Database View
Domino View Name
Required Attribute true
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
globalValues, int  [Inherited]
Global Values
Specifies the global values returned by the service
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
systemColumns, int  [Inherited]
System Columns
Specifies is some system columns should be added
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
defaultColumns, boolean  [Inherited]
Default Columns
Specifies is the View columns should be automatically added
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
columns, Collection of xe:restViewColumn - com.ibm.xsp.extlib.component.rest.DominoViewColumn  [Inherited]
Columns
Columns List
Required Attribute false
start, int  [Inherited]
Start
Specifies the start index
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
count, int  [Inherited]
Count
Specifies the number of rows to return
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
sortColumn, string  [Inherited]
Sort Column
A column that can be used to sort the view data
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
sortOrder, string  [Inherited]
Sort Order
The order by which you wish to collate the sort column
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
expandLevel, int  [Inherited]
Expand Level
Level of expansion for entries in a hierarchical view
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
parentId, string  [Inherited]
Parent Id
The document id of the parent entry whose descendants will populate the retrieved data
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
categoryFilter, string  [Inherited]
Category Filter
Category filter to be used to restrict the view contents to descendants of this category
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
startKeys, string  [Inherited]
Start keys
View entry to start from
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
keys, generic  [Inherited]
Filter Keys
A key is used to filter the contents of a view based on the column values. You create a key (or vector of keys if called from JavaScript), where a key corresponds to a value in a sorted column. Results are consistent with getAllDocumentsByKey method in Domino Java API classes.
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
keysExactMatch, boolean  [Inherited]
Filter Using Exact Match
Determines whether or not exact matching will be used when the filter key is applied to the view
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
search, string  [Inherited]
Search View String
Search to perform on view results when displaying in a view control
Required Attribute false
Localizable true
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
searchMaxDocs, int  [Inherited]
Maximum Search Documents
Maximum number of documents to include in the search result
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true

json

compact, boolean
Compact
Specifies if the JSON stream should be compacted
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true
contentType, string
Content Type
Response Content Type
Required Attribute false
Localizable false
Allow Runtime Binding true
Allow Load Time Binding true
Allow Non Binding true