Package lumis.service.analytics.eventsadmin

Class EventFieldSource

  • All Implemented Interfaces:
    java.util.Comparator<ISourceData>
    public class EventFieldSource
extends TableSource
    Event field source, used in the customer experience event administration. Limits access to the fields that belongs to its service instance. Uses MonitorField entity when making modifications.
    Since:
    14.0.0
    Version:
    $Revision$ $Date$

    • Method Detail

      • newEntity

        protected MonitorField newEntity​(java.lang.String id,
                                 IParameters data)
                          throws PortalException
        Returns a new entity calling its constructor with arguments based on the given parameters.
        Parameters:
        id - the identifier.
        data - the parameters given to the add operation.
        Returns:
        the new entity.
        Throws:
        PortalException

      • isUpdatable

        protected boolean isUpdatable​(ITableSourceField field)
        Returns if the field is updatable and given parameters are to be used to set its value in updateEntity(IMonitorElementSPI, IParameters) default implementation.
        Parameters:
        field - the field.
        Returns:
        true if it is updatable, false otherwise.

      • updateEntity

        protected void updateEntity​(MonitorField entity,
                            IParameters parameters)
                     throws PortalException
        Updates an entity with the values set in the given parameters. Only updates entity properties for fields that are updatable.
        Parameters:
        entity - the entity.
        parameters - the parameters.
        Throws:
        PortalException

      • readData

        @Deprecated
public ISourceData readData​(java.lang.String primaryKeyValue,
                            ITransaction transaction)
                     throws PortalException
        Deprecated.
        Description copied from class: TableSource
        Reads the data with the given primary key value, and returns it.
        Overrides:
        readData in class TableSource
        Parameters:
        primaryKeyValue - the primary key value of the desired data.
        transaction - the transaction for persistence access.
        Returns:
        the data with the given primary key value.
        Throws:
        PortalException

      • readData

        @Deprecated
public TabularData readData​(java.lang.String[] primaryKeyValues,
                            ITransaction transaction)
                     throws PortalException
        Deprecated.
        Description copied from class: TableSource
        Reads the data with the given primary key values, and returns it.
        Overrides:
        readData in class TableSource
        Parameters:
        primaryKeyValues - the primary key values of the desired data.
        transaction - the transaction for persistence access.
        Returns:
        the data with the given primary key values.
        Throws:
        PortalException

      • readData

        public java.util.List<ISourceData> readData​(java.util.Collection<java.lang.String> itemIds)
                                     throws PortalException
        Description copied from class: Source
        Returns the data corresponding to the given itemIds.

        The implementation of this method in Source throws an UnsupportedOperationException. This method should be overridden by source implementations that provides this functionality.

        Overrides:
        readData in class TableSource
        Parameters:
        itemIds - the item identifiers of the data to be returned.
        Returns:
        a list of ISourceData objects that corresponds to the given itemIds. If no data is found, an empty list is returned.
        Throws:
        PortalException

      • doDeleteDataByItemIds

        protected void doDeleteDataByItemIds​(java.util.Collection<java.lang.String> itemIds)
                              throws PortalException
        Description copied from class: Source
        Deletes the data in the persistence.

        This method is called by Source.deleteDataByItemIds(Collection) and is to be overridden by sources that supports delete operation and uses the default deleteData implementation.

        The implementation of this method in Source throws UnsupportedOperationException.

        Overrides:
        doDeleteDataByItemIds in class TableSource
        Parameters:
        itemIds - the item identifiers of data to be deleted.
        Throws:
        PortalException

      • throwLocalizableException

        protected void throwLocalizableException​(java.lang.String message,
                                         java.lang.String... args)
                                  throws PortalException
        Throws a portal exception with the given message and the adequate string resource.
        Parameters:
        message - the message
        args - the arguments for the string
        Throws:
        PortalException
        Since:
        14.0.0