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

Interface UserDefinedListService

All Known Implementing Classes:
UserDefinedListServiceImpl
public interface UserDefinedListService

  • Method Details

    • readUserDefinedLists

      Map<String,ArrayList<UDLValue>> readUserDefinedLists(EAMContext context, UDLEntryId entryId) throws EAMException
      Throws:
      EAMException

    • setUserDefinedLists

      String setUserDefinedLists(EAMContext context, EntityId entityId, Map<String,ArrayList<UDLValue>> values) throws EAMException
      Throws:
      EAMException

    • readUserDefinedListEntries

      List<UDLEntry> readUserDefinedListEntries(EAMContext context, UDLEntryId filters) throws EAMException
      Throws:
      EAMException

    • createUserDefinedListEntry

      String createUserDefinedListEntry(EAMContext context, UDLEntry entry) throws EAMException
      Throws:
      EAMException

    • updateUserDefinedListEntry

      String updateUserDefinedListEntry(EAMContext context, UDLEntry entry) throws EAMException
      Throws:
      EAMException

    • deleteUserDefinedListEntries

      String deleteUserDefinedListEntries(EAMContext context, UDLEntryId filters) throws EAMException
      Throws:
      EAMException

    • readUDLToEntity

      void readUDLToEntity(EAMContext context, UserDefinedListHelpable entity, EntityId entityId)
      This method should be used after you read an entity from EAM. 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 EAM, the read will still suceed with all other fields.
      Parameters:
      context - eam context
      entity - the entity that you are reading
      entityId - the id of the entity that you are reading

    • writeUDLToEntityCopyFrom

      void writeUDLToEntityCopyFrom(EAMContext context, UserDefinedListHelpable entity, EntityId entityId)
      This method should be used after you create an entity in EAM. It will insert the UDL in the database. As it is impossible/difficult to rollback the EAM 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 - eam context
      entity - the entity that you are creating
      entityId - the id of the entity that you are reading

    • writeUDLToEntity

      void writeUDLToEntity(EAMContext context, UserDefinedListHelpable entity, EntityId entityId)
      This method should be used after you update an entity in EAM. It will update the UDL in the database. As it is impossible/difficult to rollback the EAM 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 - eam context
      entity - the entity that you are updating
      entityId - the id of the entity that you are reading

    • deleteUDLFromEntity

      void deleteUDLFromEntity(EAMContext context, EntityId entityId)
      This method should be used after you delete an entity in EAM. It will clear its UDL in the database. As it is impossible/difficult to rollback the EAM 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 - eam context
      entityId - the id of the entity that you are reading