com.lexmark.saperion.client.folder

Interface FolderClient

All Known Implementing Classes:

FolderClientImpl

public interface FolderClient

This client provides functionality for reading and modifying a given folder.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
void	delete() This method deletes the specified folder.
List<AclReferenceType>	getACLs() This method returns the ACLs currently set on the folder.
FolderDocumentSearchServiceClient	getDocuments() This method returns a search client for the collection of documents contained in the current folder.
SearchClient<FolderListItemType>	getSubFolders() This method returns a collection containing the sub folders of this folder.
FolderListItemType	load() This method returns the properties of the specified folder.
void	moveFolder(FolderReferenceType parent) This method moves a folder to another parent.
SearchClient<PropertyType>	searchMultiValueField(String fieldName) This method returns a search client for the content of the given multi value field of the given folder.
void	update(Map<String,PropertyType> input) This method updates the properties of the given folder.
void	update(UpdateFolderInputType properties) This method updates the properties of the given folder.

Method Detail

delete

void delete()
     throws EcmException

This method deletes the specified folder.

Throws:

EcmException - indicates that a system exception occurred

load

FolderListItemType load()
                 throws EcmException

This method returns the properties of the specified folder.

Returns:

the properties of the folder

Throws:

EcmException - indicates that a system exception occurred

moveFolder

void moveFolder(FolderReferenceType parent)
         throws EcmException

This method moves a folder to another parent. As in the creation of the folder the new parent must not have a child with the same name already.

Parameters:

parent - the new parent reference

Throws:

EcmException - indicates that a system exception occurred

update

void update(Map<String,PropertyType> input)
     throws EcmException

This method updates the properties of the given folder.

Parameters:

input - the new properties

Throws:

EcmException

update

void update(UpdateFolderInputType properties)
     throws EcmException

This method updates the properties of the given folder.

Parameters:

properties - the new properties

Throws:

EcmException

getDocuments

FolderDocumentSearchServiceClient getDocuments()
                                        throws EcmException

This method returns a search client for the collection of documents contained in the current folder.

Returns:

current folder's document collection

Throws:

EcmException

getSubFolders

SearchClient<FolderListItemType> getSubFolders()
                                        throws EcmException

This method returns a collection containing the sub folders of this folder.

Returns:

a collection containing the sub folders of this folder

Throws:

EcmException

searchMultiValueField

SearchClient<PropertyType> searchMultiValueField(String fieldName)
                                          throws EcmException

This method returns a search client for the content of the given multi value field of the given folder.

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 folder

Throws:

EcmException

getACLs

List<AclReferenceType> getACLs()
                        throws EcmException

This method returns the ACLs currently set on the folder.

Returns:

the ACLs currently set on the folder

Throws:

EcmException - when loading the ACLs failed