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<com.lexmark.saperion.administration.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<com.lexmark.saperion.folder.FolderListItemType>	getSubFolders() This method returns a collection containing the sub folders of this folder.
com.lexmark.saperion.folder.FolderListItemType	load() This method returns the properties of the specified folder.
void	moveFolder(com.lexmark.saperion.folder.FolderReferenceType parent) This method moves a folder to another parent.
SearchClient<com.lexmark.saperion.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,com.lexmark.saperion.PropertyType> input) This method updates the properties of the given folder.
void	update(com.lexmark.saperion.folder.UpdateFolderInputType properties) This method updates the properties of the given folder.

Method Detail

delete

void delete()
     throws com.lexmark.saperion.exceptions.EcmException

This method deletes the specified folder.

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

load

com.lexmark.saperion.folder.FolderListItemType load()
                                             throws com.lexmark.saperion.exceptions.EcmException

This method returns the properties of the specified folder.

Returns:

the properties of the folder

Throws:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

moveFolder

void moveFolder(com.lexmark.saperion.folder.FolderReferenceType parent)
         throws com.lexmark.saperion.exceptions.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:

com.lexmark.saperion.exceptions.EcmException - indicates that a system exception occurred

update

void update(Map<String,com.lexmark.saperion.PropertyType> input)
     throws com.lexmark.saperion.exceptions.EcmException

This method updates the properties of the given folder.

Parameters:

input - the new properties

Throws:

com.lexmark.saperion.exceptions.EcmException

update

void update(com.lexmark.saperion.folder.UpdateFolderInputType properties)
     throws com.lexmark.saperion.exceptions.EcmException

This method updates the properties of the given folder.

Parameters:

properties - the new properties

Throws:

com.lexmark.saperion.exceptions.EcmException

getDocuments

FolderDocumentSearchServiceClient getDocuments()
                                        throws com.lexmark.saperion.exceptions.EcmException

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

Returns:

current folder's document collection

Throws:

com.lexmark.saperion.exceptions.EcmException

getSubFolders

SearchClient<com.lexmark.saperion.folder.FolderListItemType> getSubFolders()
                                                                    throws com.lexmark.saperion.exceptions.EcmException

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

Returns:

a collection containing the sub folders of this folder

Throws:

com.lexmark.saperion.exceptions.EcmException

searchMultiValueField

SearchClient<com.lexmark.saperion.PropertyType> searchMultiValueField(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 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:

com.lexmark.saperion.exceptions.EcmException

getACLs

List<com.lexmark.saperion.administration.AclReferenceType> getACLs()
                                                            throws com.lexmark.saperion.exceptions.EcmException

This method returns the ACLs currently set on the folder.

Returns:

the ACLs currently set on the folder

Throws:

com.lexmark.saperion.exceptions.EcmException - when loading the ACLs failed