com.saperion.lookup

Interface LookupEntryService

public interface LookupEntryService

Holds core functionality for lookup ddcs.

Author:

jschwarz

Method Summary

Methods

Modifier and Type	Method and Description
String	createLookupEntry(String definitionName, Map<String,Object> indexData) Creates a new lookup entry with the given index data in the given definition.
void	deleteLookupEntry(String definitionName, String id) Deletes the lookup entry give by its id.
void	updateLookEntry(String definitionName, String id, Map<String,Object> indexDataChanges) Updates the lookup entry given by the id in the given ddc with the given properties.

Method Detail

createLookupEntry

String createLookupEntry(String definitionName,
                       Map<String,Object> indexData)
                         throws SaRMIAuthenticationException,
                                SaRMIDDCException,
                                SaRMISystemException,
                                SaRMIUniqueConstraintViolationException,
                                SaRMIDBException,
                                MandatoryConstraintViolation

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

Parameters:

definitionName - the definition to create the entry in

indexData - the index data of the new lookup entry

Returns:

the id of the newly created entry

Throws:

SaRMIAuthenticationException

SaRMIDDCException

SaRMISystemException

SaRMIUniqueConstraintViolationException

SaRMIDBException

MandatoryConstraintViolation

updateLookEntry

void updateLookEntry(String definitionName,
                   String id,
                   Map<String,Object> indexDataChanges)
                     throws SaRMIAuthenticationException,
                            SaRMIDDCException,
                            SaRMISystemException,
                            SaRMIDBException,
                            UnknownIdException,
                            MandatoryConstraintViolation,
                            SaRMIUniqueConstraintViolationException

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

Parameters:

definitionName - the name of the definition the document is in.

id - the id of the document to update

indexDataChanges - the new index values. Only the changed values need to be specified. If a property should be deleted set it to DeleteDocumentProperty.INSTANCE

Throws:

SaRMIAuthenticationException

SaRMIDDCException

SaRMISystemException

SaRMIDBException

UnknownIdException

MandatoryConstraintViolation

SaRMIUniqueConstraintViolationException

deleteLookupEntry

void deleteLookupEntry(String definitionName,
                     String id)
                       throws SaRMIAuthenticationException,
                              SaRMIDDCException,
                              SaRMISystemException

Deletes the lookup entry give by its id.

Parameters:

definitionName - the name of the definition to delete from

id - the id of the lookup entry to delete

Throws:

SaRMIAuthenticationException

SaRMIDDCException

SaRMISystemException