R/ddd-abc.R

In tidylab/ddd: Build Applications that Match their Business Domain

#nocov start
# -------------------------------------------------------------------------
#' @title Abstract Entity Class
#' @description
#' This class provides the infrastructure for defining abstract base classes of
#' core domain objects.
#' @family abstract base classes
#' @export
AbstractEntity <- R6::R6Class("Entity", cloneable = FALSE, public = list(
    #' @field uid Entity unique identifier.
    uid = character(0),
    #' @description Instantiate an Entity object.
    #' @param uid (`character`) Entity unique identifier.
    initialize = function(uid){
        self$uid <- uid
    }
))

# -------------------------------------------------------------------------
#' @title Abstract Domain Service
#' @description Use \code{Unit of Work} as a context manager.
#' @family abstract base classes
#' @export
AbstractDomainService <- R6::R6Class("DomainService", cloneable = FALSE, public = list(
    #' @description Instantiate a domain service
    initialize = function(){},
    #' @description Tear down a domain service
    finalize = function(){}
))

# -------------------------------------------------------------------------
#nocov end