Package com.lexmark.saperion.client.lookup

Interface LookupEntryClient

  • All Known Implementing Classes:
    LookupEntryClientImpl
    public interface LookupEntryClient
    This client provides functionality for reading and modifying a given lookup entry.
    Author:
    jschwarz

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void delete()
      This method deletes the lookup entry instance.
      java.util.List<com.lexmark.saperion.administration.AclReferenceType> getACLs()
      This method loads the ACLs that are currently set on this lookup entry.
      com.lexmark.saperion.lookup.LookupEntryListItemType load()
      This method loads the lookup entry instance.
      SearchClient<com.lexmark.saperion.PropertyType> searchMultiValueField​(java.lang.String fieldName)
      This method returns a search client for the content of the given multi value field of the given lookup entry.
      void update​(com.lexmark.saperion.lookup.UpdateLookupEntryInputType properties)
      This method updates a Lookup entry instance.
      void update​(java.util.Map<java.lang.String,​com.lexmark.saperion.PropertyType> properties)
      This method updates a Lookup entry instance.

    • Method Detail

      • update

        void update​(java.util.Map<java.lang.String,​com.lexmark.saperion.PropertyType> properties)
     throws com.lexmark.saperion.exceptions.EcmException
        This method updates a Lookup entry instance.
        Parameters:
        properties - the properties to update
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates any system error

      • update

        void update​(com.lexmark.saperion.lookup.UpdateLookupEntryInputType properties)
     throws com.lexmark.saperion.exceptions.EcmException
        This method updates a Lookup entry instance.
        Parameters:
        properties - the properties to update
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates any system error

      • delete

        void delete()
     throws com.lexmark.saperion.exceptions.EcmException
        This method deletes the lookup entry instance.
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates any system error

      • load

        com.lexmark.saperion.lookup.LookupEntryListItemType load()
                                                  throws com.lexmark.saperion.exceptions.EcmException
        This method loads the lookup entry instance.
        Returns:
        the lookup entry instance
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates any system error

      • searchMultiValueField

        SearchClient<com.lexmark.saperion.PropertyType> searchMultiValueField​(java.lang.String fieldName)
                                                               throws com.lexmark.saperion.exceptions.EcmException
        This method returns a search client for the content of the given multi value field of the given lookup entry.
        Parameters:
        fieldName - the name of the multi value field
        Returns:
        a search client for the content of the given multi value field of the given lookup entry
        Throws:
        com.lexmark.saperion.exceptions.EcmException

      • getACLs

        java.util.List<com.lexmark.saperion.administration.AclReferenceType> getACLs()
                                                                      throws com.lexmark.saperion.exceptions.EcmException
        This method loads the ACLs that are currently set on this lookup entry.
        Returns:
        a list of references to the entry's ACLs
        Throws:
        com.lexmark.saperion.exceptions.EcmException - when the ACLs could not be loaded