com.saperion.lookup

Interface ExtendedLookupEntryService

All Superinterfaces:

com.lexmark.saperion.lookup.LookupEntryService

All Known Implementing Classes:

RmiClientExtendedLookupEntryService

public interface ExtendedLookupEntryService
extends com.lexmark.saperion.lookup.LookupEntryService

This service collects extended functionality that the jcs provides in a lookup entry service that will not be implemented in the ecm server.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
com.lexmark.saperion.lookup.LookupEntryReferenceType	createLookupEntry(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference, Map<String,com.lexmark.saperion.PropertyType> 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.
List<com.lexmark.saperion.administration.AclReferenceType>	getAccessControlLists(com.lexmark.saperion.lookup.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.lookup.LookupEntryReferenceType reference) This method returns the current users rights on the given lookup entry.
List<com.lexmark.saperion.lookup.LookupEntryListItemType>	searchLookupEntries(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference, com.lexmark.saperion.remote.common.query.QueryExpression<Boolean> filter) This method lists the lookup entries that meet a given filtering condition.
com.lexmark.saperion.lookup.LookupEntryListItemType	searchUniqueLookupEntry(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference, com.lexmark.saperion.remote.common.query.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.lookup.LookupEntryReferenceType id, Map<String,com.lexmark.saperion.PropertyType> properties) Updates the lookup entry given by the id in the given ddc with the given properties.
void	updateLookEntry(com.lexmark.saperion.lookup.LookupEntryReferenceType id, Map<String,com.lexmark.saperion.PropertyType> 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.

Methods inherited from interface com.lexmark.saperion.lookup.LookupEntryService

createLookupEntry, createLookupEntry, deleteLookupEntry, getACLs, getLookupEntry, newMultiValueFieldSearchService, newSearchService, updateLookupEntry, updateLookupEntry

Method Detail

createLookupEntry

com.lexmark.saperion.lookup.LookupEntryReferenceType createLookupEntry(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference,
                                                                       Map<String,com.lexmark.saperion.PropertyType> indexData,
                                                                       List<com.lexmark.saperion.administration.AclReferenceType> aclReferences)
                                                                throws com.lexmark.saperion.exceptions.EcmException

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

Parameters:

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

com.lexmark.saperion.exceptions.EcmException

updateLookEntry

void updateLookEntry(com.lexmark.saperion.lookup.LookupEntryReferenceType id,
                     Map<String,com.lexmark.saperion.PropertyType> indexDataChanges,
                     List<com.lexmark.saperion.administration.AclReferenceType> aclReferences)
              throws com.lexmark.saperion.exceptions.EcmException

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 an instance of PropertyType whose value is null

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

Throws:

com.lexmark.saperion.exceptions.EcmException

updateLookEntry

void updateLookEntry(com.lexmark.saperion.lookup.LookupEntryReferenceType id,
                     Map<String,com.lexmark.saperion.PropertyType> properties)
              throws com.lexmark.saperion.exceptions.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:

com.lexmark.saperion.exceptions.EcmException

getAccessControlLists

List<com.lexmark.saperion.administration.AclReferenceType> getAccessControlLists(com.lexmark.saperion.lookup.LookupEntryReferenceType reference)
                                                                          throws com.lexmark.saperion.exceptions.EcmException

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:

com.lexmark.saperion.exceptions.EcmException

getAccessOnEntry

Set<com.lexmark.saperion.administration.AccessRight> getAccessOnEntry(com.lexmark.saperion.lookup.LookupEntryReferenceType reference)
                                                               throws com.lexmark.saperion.exceptions.EcmException

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:

com.lexmark.saperion.exceptions.EcmException

searchUniqueLookupEntry

com.lexmark.saperion.lookup.LookupEntryListItemType searchUniqueLookupEntry(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference,
                                                                            com.lexmark.saperion.remote.common.query.QueryExpression<Boolean> filter)
                                                                     throws com.lexmark.saperion.exceptions.EcmException

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:

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

com.lexmark.saperion.exceptions.EcmException

searchLookupEntries

List<com.lexmark.saperion.lookup.LookupEntryListItemType> searchLookupEntries(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference,
                                                                              com.lexmark.saperion.remote.common.query.QueryExpression<Boolean> filter)
                                                                       throws com.lexmark.saperion.exceptions.EcmException

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

Parameters:

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

com.lexmark.saperion.exceptions.EcmException