com.lexmark.saperion.folder

Interface FolderService

public interface FolderService

This service provides functionality concerning folders.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
void	addDocuments(FolderReferenceType folder, List<DocumentReferenceType> documents) This method adds the given documents to the given folder.
FolderReferenceType	createFolder(ArchiveReferenceType archiveReference, String folderName, Map<String,PropertyType> index, FolderReferenceType parent) This method creates a new folder in the given folder archive.
FolderReferenceType	createFolder(CreateFolderInputType properties) This method creates a new folder in the given folder archive.
void	delete(FolderReferenceType reference) This method deletes the folder given by its reference.
List<AclReferenceType>	getACLs(FolderReferenceType reference) This method returns the ACLs of the referenced folder.
FolderListItemType	getFolder(FolderReferenceType reference) This method returns the folder given by its reference.
void	moveFolder(FolderReferenceType reference, FolderReferenceType target) This method moves the given folder to the given target.
SearchExecutionService<DocumentRevisionListItemType>	newContainedDocumentSearchService(FolderReferenceType folder) This method returns a search execution service that lists the documents contained in the given folder.
SearchExecutionService<FolderListItemType>	newContainedFolderSearchService(FolderReferenceType parent) This method creates a new search execution service that lists the directly contained folders of the folder given.
SearchExecutionService<FolderListItemType>	newFolderSearchService(ArchiveReferenceType archive) This method creates a new search execution service that all folders in a folder archive.
SearchExecutionService<PropertyType>	newMultiValueFieldSearchService(FolderReferenceType folder, String fieldName) This method creates a new search service that searches in the values that are set on the given multi value field for the given folder.
void	removeDocument(FolderReferenceType folder, DocumentReferenceType document) This method removes the given document from the given folder.
void	updateFolder(FolderReferenceType reference, Map<String,PropertyType> index) This method updates a folder with the given index data.
void	updateFolder(FolderReferenceType folderReference, UpdateFolderInputType properties) This method updates a folder with the given properties.

Method Detail

createFolder

FolderReferenceType createFolder(ArchiveReferenceType archiveReference,
                                 String folderName,
                                 Map<String,PropertyType> index,
                                 FolderReferenceType parent)
                          throws EcmException

This method creates a new folder in the given folder archive. The new folder will have the given index data and be contained in the given parent folder. If the parent folder is null, it will be contained in the root folder of the given archive.

Parameters:

archiveReference - a reference to the folder archive to create the folder in

folderName - the name of the folder

index - the index data for the folder

parent - a reference to the parent of the folder or null if the root folder should be the parent

Returns:

a reference to the newly created folder.

Throws:

EcmException

createFolder

FolderReferenceType createFolder(CreateFolderInputType properties)
                          throws EcmException

This method creates a new folder in the given folder archive. The new folder will have the given index data and be contained in the given parent folder. If the parent folder is null, it will be contained in the root folder of the given archive.

Parameters:

properties - the properties of the new folder containing the parent, the index-data, ACLs and the archive

Returns:

a reference to the newly created folder.

Throws:

EcmException

getFolder

FolderListItemType getFolder(FolderReferenceType reference)
                      throws EcmException

This method returns the folder given by its reference.

Parameters:

reference - a reference to the folder to load

Returns:

the folder that is referenced by the given reference

Throws:

EcmException

updateFolder

void updateFolder(FolderReferenceType reference,
                  Map<String,PropertyType> index)
           throws EcmException

This method updates a folder with the given index data.

Parameters:

reference - a reference to the folder to update

index - the new index data of the folder

Throws:

EcmException

updateFolder

void updateFolder(FolderReferenceType folderReference,
                  UpdateFolderInputType properties)
           throws EcmException

This method updates a folder with the given properties.

Parameters:

folderReference - a reference to the folder to update

properties - the properties to update

Throws:

EcmException

delete

void delete(FolderReferenceType reference)
     throws EcmException

This method deletes the folder given by its reference. Note that if the folder is not empty, all sub-folders will be deleted, too. Documents contained in the folder (or its sub-folders) will not be deleted from their archives.

Parameters:

reference - a reference to the folder to delete

Throws:

EcmException

newContainedFolderSearchService

SearchExecutionService<FolderListItemType> newContainedFolderSearchService(FolderReferenceType parent)
                                                                    throws EcmException

This method creates a new search execution service that lists the directly contained folders of the folder given. The result will be paged and may be filtered.

Parameters:

parent - a reference to the folder to get the directly contained folders for

Returns:

a new search execution service that lists the directly contained folders

Throws:

EcmException

newFolderSearchService

SearchExecutionService<FolderListItemType> newFolderSearchService(ArchiveReferenceType archive)
                                                           throws EcmException

This method creates a new search execution service that all folders in a folder archive.

Parameters:

archive - a reference to the archive to obtain the search service for

Returns:

a new search execution service that all folders in a folder archive

Throws:

EcmException

moveFolder

void moveFolder(FolderReferenceType reference,
                FolderReferenceType target)
         throws EcmException

This method moves the given folder to the given target. Afterwards the parent of the folder is the target.

Parameters:

reference - a reference to the folder to move

target - a reference to the new parent of the folder

Throws:

EcmException

newContainedDocumentSearchService

SearchExecutionService<DocumentRevisionListItemType> newContainedDocumentSearchService(FolderReferenceType folder)
                                                                                throws EcmException

This method returns a search execution service that lists the documents contained in the given folder.

Parameters:

folder - a reference to the folder to list the contained documents of

Returns:

a page of the list references to the documents contained in the folder

Throws:

EcmException

addDocuments

void addDocuments(FolderReferenceType folder,
                  List<DocumentReferenceType> documents)
           throws EcmException

This method adds the given documents to the given folder.

Parameters:

folder - a reference to the folder to file the documents in

documents - a list with references to the documents to file

Throws:

EcmException

removeDocument

void removeDocument(FolderReferenceType folder,
                    DocumentReferenceType document)
             throws EcmException

This method removes the given document from the given folder. Note that the document will not be deleted. It will just be not contained in the folder anymore.

Parameters:

folder - a reference to the folder to remove the document from

document - a reference to the document to remove from the folder

Throws:

EcmException

newMultiValueFieldSearchService

SearchExecutionService<PropertyType> newMultiValueFieldSearchService(FolderReferenceType folder,
                                                                     String fieldName)
                                                              throws EcmException

This method creates a new search service that searches in the values that are set on the given multi value field for the given folder.

Parameters:

folder - the folder to search in

fieldName - the multi value field to search in

Returns:

a new search execution service

Throws:

EcmException

getACLs

List<AclReferenceType> getACLs(FolderReferenceType reference)
                        throws EcmException

This method returns the ACLs of the referenced folder.

Parameters:

reference - a reference to the folder

Returns:

the ACLs of the references folder

Throws:

EcmException