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

Modifier and Type	Method and Description
FolderReferenceType	createFolder(ArchiveReferenceType archiveReference, String folderName, Map<String,PropertyType> index) This method creates a new folder with the given input data.
FolderReferenceType	createFolder(ArchiveReferenceType archiveReference, String folderName, Map<String,PropertyType> index, FolderReferenceType parent) This method creates a new folder with the given input data.
FolderReferenceType	createFolder(CreateFolderInputType properties) This method creates a new folder with the given input data.
FolderClient	resolve(FolderReferenceType reference) This method returns a client for the folder referenced.

Method Detail

resolve

FolderClient resolve(FolderReferenceType reference)
              throws 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:

EcmException

createFolder

FolderReferenceType createFolder(ArchiveReferenceType archiveReference,
                                 String folderName,
                                 Map<String,PropertyType> index)
                          throws 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:

EcmException - indicates an error

createFolder

FolderReferenceType createFolder(ArchiveReferenceType archiveReference,
                                 String folderName,
                                 Map<String,PropertyType> index,
                                 FolderReferenceType parent)
                          throws 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:

EcmException - indicates an error

createFolder

FolderReferenceType createFolder(CreateFolderInputType properties)
                          throws 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:

EcmException - indicates an error