Package com.lexmark.saperion.client.administration

Interface GroupClient

All Known Implementing Classes:
GroupClientImpl
public interface GroupClient
This client provides methods for administrating a given group.
Author:
jschwarz

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    delete()
    This method deletes the group.
    void
    deleteExtension()
    This method deletes the schema-extension properties of the group.
    List<com.lexmark.saperion.administration.AclReferenceType>
    getACLs()
    This method returns the ACLs currently set on the group.
    default Map<String,com.lexmark.saperion.PropertyType>
    getExtension()
    Deprecated.
    use getSchemaExtension() instead
    GroupMembershipClientForGroups
    getGroupMembers()
    This method returns the group membership management component for groups for the given group.
    com.lexmark.saperion.administration.ExtensionPropertiesType
    getSchemaExtension()
    This method returns the schema-extension properties of the group.
    GroupMembershipClientForUsers
    getUserMembers()
    This method returns the group membership management component for users for the given group.
    com.lexmark.saperion.administration.GroupType
    load()
    This method loads the group.
    default void
    setExtension(Map<String,com.lexmark.saperion.PropertyType> extension)
    Deprecated.
    use setSchemaExtension(ExtensionPropertiesType) instead
    void
    setSchemaExtension(com.lexmark.saperion.administration.ExtensionPropertiesType extension)
    This method sets the schema-extension properties of the group.
    void
    undelete()
    This method un-deletes the group.
    void
    update(com.lexmark.saperion.administration.GroupPropertiesType properties)
    This method updates the group with the given properties.

  • Method Details

    • delete

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

    • load

      com.lexmark.saperion.administration.GroupType load() throws com.lexmark.saperion.exceptions.EcmException
      This method loads the group.
      Returns:
      the group referenced
      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.GroupPropertiesType properties) throws com.lexmark.saperion.exceptions.EcmException
      This method updates the group with the given properties.
      Parameters:
      properties - the properties to change
      Throws:
      com.lexmark.saperion.exceptions.system.SystemException - indicates that a system exception occurred
      com.lexmark.saperion.exceptions.EcmException

    • getGroupMembers

      GroupMembershipClientForGroups getGroupMembers()
      This method returns the group membership management component for groups for the given group.
      Returns:
      the group membership management component

    • getUserMembers

      GroupMembershipClientForUsers getUserMembers()
      This method returns the group membership management component for users for the given group.
      Returns:
      the group membership management component

    • getExtension

      @Deprecated default Map<String,com.lexmark.saperion.PropertyType> getExtension() throws com.lexmark.saperion.exceptions.EcmException
      Deprecated.
      use getSchemaExtension() instead
      This method returns the schema-extension properties of the group.
      Returns:
      schema-extension properties of the group
      Throws:
      com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be loaded

    • getSchemaExtension

      com.lexmark.saperion.administration.ExtensionPropertiesType getSchemaExtension() throws com.lexmark.saperion.exceptions.EcmException
      This method returns the schema-extension properties of the group.
      Returns:
      schema-extension properties of the group
      Throws:
      com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be loaded

    • setExtension

      @Deprecated default void setExtension(Map<String,com.lexmark.saperion.PropertyType> extension) throws com.lexmark.saperion.exceptions.EcmException
      Deprecated.
      use setSchemaExtension(ExtensionPropertiesType) instead
      This method sets the schema-extension properties of the group. Note that only non-null values will be updated when a schema-extension already exists.
      Parameters:
      extension - schema-extension properties
      Throws:
      com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be set

    • setSchemaExtension

      void setSchemaExtension(com.lexmark.saperion.administration.ExtensionPropertiesType extension) throws com.lexmark.saperion.exceptions.EcmException
      This method sets the schema-extension properties of the group. Note that only non-null values will be updated when a schema-extension already exists.
      Parameters:
      extension - schema-extension properties
      Throws:
      com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be set

    • deleteExtension

      void deleteExtension() throws com.lexmark.saperion.exceptions.EcmException
      This method deletes the schema-extension properties of the group.
      Throws:
      com.lexmark.saperion.exceptions.EcmException - when the schema-extension properties could not be deleted

    • getACLs

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