Package ch.systemsx.cisd.openbis.generic.shared.api.v1.dto

Class SpaceWithProjectsAndRoleAssignments

  • All Implemented Interfaces:
    ICodeHolder, java.io.Serializable
    @JsonObject("SpaceWithProjectsAndRoleAssignments")
public class SpaceWithProjectsAndRoleAssignments
extends java.lang.Object
implements ICodeHolder, java.io.Serializable
    Bean which represents a space, all its projects, and all its relevant role assignments
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(Project project)  
      void add​(java.lang.String user, Role role)  
      java.lang.String getCode()
      Returns the space code.
      java.util.List<Project> getProjects()
      Returns all projects of this space.
      java.util.Set<Role> getRoles​(java.lang.String userID)
      Returns all access roles the specified user has on this space.
      java.util.Set<java.lang.String> getUsers()
      Returns the set of all users that have a role in this space.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SpaceWithProjectsAndRoleAssignments

        public SpaceWithProjectsAndRoleAssignments​(java.lang.String code)
        Creates a new instance for the specified code.
        Throws:
        java.lang.IllegalArgumentException - if the code is null or an empty string.

    • Method Detail

      • getCode

        public java.lang.String getCode()
        Returns the space code.
        Specified by:
        getCode in interface ICodeHolder

      • add

        public void add​(Project project)

      • getProjects

        public java.util.List<Project> getProjects()
        Returns all projects of this space.

      • add

        public void add​(java.lang.String user,
                Role role)

      • getRoles

        public java.util.Set<Role> getRoles​(java.lang.String userID)
        Returns all access roles the specified user has on this space.

      • getUsers

        public java.util.Set<java.lang.String> getUsers()
        Returns the set of all users that have a role in this space.