Package com.blueriq.component.api.aggregate

Interface AggregateService

public interface AggregateService
Defines high level methods for aggregate manipulation.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    createAggregate(com.aquima.interactions.portal.IPortalContext context, AggregateCreateParams aggregateCreateParams, com.aquima.interactions.metamodel.IAggregateDefinition aggregateDefinition)
    Creates an aggregate based on the information in the profile (accessible via the portal context), the parameters and the aggregate definition
    void
    deleteAggregate(com.aquima.interactions.portal.IPortalContext context, AggregateDeleteParams aggregateDeleteParams)
    Deletes an aggregate based on the parameters provided
    void
    readAggregate(com.aquima.interactions.portal.IPortalContext context, AggregateReadParams aggregateReadParams)
    Reads an existing aggregate and loads it into the profile.
    com.blueriq.customerdata.api.v1.model.AggregateModel
    retrieveAggregate(String aggregateType, long aggregateId)
    Retrieves a specific aggregate
    void
    updateAggregate(com.aquima.interactions.portal.IPortalContext context, AggregateUpdateParams aggregateUpdateParams, com.aquima.interactions.metamodel.IAggregateDefinition aggregateDefinition)
    Updates an existing aggregate based on the information in the profile (accessible via the portal context) and the update parameters.

  • Method Details

    • createAggregate

      long createAggregate(com.aquima.interactions.portal.IPortalContext context, AggregateCreateParams aggregateCreateParams, com.aquima.interactions.metamodel.IAggregateDefinition aggregateDefinition)
      Creates an aggregate based on the information in the profile (accessible via the portal context), the parameters and the aggregate definition
      Parameters:
      context - the portal context
      aggregateCreateParams - parameters for the aggregate creation
      aggregateDefinition - the definition of the aggregate in the model
      Returns:
      the id of the created aggregate

    • readAggregate

      void readAggregate(com.aquima.interactions.portal.IPortalContext context, AggregateReadParams aggregateReadParams)
      Reads an existing aggregate and loads it into the profile.
      Parameters:
      context - the portal context
      aggregateReadParams - the parameters to determine which aggregate to read

    • retrieveAggregate

      com.blueriq.customerdata.api.v1.model.AggregateModel retrieveAggregate(String aggregateType, long aggregateId)
      Retrieves a specific aggregate
      Parameters:
      aggregateType - the type of the aggregate
      aggregateId - the aggreagteId if the specific aggregate
      Returns:
      the specific aggregate

    • updateAggregate

      void updateAggregate(com.aquima.interactions.portal.IPortalContext context, AggregateUpdateParams aggregateUpdateParams, com.aquima.interactions.metamodel.IAggregateDefinition aggregateDefinition)
      Updates an existing aggregate based on the information in the profile (accessible via the portal context) and the update parameters.
      Parameters:
      context - the portal context
      aggregateUpdateParams - parameters for the aggregate update
      aggregateDefinition - the definition of the aggregate in the model

    • deleteAggregate

      void deleteAggregate(com.aquima.interactions.portal.IPortalContext context, AggregateDeleteParams aggregateDeleteParams)
      Deletes an aggregate based on the parameters provided
      Parameters:
      context - the portal context
      aggregateDeleteParams - the parameters containing the information to identify the aggregate to delete