com.saperion.lookup

Interface LookupEntryService

All Known Implementing Classes:

RmiClientLookupEntryService

public interface LookupEntryService

Implementations of this class hold core functionality concerning lookup tables.

Author:

jschwarz

Method Summary

Methods

Modifier and Type	Method and Description
com.lexmark.saperion.LookupEntryReferenceType	createLookupEntry(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionReference, Map<String,Object> indexData) Creates a new lookup entry with the given index data in the given definition.
com.lexmark.saperion.LookupEntryReferenceType	createLookupEntry(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionReference, Map<String,Object> indexData, List<com.lexmark.saperion.administration.AclReferenceType> aclReferences) Creates a new lookup entry with the given index data in the given definition with the given access control lists.
void	deleteLookupEntry(com.lexmark.saperion.LookupEntryReferenceType id) Deletes the lookup entry give by its id.
List<com.lexmark.saperion.administration.AclReferenceType>	getAccessControlLists(com.lexmark.saperion.LookupEntryReferenceType reference) This method returns the list of access control lists set on a given lookup entry.
Set<com.lexmark.saperion.administration.AccessRight>	getAccessOnEntry(com.lexmark.saperion.LookupEntryReferenceType reference) This method returns the current users rights on the given lookup entry.
com.lexmark.saperion.LookupEntryType	getLookupEntry(com.lexmark.saperion.LookupEntryReferenceType reference) This method returns the lookup entry the given reference references.
List<com.lexmark.saperion.LookupEntryType>	searchLookupEntries(com.lexmark.saperion.document.DocumentDefinitionReferenceType documentDefinitionReference, QueryExpression<Boolean> filter) This method lists the lookup entries that meet a given filtering condition.
com.lexmark.saperion.LookupEntryType	searchUniqueLookupEntry(com.lexmark.saperion.document.DocumentDefinitionReferenceType documentDefinitionReference, QueryExpression<Boolean> filter) This method returns the single lookup entry from a given ddc that meets the given filtering condition.
void	updateLookEntry(com.lexmark.saperion.LookupEntryReferenceType id, Map<String,Object> indexDataChanges) Updates the lookup entry given by the id in the given ddc with the given properties.
void	updateLookEntry(com.lexmark.saperion.LookupEntryReferenceType id, Map<String,Object> indexDataChanges, List<com.lexmark.saperion.administration.AclReferenceType> aclReferences) Updates the lookup entry given by the id in the given ddc with the given properties and the given access control lists.

Method Detail

createLookupEntry

com.lexmark.saperion.LookupEntryReferenceType createLookupEntry(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionReference,
                                                              Map<String,Object> indexData,
                                                              List<com.lexmark.saperion.administration.AclReferenceType> aclReferences)
                                                                throws SaBasicException

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

Parameters:

definitionReference - the definition to create the entry in

indexData - the index data of the new lookup entry

aclReferences - the access control lists securing the new lookup entry

Returns:

the id of the newly created entry

Throws:

SaBasicException

createLookupEntry

com.lexmark.saperion.LookupEntryReferenceType createLookupEntry(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionReference,
                                                              Map<String,Object> indexData)
                                                                throws SaBasicException

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

Parameters:

definitionReference - 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:

SaBasicException

updateLookEntry

void updateLookEntry(com.lexmark.saperion.LookupEntryReferenceType id,
                   Map<String,Object> indexDataChanges,
                   List<com.lexmark.saperion.administration.AclReferenceType> aclReferences)
                     throws SaBasicException

Updates the lookup entry given by the id in the given ddc with the given properties and the given access control lists.

Parameters:

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

aclReferences - the new access control lists securing the lookup entry or null if no change in the access control lists is intended

Throws:

SaBasicException

updateLookEntry

void updateLookEntry(com.lexmark.saperion.LookupEntryReferenceType id,
                   Map<String,Object> indexDataChanges)
                     throws SaBasicException

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

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:

SaBasicException

deleteLookupEntry

void deleteLookupEntry(com.lexmark.saperion.LookupEntryReferenceType id)
                       throws SaBasicException

Deletes the lookup entry give by its id.

Parameters:

id - the id of the lookup entry to delete

Throws:

SaBasicException

searchUniqueLookupEntry

com.lexmark.saperion.LookupEntryType searchUniqueLookupEntry(com.lexmark.saperion.document.DocumentDefinitionReferenceType documentDefinitionReference,
                                                           QueryExpression<Boolean> filter)
                                                             throws SaBasicException

This method returns the single lookup entry from a given ddc that meets the given filtering condition. If no such entry exists, null will be returned. If several such entries exist an exception is thrown.

Parameters:

documentDefinitionReference - a reference to a lookup ddc to search in

filter - a filter defining which unique lookup entry to return

Returns:

the single lookup entry from a given ddc that meets the given filtering condition

Throws:

SaBasicException

searchLookupEntries

List<com.lexmark.saperion.LookupEntryType> searchLookupEntries(com.lexmark.saperion.document.DocumentDefinitionReferenceType documentDefinitionReference,
                                                             QueryExpression<Boolean> filter)
                                                               throws SaBasicException

This method lists the lookup entries that meet a given filtering condition.

Parameters:

documentDefinitionReference - a reference to a lookup ddc to search in

filter - a filter defining which lookup entries to return

Returns:

the list of all lookup entries in the given ddc that meet the condition

Throws:

SaBasicException

getLookupEntry

com.lexmark.saperion.LookupEntryType getLookupEntry(com.lexmark.saperion.LookupEntryReferenceType reference)
                                                    throws SaBasicException

This method returns the lookup entry the given reference references. Will throw an UnknownReferenceException 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:

SaBasicException

getAccessControlLists

List<com.lexmark.saperion.administration.AclReferenceType> getAccessControlLists(com.lexmark.saperion.LookupEntryReferenceType reference)
                                                                                 throws SaBasicException

This method returns the list of access control lists set on a given lookup entry.

Parameters:

reference - a reference to the lookup entry to obtain the access control lists for

Returns:

a list of references to the access control lists set on the given lokup entry

Throws:

SaBasicException

getAccessOnEntry

Set<com.lexmark.saperion.administration.AccessRight> getAccessOnEntry(com.lexmark.saperion.LookupEntryReferenceType reference)
                                                                      throws SaBasicException

This method returns the current users rights on the given lookup entry.

Parameters:

reference - the id of the lookup entry to evaluate the current users rights for

Returns:

the current users rights on the given lookup entry

Throws:

SaBasicException