Package com.lexmark.saperion.client.implementation.administration

Class GroupManagementServiceClientImpl

java.lang.Object
com.lexmark.saperion.client.implementation.administration.GroupManagementServiceClientImpl
All Implemented Interfaces:
GroupManagementServiceClient
public class GroupManagementServiceClientImpl extends Object implements GroupManagementServiceClient
This is the default implementation of GroupManagementServiceClient.
Author:
jschwarz

  • Constructor Summary

    Constructors
    Constructor
    Description
    GroupManagementServiceClientImpl(com.lexmark.saperion.administration.GroupManagementService groupManagementService)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    com.lexmark.saperion.administration.GroupReferenceType
    createGroup(com.lexmark.saperion.administration.GroupPropertiesType properties)
    This method creates a new group with the given properties and returns a reference to it.
    com.lexmark.saperion.administration.GroupReferenceType
    createGroup(String shortName)
    This method is a shorthand to GroupManagementServiceClient.createGroup(String, String, String).
    com.lexmark.saperion.administration.GroupReferenceType
    createGroup(String shortName, String fullName, String description)
    This method creates a new group with the given properties and returns a reference to it.
    GroupClient
    resolve(com.lexmark.saperion.administration.GroupReferenceType reference)
    This method returns an administration client for the group with the given reference.
    GroupClient
    resolveName(String groupName)
    This method returns an administration client for the group with the given name.
    SearchClient<com.lexmark.saperion.administration.GroupType>
    search()
    This method returns a search client for searching groups.
    SearchClient<com.lexmark.saperion.administration.GroupType>
    searchDeleted()
    This method returns a search client for searching deleted groups.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • GroupManagementServiceClientImpl

      public GroupManagementServiceClientImpl(com.lexmark.saperion.administration.GroupManagementService groupManagementService)

  • Method Details

    • resolve

      public GroupClient resolve(com.lexmark.saperion.administration.GroupReferenceType reference) throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: GroupManagementServiceClient
      This method returns an administration client for the group with the given reference.
      Specified by:
      resolve in interface GroupManagementServiceClient
      Parameters:
      reference - a reference to the group to administrate
      Returns:
      an administration client for the group with the given reference
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • resolveName

      public GroupClient resolveName(String groupName) throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: GroupManagementServiceClient
      This method returns an administration client for the group with the given name.
      Specified by:
      resolveName in interface GroupManagementServiceClient
      Parameters:
      groupName - the name of the group to administrate
      Returns:
      an administration client for the group with the given name
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • search

      public SearchClient<com.lexmark.saperion.administration.GroupType> search() throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: GroupManagementServiceClient
      This method returns a search client for searching groups.
      Specified by:
      search in interface GroupManagementServiceClient
      Returns:
      a search client for searching groups
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • searchDeleted

      public SearchClient<com.lexmark.saperion.administration.GroupType> searchDeleted() throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: GroupManagementServiceClient
      This method returns a search client for searching deleted groups.
      Specified by:
      searchDeleted in interface GroupManagementServiceClient
      Returns:
      a search client for searching deleted groups
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • createGroup

      public com.lexmark.saperion.administration.GroupReferenceType createGroup(com.lexmark.saperion.administration.GroupPropertiesType properties) throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: GroupManagementServiceClient
      This method creates a new group with the given properties and returns a reference to it.
      Specified by:
      createGroup in interface GroupManagementServiceClient
      Parameters:
      properties - the properties of the group
      Returns:
      the reference to the new group
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • createGroup

      public com.lexmark.saperion.administration.GroupReferenceType createGroup(String shortName, String fullName, String description) throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: GroupManagementServiceClient
      This method creates a new group with the given properties and returns a reference to it.
      Specified by:
      createGroup in interface GroupManagementServiceClient
      Parameters:
      shortName - the short name (display name) of the new group
      fullName - the full name of the new group
      description - a description of the new group
      Returns:
      a reference to group created
      Throws:
      com.lexmark.saperion.exceptions.EcmException

    • createGroup

      public com.lexmark.saperion.administration.GroupReferenceType createGroup(String shortName) throws com.lexmark.saperion.exceptions.EcmException
      Description copied from interface: GroupManagementServiceClient
      This method is a shorthand to GroupManagementServiceClient.createGroup(String, String, String). It is equivalent to calling createGroup(shortName, shortName, "").
      Specified by:
      createGroup in interface GroupManagementServiceClient
      Parameters:
      shortName - the short name (display name) and full name of the new group
      Returns:
      a reference to group created
      Throws:
      com.lexmark.saperion.exceptions.EcmException