com.lexmark.saperion.client.lookup

Interface LookupEntryClient

All Known Implementing Classes:

LookupEntryClientImpl

public interface LookupEntryClient

This client provides functionality for reading and modifying a given lookup entry.

Author:

jschwarz

Method Summary

Modifier and Type	Method and Description
void	delete() This method deletes the lookup entry instance.
List<AclReferenceType>	getACLs() This method loads the ACLs that are currently set on this lookup entry.
LookupEntryListItemType	load() This method loads the lookup entry instance.
SearchClient<PropertyType>	searchMultiValueField(String fieldName) This method returns a search client for the content of the given multi value field of the given lookup entry.
void	update(Map<String,PropertyType> properties) This method updates a Lookup entry instance.
void	update(UpdateLookupEntryInputType properties) This method updates a Lookup entry instance.

Method Detail

update

void update(Map<String,PropertyType> properties)
     throws EcmException

This method updates a Lookup entry instance.

Parameters:

properties - the properties to update

Throws:

EcmException - indicates any system error

update

void update(UpdateLookupEntryInputType properties)
     throws EcmException

This method updates a Lookup entry instance.

Parameters:

properties - the properties to update

Throws:

EcmException - indicates any system error

delete

void delete()
     throws EcmException

This method deletes the lookup entry instance.

Throws:

EcmException - indicates any system error

load

LookupEntryListItemType load()
                      throws EcmException

This method loads the lookup entry instance.

Returns:

LookupEntryListItemType

Throws:

EcmException - indicates any system error

searchMultiValueField

SearchClient<PropertyType> searchMultiValueField(String fieldName)
                                          throws EcmException

This method returns a search client for the content of the given multi value field of the given lookup entry.

Parameters:

fieldName - the name of the multi value field

Returns:

a search client for the content of the given multi value field of the given lookup entry

Throws:

EcmException

getACLs

List<AclReferenceType> getACLs()
                        throws EcmException

This method loads the ACLs that are currently set on this lookup entry.

Returns:

a list of references to the entry's ACLs

Throws:

EcmException - when the ACLs could not be loaded