Class GroupWrapper


  • public class GroupWrapper
    extends GenericObjectWrapper<GroupData>
    Class containing a GroupData object.

    Wraps function calls to the GroupData contained.

    • Field Detail

      • PERMISSIONS_PRIVATE

        public static final int PERMISSIONS_PRIVATE
        Indicates that the group is Private i.e. RW----.
        See Also:
        Constant Field Values
      • PERMISSIONS_GROUP_READ

        public static final int PERMISSIONS_GROUP_READ
        Indicates that the group is Group i.e. RWR---.
        See Also:
        Constant Field Values
      • PERMISSIONS_GROUP_READ_LINK

        public static final int PERMISSIONS_GROUP_READ_LINK
        Indicates that the group is Group i.e. RWRA--.
        See Also:
        Constant Field Values
      • PERMISSIONS_GROUP_READ_WRITE

        public static final int PERMISSIONS_GROUP_READ_WRITE
        Indicates that the group is Group i.e. RWRW--.
        See Also:
        Constant Field Values
      • PERMISSIONS_PUBLIC_READ

        public static final int PERMISSIONS_PUBLIC_READ
        Indicates that the group is Public i.e. RWRWR-.
        See Also:
        Constant Field Values
      • PERMISSIONS_PUBLIC_READ_WRITE

        public static final int PERMISSIONS_PUBLIC_READ_WRITE
        Indicates that the group is Public i.e. RWRWRW.
        See Also:
        Constant Field Values
    • Constructor Detail

      • GroupWrapper

        public GroupWrapper​(GroupData group)
        Constructor of the class GroupWrapper.
        Parameters:
        group - The GroupData to wrap in the GroupWrapper.
    • Method Detail

      • getName

        public String getName()
        Returns the name of the group.
        Returns:
        See above.
      • setName

        public void setName​(String name)
        Sets the name of the group.
        Parameters:
        name - The name of the group. Mustn't be null.
        Throws:
        IllegalArgumentException - If the name is null.
      • getDescription

        public String getDescription()
        Returns the description of the group.
        Returns:
        See above.
      • setDescription

        public void setDescription​(String description)
        Sets the description of the group.
        Parameters:
        description - The description of the group. Mustn't be null.
        Throws:
        IllegalArgumentException - If the name is null.
      • getLeaders

        public List<ExperimenterWrapper> getLeaders()
        Returns the leaders of this group.
        Returns:
        See above.
      • getExperimenters

        public List<ExperimenterWrapper> getExperimenters()
        Returns the experimenters contained in this group.
        Returns:
        See above.
      • getMembersOnly

        public List<ExperimenterWrapper> getMembersOnly()
        Returns the list of experimenters that are not owners of the group.
        Returns:
        See above.
      • getPermissionsLevel

        public int getPermissionsLevel()
        Returns the permissions level.
        Returns:
        See above.