Package com.saperion.connector.service

Class RmiClientExtendedLookupEntryService

java.lang.Object

com.lexmark.saperion.remote.client.AbstractRmiClientService

com.lexmark.saperion.remote.client.service.RmiClientLookupEntryService

com.saperion.connector.service.RmiClientExtendedLookupEntryService

All Implemented Interfaces:

com.lexmark.saperion.lookup.LookupEntryService, ExtendedLookupEntryService

public class RmiClientExtendedLookupEntryService
extends com.lexmark.saperion.remote.client.service.RmiClientLookupEntryService
implements ExtendedLookupEntryService

This is the remote client implementation of the extended lookup entry service.

Author:

jschwarz

Field Summary

Fields inherited from class com.lexmark.saperion.remote.client.AbstractRmiClientService

ecmConnection

Constructor Summary

Constructors

Constructor	Description
RmiClientExtendedLookupEntryService(com.lexmark.saperion.remote.common.Connection connection, SaClassicConnector classicConnector)

Method Summary

Modifier and Type	Method	Description
com.lexmark.saperion.lookup.LookupEntryReferenceType	createLookupEntry(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference, java.util.Map<java.lang.String,com.lexmark.saperion.PropertyType> properties)
com.lexmark.saperion.lookup.LookupEntryReferenceType	createLookupEntry(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference, java.util.Map<java.lang.String,com.lexmark.saperion.PropertyType> indexData, java.util.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.
java.util.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.
java.util.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.
java.util.List<com.lexmark.saperion.lookup.LookupEntryListItemType>	searchLookupEntries(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference, com.lexmark.saperion.remote.common.query.QueryExpression<java.lang.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<java.lang.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, java.util.Map<java.lang.String,com.lexmark.saperion.PropertyType> indexDataChanges, java.lang.Boolean recycleBinAware)	Updates the lookup entry given by the id in the given ddc with the given properties.
void	updateLookEntry(com.lexmark.saperion.lookup.LookupEntryReferenceType id, java.util.Map<java.lang.String,com.lexmark.saperion.PropertyType> indexDataChanges, java.util.List<com.lexmark.saperion.administration.AclReferenceType> aclReferences, java.lang.Boolean recycleBinAware)	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 class com.lexmark.saperion.remote.client.service.RmiClientLookupEntryService

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Constructor Detail

RmiClientExtendedLookupEntryService

public RmiClientExtendedLookupEntryService(com.lexmark.saperion.remote.common.Connection connection,
                                           SaClassicConnector classicConnector)

Method Detail

createLookupEntry

public com.lexmark.saperion.lookup.LookupEntryReferenceType createLookupEntry(com.lexmark.saperion.archive.ArchiveReferenceType archiveReference,
                                                                              java.util.Map<java.lang.String,com.lexmark.saperion.PropertyType> properties)
                                                                       throws com.lexmark.saperion.exceptions.EcmException

Specified by:

createLookupEntry in interface com.lexmark.saperion.lookup.LookupEntryService

Overrides:

createLookupEntry in class com.lexmark.saperion.remote.client.service.RmiClientLookupEntryService

Throws:

com.lexmark.saperion.exceptions.EcmException

createLookupEntry

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

Description copied from interface: ExtendedLookupEntryService

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

Specified by:

createLookupEntry in interface ExtendedLookupEntryService

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

public void updateLookEntry(com.lexmark.saperion.lookup.LookupEntryReferenceType id,
                            java.util.Map<java.lang.String,com.lexmark.saperion.PropertyType> indexDataChanges,
                            java.lang.Boolean recycleBinAware)
                     throws com.lexmark.saperion.exceptions.EcmException

Description copied from interface: ExtendedLookupEntryService

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

Specified by:

updateLookEntry in interface ExtendedLookupEntryService

Parameters:

id - the id of the document to update

indexDataChanges - 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

Throws:

com.lexmark.saperion.exceptions.EcmException

updateLookEntry

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

Description copied from interface: ExtendedLookupEntryService

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

Specified by:

updateLookEntry in interface ExtendedLookupEntryService

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

Throws:

com.lexmark.saperion.exceptions.EcmException

getAccessControlLists

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

Description copied from interface: ExtendedLookupEntryService

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

Specified by:

getAccessControlLists in interface ExtendedLookupEntryService

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

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

Description copied from interface: ExtendedLookupEntryService

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

Specified by:

getAccessOnEntry in interface ExtendedLookupEntryService

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

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

Description copied from interface: ExtendedLookupEntryService

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.

Specified by:

searchUniqueLookupEntry in interface ExtendedLookupEntryService

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

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

Description copied from interface: ExtendedLookupEntryService

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

Specified by:

searchLookupEntries in interface ExtendedLookupEntryService

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