Package com.lexmark.saperion.client.administration

Interface RoleClient

  • All Known Implementing Classes:
    RoleClientImpl
    public interface RoleClient
    This client provides methods for administrating a given role.
    Author:
    tfrisch

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void delete()
      This method deletes the role.
      java.util.List<com.lexmark.saperion.administration.AclReferenceType> getACLs()
      This method returns the ACLs currently set on the role.
      com.lexmark.saperion.administration.RoleType load()
      This method loads the role.
      void undelete()
      This method un-deletes the role.
      void update​(com.lexmark.saperion.administration.RolePropertiesType properties)
      This method updates the role with the given properties.

    • Method Detail

      • delete

        void delete()
     throws com.lexmark.saperion.exceptions.EcmException
        This method deletes the role.
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

      • undelete

        void undelete()
       throws com.lexmark.saperion.exceptions.EcmException
        This method un-deletes the role.
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

      • load

        com.lexmark.saperion.administration.RoleType load()
                                           throws com.lexmark.saperion.exceptions.EcmException
        This method loads the role.
        Returns:
        the referenced role
        Throws:
        com.lexmark.saperion.exceptions.system.SystemException - indicates that a system exception occurred
        com.lexmark.saperion.exceptions.EcmException

      • update

        void update​(com.lexmark.saperion.administration.RolePropertiesType properties)
     throws com.lexmark.saperion.exceptions.EcmException
        This method updates the role with the given properties.
        Parameters:
        properties - the new properties of the role
        Throws:
        com.lexmark.saperion.exceptions.system.SystemException - indicates that a system exception occurred
        com.lexmark.saperion.exceptions.EcmException

      • getACLs

        java.util.List<com.lexmark.saperion.administration.AclReferenceType> getACLs()
                                                                      throws com.lexmark.saperion.exceptions.EcmException
        This method returns the ACLs currently set on the role.
        Returns:
        the ACLs currently set on the role
        Throws:
        com.lexmark.saperion.exceptions.EcmException - when loading the ACLs failed