com.lexmark.saperion.lookup

Interface LookupEntryService

public interface LookupEntryService

Implementations of this class hold core functionality concerning lookup tables.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
LookupEntryReferenceType	createLookupEntry(ArchiveReferenceType archiveReference, Map<String,PropertyType> properties) Creates a new lookup entry with the given index data in the given definition.
LookupEntryReferenceType	createLookupEntry(CreateLookupEntryInputType properties) Creates a new lookup entry with the given index data in the given definition.
void	deleteLookupEntry(LookupEntryReferenceType id) Deletes the lookup entry give by its id.
List<AclReferenceType>	getACLs(LookupEntryReferenceType id) This method returns the ACLs currently set on the specified lookup entry.
LookupEntryListItemType	getLookupEntry(LookupEntryReferenceType reference) This method returns the lookup entry the given reference references.
SearchExecutionService<PropertyType>	newMultiValueFieldSearchService(LookupEntryReferenceType lookupEntry, 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 lookup entry.
SearchExecutionService<LookupEntryListItemType>	newSearchService(ArchiveReferenceType archive) This method creates a new search service that searches lookup entries in the given archive.
void	updateLookupEntry(LookupEntryReferenceType id, Map<String,PropertyType> properties) Updates the lookup entry given by the id in the given ddc with the given properties.
void	updateLookupEntry(LookupEntryReferenceType id, UpdateLookupEntryInputType properties) Updates the lookup entry given by the id in the given ddc with the given properties.

Method Detail

createLookupEntry

LookupEntryReferenceType createLookupEntry(ArchiveReferenceType archiveReference,
                                           Map<String,PropertyType> properties)
                                    throws EcmException

Creates a new lookup entry with the given index data in the given definition.

Parameters:

archiveReference - the reference to the archive to create the entry in

properties - the properties of the new lookup entry

Returns:

the id of the newly created entry

Throws:

EcmException

createLookupEntry

LookupEntryReferenceType createLookupEntry(CreateLookupEntryInputType properties)
                                    throws EcmException

Creates a new lookup entry with the given index data in the given definition.

Parameters:

properties - the properties of the new lookup entry

Returns:

the id of the newly created entry

Throws:

EcmException

updateLookupEntry

void updateLookupEntry(LookupEntryReferenceType id,
                       UpdateLookupEntryInputType properties)
                throws EcmException

Updates the lookup entry given by the id in the given ddc with the given properties.

Parameters:

id - the id of the document to update

properties - the new properties. For index-data, only the changed values need to be specified. If a property should be deleted set it to an instance of PropertyType whose value is null. If the set of ACLs is not null, it will replace the set of ACLs currently set on the lookup entry.

Throws:

EcmException

updateLookupEntry

void updateLookupEntry(LookupEntryReferenceType id,
                       Map<String,PropertyType> properties)
                throws EcmException

Updates the lookup entry given by the id in the given ddc with the given properties.

Parameters:

id - the id of the document to update

properties - the new properties. For index-data, only the changed values need to be specified. If a property should be deleted set it to an instance of PropertyType whose value is null.

Throws:

EcmException

getACLs

List<AclReferenceType> getACLs(LookupEntryReferenceType id)
                        throws EcmException

This method returns the ACLs currently set on the specified lookup entry.

Parameters:

id - the reference to the lookup entry

Returns:

a set of ACLs currently set on the lookup entry

Throws:

EcmException - when the ACLs could not be loaded

deleteLookupEntry

void deleteLookupEntry(LookupEntryReferenceType id)
                throws EcmException

Deletes the lookup entry give by its id.

Parameters:

id - the id of the lookup entry to delete

Throws:

EcmException

getLookupEntry

LookupEntryListItemType getLookupEntry(LookupEntryReferenceType reference)
                                throws EcmException

This method returns the lookup entry the given reference references. Will throw an ResourceNotFoundException if there is no lookup entry with the given reference.

Parameters:

reference - a reference to the lookup entry to obtain

Returns:

the lookup entry the reference references

Throws:

EcmException

newSearchService

SearchExecutionService<LookupEntryListItemType> newSearchService(ArchiveReferenceType archive)
                                                          throws EcmException

This method creates a new search service that searches lookup entries in the given archive.

Parameters:

archive - a reference to the archive to search

Returns:

a new search service that searches lookup entries in the given archive

Throws:

EcmException

newMultiValueFieldSearchService

SearchExecutionService<PropertyType> newMultiValueFieldSearchService(LookupEntryReferenceType lookupEntry,
                                                                     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 lookup entry.

Parameters:

lookupEntry - the lookup entry to search in

fieldName - the multi value field to search in

Returns:

a new search execution service

Throws:

EcmException - signalizes a system error