Package com.axemble.vdoc.sdk.interfaces

Interface IGroup

All Superinterfaces:
IAttributeSupport, IDeletionSupport, IDirectory, IElement, IExternalSupport, IProtocolSupport, ISearchSupport, ISecuritySupport, Serializable
public interface IGroup extends IElement, ISecuritySupport, IDeletionSupport, IAttributeSupport, IExternalSupport, ISearchSupport, IProtocolSupport, IDirectory
The IGroup interface is part of the VDoc directory.
Since:
1.0
Version:
1.0, 28/10/2007
Author:
Vassyly Lygeros
See Also:

  • Method Details

    • getName

      String getName()
      Gets the name of the group.
      Returns:
      a String object.

    • getLabel

      String getLabel()
      Returns the label of the group.
      Returns:
      a String object.

    • getDescription

      String getDescription()
      Gets the description of the group.
      Returns:
      a String of the group.

    • getCreatedDate

      Date getCreatedDate()
      Gets the created date.
      Returns:
      a Date object.

    • getCreatedBy

      IUser getCreatedBy()
      Gets the creator of the group.
      Returns:
      a IUser object.

    • getModifiedDate

      Date getModifiedDate()
      Gets the modified date.
      Returns:
      a Date object.

    • getModifiedBy

      IUser getModifiedBy()
      Gets the editor of the group.
      Returns:
      a IUser object.

    • getParents

      Collection<? extends IGroup> getParents()
      Gets the parents of the group.
      Returns:
      A collection of IGroup objects.

    • getAllParents

      Collection<? extends IGroup> getAllParents()
      Gets all the parents recursively.
      Returns:
      A collection of IGroup objects.

    • getChildren

      Collection<? extends IGroup> getChildren()
      Gets the children groups
      Returns:
      A collection of IGroup objects.

    • getAllChildren

      Collection<? extends IGroup> getAllChildren()
      Gets all the children groups recursively.
      Returns:
      A collection of IGroup objects.

    • isChildOf

      boolean isChildOf(IGroup parent, boolean recursive)
      Checks if a group is child of another group.
      Parameters:
      parent - The parent group.
      recursive - Boolean flag to check recursively or not.
      Returns:
      true if the group is child of the parent group, false otherwise.

    • getMembers

      Collection<? extends IUser> getMembers()
      Gets all group members.
      Returns:
      A collection of IUser objects.

    • getAllMembers

      Collection<? extends IUser> getAllMembers()
      Gets all group members recursively.
      Returns:
      A collection of IUser objects.

    • setName

      void setName(String name)
      Sets the name of the group.
      Parameters:
      name - the new name to set.

    • setLabel

      void setLabel(String label)
      Sets the label of the group
      Parameters:
      label -

    • setDescription

      void setDescription(String description)
      Sets the description of the group.
      Parameters:
      description - the new description to set.

    • addMember

      void addMember(IUser user)
      Sets a user as member of a group.
      Parameters:
      user - The user to add to the group.

    • addChild

      void addChild(IGroup group)
      Adds a child IGroup.
      Parameters:
      group - The child group to add.

    • addMembers

      void addMembers(Collection<? extends IUser> members)
      Adds members as a collection of IUser objects.
      Parameters:
      members - The users to add.

    • addChildren

      void addChildren(Collection<? extends IGroup> children)
      Adds children as a collection of IGroup objects.
      Parameters:
      children - The children to add.

    • addParents

      void addParents(Collection<? extends IGroup> parents)
      Adds parents to the current group.
      Parameters:
      parents - The collection of IGroup objects to add.

    • removeMember

      void removeMember(IUser user)
      Removes a member from the group.
      Parameters:
      user - The IUser object to remove.

    • removeChild

      void removeChild(IGroup group)
      Removes a child from the group.
      Parameters:
      group - The IGroup object to remove.

    • removeMembers

      void removeMembers(Collection<? extends IUser> members)
      Removes a collection of members from the group.
      Parameters:
      members - The collection of IUser objects to remove.

    • removeChildren

      void removeChildren(Collection<? extends IGroup> children)
      Removes children groups from the group.
      Parameters:
      children - The collection of IGroup objects to remove.

    • getOrganization

      IOrganization getOrganization()
      Gets the organization of the group.
      Returns:
      A IOrganization object.

    • setOrganization

      void setOrganization(IOrganization organization)
      Sets the organization of the group.
      Parameters:
      organization - The IOrganization object.

    • isFromSystem

      boolean isFromSystem()
      Checks if a group is created by the system.
      Returns:
      True if the group is created by the system, false otherwise.

    • convertToSystemGroup

      void convertToSystemGroup()
      Transforms a group into a system group (can not be deleted)