com.saperion.operations.lookup

Class CreateLookupEntryOperation

java.lang.Object

com.saperion.operations.BaseOperation<T>

com.saperion.operations.AbstractOperation<com.lexmark.saperion.LookupEntryReferenceType>

com.saperion.operations.lookup.CreateLookupEntryOperation

All Implemented Interfaces:

Operation<com.lexmark.saperion.LookupEntryReferenceType>, Serializable

public class CreateLookupEntryOperation
extends AbstractOperation<com.lexmark.saperion.LookupEntryReferenceType>

An Operation that creates a lookup entry. The invoke() method will return a string containing the SYSROWID of the created entry.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateLookupEntryOperation(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionReference, Map<String,Object> indexData) Constructs a new operation that creates an entry in the given lookup-ddc with the given properties.
CreateLookupEntryOperation(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionReference, Map<String,Object> indexData, List<com.lexmark.saperion.administration.AclReferenceType> aclReferences) Constructs a new operation that creates an entry in the given lookup-ddc with the given properties.
CreateLookupEntryOperation(String ddc, Map<String,Object> props) Constructs a new operation that creates an entry in the given lookup-ddc with the given properties.
CreateLookupEntryOperation(String ddc, Properties props) Constructs a new operation that creates an entry in the given lookup-ddc with the given properties.

Method Summary

Methods

Modifier and Type	Method and Description
List<com.lexmark.saperion.administration.AclReferenceType>	getAclReferences()
com.lexmark.saperion.document.DocumentDefinitionReferenceType	getDefinitionReference()
Map<String,Object>	getIndexData()
com.lexmark.saperion.LookupEntryReferenceType	invoke() The method that will be called on the server side.
static Map<String,Object>	naivePropertiesConversion(Properties props) Used to convert a Properties instance to a Map.
String	toString()

Methods inherited from class com.saperion.operations.AbstractOperation

afterInvoke, getResult, toArrayList

Methods inherited from class com.saperion.operations.BaseOperation

beforeInvoke, getClientToken, mapException

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateLookupEntryOperation

public CreateLookupEntryOperation(String ddc,
                          Map<String,Object> props)

Constructs a new operation that creates an entry in the given lookup-ddc with the given properties. For a given ddc-field the accepted java types depend on the type of the field:

• text, unicode-text, etc : String
• integer-field : byte, short, int, long and any implementation of Number (this includes the wrapper classes of the given primitive types)
• float-field, currency : float, double and any implementation of Number (this includes the wrapper classes of the given primitive types)
• date, time, date-time : Calendar and Date. Keep in mind that Date, Time and Timestamp are subclasses of Date and thus are accepted
• boolean-field : boolean and Boolean
• multi value fields: arrays and implementations of List of the types accepted for the field
• any field: SaPropertyValueImpl

Parameters:

ddc - the name of the lookup-ddc to add the entry in.

props - properties of the new entry.

CreateLookupEntryOperation

public CreateLookupEntryOperation(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionReference,
                          Map<String,Object> indexData)

Constructs a new operation that creates an entry in the given lookup-ddc with the given properties. For a given ddc-field the accepted java types depend on the type of the field:

• text, unicode-text, etc : String
• integer-field : byte, short, int, long and any implementation of Number (this includes the wrapper classes of the given primitive types)
• float-field, currency : float, double and any implementation of Number (this includes the wrapper classes of the given primitive types)
• date, time, date-time : Calendar and Date. Keep in mind that Date, Time and Timestamp are subclasses of Date and thus are accepted
• boolean-field : boolean and Boolean
• multi value fields: arrays and implementations of List of the types accepted for the field
• any field: SaPropertyValueImpl

Parameters:

definitionReference - a reference to the lookup-ddc to add the entry in.

indexData - the index data of the new entry.

CreateLookupEntryOperation

public CreateLookupEntryOperation(com.lexmark.saperion.document.DocumentDefinitionReferenceType definitionReference,
                          Map<String,Object> indexData,
                          List<com.lexmark.saperion.administration.AclReferenceType> aclReferences)

Constructs a new operation that creates an entry in the given lookup-ddc with the given properties. For a given ddc-field the accepted java types depend on the type of the field:

• text, unicode-text, etc : String
• integer-field : byte, short, int, long and any implementation of Number (this includes the wrapper classes of the given primitive types)
• float-field, currency : float, double and any implementation of Number (this includes the wrapper classes of the given primitive types)
• date, time, date-time : Calendar and Date. Keep in mind that Date, Time and Timestamp are subclasses of Date and thus are accepted
• boolean-field : boolean and Boolean
• multi value fields: arrays and implementations of List of the types accepted for the field
• any field: SaPropertyValueImpl

Parameters:

definitionReference - a reference to the lookup-ddc to add the entry in.

indexData - the index data of the new entry.

aclReferences - a list of references to access control lists that define the access to the new lookup entry

CreateLookupEntryOperation

public CreateLookupEntryOperation(String ddc,
                          Properties props)

Constructs a new operation that creates an entry in the given lookup-ddc with the given properties. For the types accepted in the properties see CreateLookupEntryOperation(String, Properties) CreateLookupEntry(String, java.util.Map)}

Parameters:

ddc - the name of the lookup-ddc to add the entry in.

props - properties of the new entry.

Method Detail

naivePropertiesConversion

public static Map<String,Object> naivePropertiesConversion(Properties props)

Used to convert a Properties instance to a Map.

Parameters:

props - properties to convert

Returns:

map containing properties

invoke

public com.lexmark.saperion.LookupEntryReferenceType invoke()
                                                     throws SaBasicException

Description copied from interface: Operation

The method that will be called on the server side.

Returns:

the result of the operation

Throws:

SaBasicException - exception when invoking this operation

getDefinitionReference

public com.lexmark.saperion.document.DocumentDefinitionReferenceType getDefinitionReference()

getIndexData

public Map<String,Object> getIndexData()

getAclReferences

public List<com.lexmark.saperion.administration.AclReferenceType> getAclReferences()

toString

public String toString()

Overrides:

toString in class AbstractOperation<com.lexmark.saperion.LookupEntryReferenceType>