Class GroupListDescriptor

Object
   |
   +--GroupDescriptor
         |
         +--GroupListDescriptor

class GroupListDescriptor

extends GroupDescriptor

A group descriptor that specifies a group through a list of item names. A descriptor of this type requires that the default Metadata Adapter (i.e. the LiteralBasedProvider) or a compatible one is used on the Server. This ensures that the encoded item name list is correctly interpreted on the Server side.
Note that directly passing an Array object is supported, as a shorthand for a GroupListDescriptor, by all interface methods that require a GroupDescriptor object.
See:

- Connection.setAdapterName()

Constructor Detail

GroupListDescriptor

GroupListDescriptor(<Array> itemNames)

Creates a group descriptor object that specifies a group through a list of item names.

Parameters:
itemNames - an array of String item names. Array elements should be stored by starting at index 1. However, Javascript arrays implicitly start with a 0 index. For example, if itemNames is defined by the literal ['a', 'b', 'c'], then 'a' is defined as itemNames[0]. Using such an array is also allowed, but the 'a' item is still associated with position 1. Hence, if an item position is used as an item descriptor for item 'a', then it should specify position 1.
Only alphanumeric names are supported (underscore, caret and dot characters are also allowed); moreover, using numbers as item names is not allowed.

See:
- Connection.setAdapterName()

getList

Array getList()

Inquiry method that gets the list of item names specified by this group descriptor.

Returns:
An array of String item names. The names are always reported starting from index 1.