Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

    • Method Detail

      • getInstance

        EDMInstance getInstance()
                         throws EdmiException

        Get the object governed by this access manager

        Returns:the objectThrows:EdmiException - If the method fails

      • getObjectOwner

        EDMUser getObjectOwner()
                        throws EdmiException

        Gets the owner. The owner has privilegies to modify the access on the object the access apply to

        Returns:The owner of this access objectThrows:EdmiException - if the method fails

      • setObjectOwner

        void setObjectOwner(EDMUser ownerEDMUser owner)
                     throws EdmiException

        Change access owner

        Parameters:owner - New ownerThrows:EdmiException - if the method fails

      • getGroupOwner

        EDMGroup getGroupOwnerEDMGroup getGroupOwner()
                        throws EdmiException

        Gets the owner group. The group owner has privilegies to modify the access on the object the access apply to

        Returns:The grousp owner of this access objectThrows:EdmiException - if the method fails

      • setGroupOwner

        void setGroupOwner(EDMGroup ownerEDMGroup owner)
                    throws EdmiException

        Change access group owner

        Parameters:owner - New ownerThrows:EdmiException - if the method fails

      • addAdministrator

        void addAdministrator(EDMUserOrGroup adminEDMUserOrGroup admin)
                       throws EdmiException

        Add an administrator

        Parameters:admin - New administratorThrows:EdmiException - if the method fails

      • removeAdministrator

        void removeAdministrator(EDMUserOrGroup adminEDMUserOrGroup admin)
                          throws EdmiException

        Remove an administrator

        Parameters:admin - New administratorThrows:EdmiException - if the method fails

      • getAllAccessFor

        EDMAccess[] getAllAccessFor()
                             throws EdmiException

        Get all dedicated access

        Returns:a list of accesses for users/groups, null if none assignedThrows:EdmiException - if the method fails

      • getAccessFor

        EDMAccess getAccessForEDMAccess getAccessFor(EDMUserOrGroup userOrGroupEDMUserOrGroup userOrGroup)
                        throws EdmiException

        Retrieve dedicated access for a user

        Parameters:userOrGroup - user or group to check dedicated access forReturns:access object for the given user, null if none setThrows:EdmiException - if the method fails

      • setAccessFor

        EDMAccess setAccessForEDMAccess setAccessFor(EDMUserOrGroup userOrGroupEDMUserOrGroup userOrGroup,
                               long rights)
                        throws EdmiException

        Set a dedicated access

        Parameters:userOrGroup - the user or group to grant special access torights - access rights to grantReturns:the created or modified accessThrows:EdmiException - if the method fails

      • removeAccessFor

        void removeAccessFor(EDMUserOrGroup userOrGroupEDMUserOrGroup userOrGroup)
                      throws EdmiException

        Remove a dedicated access

        Parameters:userOrGroup - the user or group to remove special access fromThrowsfrom Throws:EdmiException - if the method fails

      • getRoleAccess

        EDMAccess getRoleAccessEDMAccess getRoleAccess(long accessRole)
                         throws EdmiException

        Retrieve access for PUBLIC, OWNER or GROUP

        Parameters:accessRole - ROLE_PUBLIC_ACCESS, ROLE_OWNER_GROUP or ROLE_OWNER_USERReturnsUSER Returns:access object for the given roleThrows:EdmiException - if the method fails

      • getRoleAccessRights

        long getRoleAccessRights(long accessRole)
                          throws EdmiException

        Retrieve access rights bitmask for PUBLIC, OWNER or GROUP

        Parameters:accessRole - ROLE_PUBLIC_ACCESS, ROLE_OWNER_GROUP or ROLE_OWNER_USERReturnsUSER Returns:access rights for the given roleThrows:EdmiException - if the method fails

      • setRoleAccessRights

        void setRoleAccessRights(long accessRole,
                                 long rights)
                          throws EdmiException

        set access for PUBLIC, OWNER or GROUP

        Parameters:accessRole - ROLE_PUBLIC_ACCESS, ROLE_OWNER_GROUP or ROLE_OWNER_USERrights - access rights to grantThrows:EdmiException - if the method fails

      • getEffectiveAccess

        EDMAccess getEffectiveAccessEDMAccess getEffectiveAccess(EDMUserOrGroup userOrGroupEDMUserOrGroup userOrGroup)
                              throws EdmiException

        Retrieve effective access for a user (superuser only?)

        Parameters:userOrGroup - user or group to check access for, null = myselfReturns:access object for the given roleThrows:EdmiException - if the method fails

      • getMyAccess

        EDMAccess getMyAccessEDMAccess getMyAccess()
                       throws EdmiException

        Retrieve effective access

        Returns:access object for the calling contextThrows:EdmiException - if the method fails

...