Class GroupIdDescriptor

Object
   |
   +--GroupDescriptor
         |
         +--GroupIdDescriptor

class GroupIdDescriptor

extends GroupDescriptor

A group descriptor that specifies a group by group identifier. A descriptor of this type requires that a suitable Metadata Adapter is used on the Server. This Metadata Adapter is responsible for recognizing the group identifier and converting it into an item list. The default Metadata Adapter (i.e. the LiteralBasedProvider) may not be suitable in this case.
Note that directly passing a String object is supported, as a shorthand for a GroupIdDescriptor, by all interface methods that require a GroupDescriptor object.
See:

- Connection.setAdapterName()

Constructor Detail

GroupIdDescriptor

GroupIdDescriptor(<String> groupId)

Creates a group descriptor object that specifies a group by group identifier.

Parameters:
groupId - a group identifier.

See:
- Connection.setAdapterName()

getId

String getId()

Inquiry method that gets the group identifier specified by this group descriptor.

Returns:
A group identifier.