Package com.lexmark.saperion.client.folder

Interface FolderServiceClient

  • All Known Implementing Classes:
    FolderServiceClientImpl
    public interface FolderServiceClient
    This client provides functionality concerning folders.
    Author:
    jschwarz

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.lexmark.saperion.folder.FolderReferenceType createFolder​(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference, java.lang.String folderName, java.util.Map<java.lang.String,​com.lexmark.saperion.PropertyType> index)
      This method creates a new folder with the given input data.
      com.lexmark.saperion.folder.FolderReferenceType createFolder​(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference, java.lang.String folderName, java.util.Map<java.lang.String,​com.lexmark.saperion.PropertyType> index, com.lexmark.saperion.folder.FolderReferenceType parent)
      This method creates a new folder with the given input data.
      com.lexmark.saperion.folder.FolderReferenceType createFolder​(com.lexmark.saperion.folder.CreateFolderInputType properties)
      This method creates a new folder with the given input data.
      FolderClient resolve​(com.lexmark.saperion.folder.FolderReferenceType reference)
      This method returns a client for the folder referenced.

    • Method Detail

      • resolve

        FolderClient resolve​(com.lexmark.saperion.folder.FolderReferenceType reference)
              throws com.lexmark.saperion.exceptions.EcmException
        This method returns a client for the folder referenced.
        Parameters:
        reference - a reference to the folder
        Returns:
        a client for the folder referenced
        Throws:
        com.lexmark.saperion.exceptions.EcmException

      • createFolder

        com.lexmark.saperion.folder.FolderReferenceType createFolder​(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference,
                                                             java.lang.String folderName,
                                                             java.util.Map<java.lang.String,​com.lexmark.saperion.PropertyType> index)
                                                      throws com.lexmark.saperion.exceptions.EcmException
        This method creates a new folder with the given input data.
        Parameters:
        archiveReference - the archive in which the folder is stored
        folderName - the name of the folder
        index - the folder index data
        Returns:
        a reference to the new folder
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates an error

      • createFolder

        com.lexmark.saperion.folder.FolderReferenceType createFolder​(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference,
                                                             java.lang.String folderName,
                                                             java.util.Map<java.lang.String,​com.lexmark.saperion.PropertyType> index,
                                                             com.lexmark.saperion.folder.FolderReferenceType parent)
                                                      throws com.lexmark.saperion.exceptions.EcmException
        This method creates a new folder with the given input data.
        Parameters:
        archiveReference - the archive in which the folder is stored
        folderName - the name of the folder
        index - the folder index data
        Returns:
        a reference to the new folder
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates an error

      • createFolder

        com.lexmark.saperion.folder.FolderReferenceType createFolder​(com.lexmark.saperion.folder.CreateFolderInputType properties)
                                                      throws com.lexmark.saperion.exceptions.EcmException
        This method creates a new folder with the given input data.
        Parameters:
        properties - the properties of the new folder
        Returns:
        a reference to the new folder
        Throws:
        com.lexmark.saperion.exceptions.EcmException - indicates an error