ch.cern.eam.wshub.core.services.userdefinedscreens

Interface UserDefinedListService

All Known Implementing Classes:

UserDefinedListServiceImpl

public interface UserDefinedListService

Method Summary

Modifier and Type	Method and Description
String	createUserDefinedListEntry(InforContext context, UDLEntry entry)
void	deleteUDLFromEntity(InforContext context, EntityId entityId) This method should be used after you delete an entity in Infor.
String	deleteUserDefinedListEntries(InforContext context, UDLEntryId filters)
void	readUDLToEntity(InforContext context, UserDefinedListHelpable entity, EntityId entityId) This method should be used after you read an entity from Infor.
List<UDLEntry>	readUserDefinedListEntries(InforContext context, UDLEntryId filters)
Map<String,ArrayList<UDLValue>>	readUserDefinedLists(InforContext context, UDLEntryId entryId)
String	setUserDefinedLists(InforContext context, EntityId entityId, Map<String,ArrayList<UDLValue>> values)
String	updateUserDefinedListEntry(InforContext context, UDLEntry entry)
void	writeUDLToEntity(InforContext context, UserDefinedListHelpable entity, EntityId entityId) This method should be used after you update an entity in Infor.
void	writeUDLToEntityCopyFrom(InforContext context, UserDefinedListHelpable entity, EntityId entityId) This method should be used after you create an entity in Infor.

Method Detail

readUserDefinedLists

Map<String,ArrayList<UDLValue>> readUserDefinedLists(InforContext context,
                                                     UDLEntryId entryId)
                                              throws InforException

Throws:

InforException

setUserDefinedLists

String setUserDefinedLists(InforContext context,
                           EntityId entityId,
                           Map<String,ArrayList<UDLValue>> values)
                    throws InforException

Throws:

InforException

readUserDefinedListEntries

List<UDLEntry> readUserDefinedListEntries(InforContext context,
                                          UDLEntryId filters)
                                   throws InforException

Throws:

InforException

createUserDefinedListEntry

String createUserDefinedListEntry(InforContext context,
                                  UDLEntry entry)
                           throws InforException

Throws:

InforException

updateUserDefinedListEntry

String updateUserDefinedListEntry(InforContext context,
                                  UDLEntry entry)
                           throws InforException

Throws:

InforException

deleteUserDefinedListEntries

String deleteUserDefinedListEntries(InforContext context,
                                    UDLEntryId filters)
                             throws InforException

Throws:

InforException

readUDLToEntity

void readUDLToEntity(InforContext context,
                     UserDefinedListHelpable entity,
                     EntityId entityId)

This method should be used after you read an entity from Infor. It will set its UDL to the correct one. If we fail to retrieve the UDLs it will silently fail, with a SEVERE log level message, so that if there is no UDL UDS configured, such as in the case of using vanilla Infor, the read will still suceed with all other fields.

Parameters:

context - infor context

entity - the entity that you are reading

entityId - the id of the entity that you are reading

writeUDLToEntityCopyFrom

void writeUDLToEntityCopyFrom(InforContext context,
                              UserDefinedListHelpable entity,
                              EntityId entityId)

This method should be used after you create an entity in Infor. It will insert the UDL in the database. As it is impossible/difficult to rollback the Infor entity creation, this method is always assumed to succeed. If this does not happen, a SEVERE log level message will be logged and no exception will be thrown.

Parameters:

context - infor context

entity - the entity that you are creating

entityId - the id of the entity that you are reading

writeUDLToEntity

void writeUDLToEntity(InforContext context,
                      UserDefinedListHelpable entity,
                      EntityId entityId)

This method should be used after you update an entity in Infor. It will update the UDL in the database. As it is impossible/difficult to rollback the Infor entity update, this method is always assumed to succeed. If this does not happen, a SEVERE log level message will be logged and no exception will be thrown.

Parameters:

context - infor context

entity - the entity that you are updating

entityId - the id of the entity that you are reading

deleteUDLFromEntity

void deleteUDLFromEntity(InforContext context,
                         EntityId entityId)

This method should be used after you delete an entity in Infor. It will clear its UDL in the database. As it is impossible/difficult to rollback the Infor entity deletion, this method is always assumed to succeed. If this does not happen, a SEVERE log level message will be logged and no exception will be thrown.

Parameters:

context - infor context

entityId - the id of the entity that you are reading