com.lexmark.saperion.client.implementation.folder

Class FolderClientImpl

java.lang.Object

com.lexmark.saperion.client.implementation.folder.FolderClientImpl

All Implemented Interfaces:

FolderClient

public class FolderClientImpl
extends Object
implements FolderClient

Author:

jschwarz

Constructor Summary

Constructors

Constructor and Description
FolderClientImpl(com.lexmark.saperion.folder.FolderService folderService, com.lexmark.saperion.folder.FolderReferenceType reference)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FolderClientImpl

public FolderClientImpl(com.lexmark.saperion.folder.FolderService folderService,
                        com.lexmark.saperion.folder.FolderReferenceType reference)

Method Detail

delete

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

Description copied from interface: FolderClient

This method deletes the specified folder.

Specified by:

delete in interface FolderClient

Throws:

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

load

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

Description copied from interface: FolderClient

This method returns the properties of the specified folder.

Specified by:

load in interface FolderClient

Returns:

the properties of the folder

Throws:

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

moveFolder

public void moveFolder(com.lexmark.saperion.folder.FolderReferenceType parent)
                throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: FolderClient

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.

Specified by:

moveFolder in interface FolderClient

Parameters:

parent - the new parent reference

Throws:

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

update

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

Description copied from interface: FolderClient

This method updates the properties of the given folder.

Specified by:

update in interface FolderClient

Parameters:

input - the new properties

Throws:

com.lexmark.saperion.exceptions.EcmException

update

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

Description copied from interface: FolderClient

This method updates the properties of the given folder.

Specified by:

update in interface FolderClient

Parameters:

properties - the new properties

Throws:

com.lexmark.saperion.exceptions.EcmException

getDocuments

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

Description copied from interface: FolderClient

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

Specified by:

getDocuments in interface FolderClient

Returns:

current folder's document collection

Throws:

com.lexmark.saperion.exceptions.EcmException

getSubFolders

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

Description copied from interface: FolderClient

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

Specified by:

getSubFolders in interface FolderClient

Returns:

a collection containing the sub folders of this folder

Throws:

com.lexmark.saperion.exceptions.EcmException

searchMultiValueField

public SearchClient<com.lexmark.saperion.PropertyType> searchMultiValueField(String fieldName)
                                                                      throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: FolderClient

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

Specified by:

searchMultiValueField in interface FolderClient

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

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

Description copied from interface: FolderClient

This method returns the ACLs currently set on the folder.

Specified by:

getACLs in interface FolderClient

Returns:

the ACLs currently set on the folder

Throws:

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