Package com.lexmark.saperion.client.administration

Interface AclClient

All Known Implementing Classes:
AclClientImpl
public interface AclClient
This client provides methods for administrating a given access control list.
Author:
tfrisch

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete()
    This method deletes the access control list.
    List<com.lexmark.saperion.administration.AclReferenceType>
    getACLs()
    This method returns the ACLs currently set on the ACL.
    com.lexmark.saperion.administration.AclType
    load()
    This method loads the access control list.
    void
    undelete()
    This method un-deletes the access control list.
    void
    update(com.lexmark.saperion.administration.AclPropertiesType properties)
    This method updates the access control list with the given properties.

  • Method Details

    • delete

      void delete() throws com.lexmark.saperion.exceptions.EcmException
      This method deletes the access control list.
      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 access control list.
      Throws:
      com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

    • load

      com.lexmark.saperion.administration.AclType load() throws com.lexmark.saperion.exceptions.EcmException
      This method loads the access control list.
      Returns:
      the referenced access control list
      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.AclPropertiesType properties) throws com.lexmark.saperion.exceptions.EcmException
      This method updates the access control list with the given properties.
      Parameters:
      properties - the new properties of the access control list
      Throws:
      com.lexmark.saperion.exceptions.system.SystemException - indicates that a system exception occurred
      com.lexmark.saperion.exceptions.EcmException

    • getACLs

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