com.tietoenator.trip.jxp.control

## Class TdbGroupList

- java.lang.Object
- - com.tietoenator.trip.jxp.session.TdbSessionObject
  - - com.tietoenator.trip.jxp.TdbMessageProvider
    - - com.tietoenator.trip.jxp.TdbMessageProvidingList<TdbControlObject>
      - - com.tietoenator.trip.jxp.control.TdbControlObjectList
        - - com.tietoenator.trip.jxp.control.TdbGroupList

- All Implemented Interfaces:
    com.tietoenator.trip.jxp.internal.utils.DOMSink, java.lang.Iterable<TdbControlObject>, java.util.Collection<TdbControlObject>, java.util.List<TdbControlObject>

      public class TdbGroupList
      extends TdbControlObjectList

  Container for a list of groups, either specific to a user or known to the calling process

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `TdbGroupList(TdbSession session)` Constructor -- shortcut that retrieves all known group
    `TdbGroupList(TdbSession session, java.lang.String user)` Constructor -- shortcut that retrieves groups to which the named user belongs
    `TdbGroupList(TdbSession session, java.lang.String user, boolean incPublic)` Constructor -- shortcut
    `TdbGroupList(TdbSession session, java.lang.String user, boolean incPublic, boolean all)` Constructor -- retrieve the list of groups from the server

  - ### Method Summary

    - ### Methods inherited from class com.tietoenator.trip.jxp.control.TdbControlObjectList

      `contains, contains, get, refresh, transform`

    - ### Methods inherited from class com.tietoenator.trip.jxp.TdbMessageProvidingList

      `add, add, addAll, addAll, clear, contains, containsAll, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray`

    - ### Methods inherited from class com.tietoenator.trip.jxp.TdbMessageProvider

      `codeList, getLastCode, getLastMessage, hasMessages, messageList, resetMessages`

    - ### Methods inherited from class com.tietoenator.trip.jxp.session.TdbSessionObject

      `cancel, getSession, isCancelable, setCancelable`

    - ### Methods inherited from class java.lang.Object

      `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface com.tietoenator.trip.jxp.internal.utils.DOMSink

      `sinkNode`

    - ### Methods inherited from interface java.util.List

      `equals, hashCode, replaceAll, sort, spliterator`

    - ### Methods inherited from interface java.util.Collection

      `parallelStream, removeIf, stream`

    - ### Methods inherited from interface java.lang.Iterable

      `forEach`

- - ### Constructor Detail

    - #### TdbGroupList

          public TdbGroupList(TdbSession session,
                              java.lang.String user,
                              boolean incPublic,
                              boolean all)
                       throws TdbException

      Constructor -- retrieve the list of groups from the server
      Parameters:
        `session` - Active session
        `user` - null for all groups, or specify the user if retrieving groups for that user
        `incPublic` - set false to remove the PUBLIC group from the list
        `all` - set false to remove groups not known to the calling process from the list
      Throws:
        `TdbException`

    - #### TdbGroupList

          public TdbGroupList(TdbSession session)
                       throws TdbException

      Constructor -- shortcut that retrieves all known group
      Parameters:
        `session` - Active session
      Throws:
        `TdbException`

    - #### TdbGroupList

          public TdbGroupList(TdbSession session,
                              java.lang.String user)
                       throws TdbException

      Constructor -- shortcut that retrieves groups to which the named user belongs
      Parameters:
        `session` - Active session
        `user` - User for whom groups are to be retrieved
      Throws:
        `TdbException`

    - #### TdbGroupList

          public TdbGroupList(TdbSession session,
                              java.lang.String user,
                              boolean incPublic)
                       throws TdbException

      Constructor -- shortcut
      Parameters:
        `session` - Active session
        `user` - User for whom groups are to be retrieved
        `incPublic` - set false to remove the PUBLIC group from the list
      Throws:
        `TdbException`