API Docs for:
Show:

RootInterface Class

Defined in: /home/ubuntu/base-domain/src/interface/root-interface.coffee:3
Module: base-domain

interface of Aggregate Root

Followings are the meanings of argument name of files in detail. Let's see difference with two file examples.

  • A: core/post-submission-service

  • B: server/diary-factory

  • firstName: A => post-submission, B => diary

  • fullName: A => post-submission-service, B => diary-factory
  • modFirstName: A => core/post-submission | post-submission, B => server/diary
  • modFullName: A => core/post-submission-service, | post-submission-service, B => server/diary-factory

"mod" requires module name except "core" module, which can be omitted

Methods

createFactory

(
  • modFirstName
)
BaseFactory

Defined in /home/ubuntu/base-domain/src/interface/root-interface.coffee:37

create a factory instance 2nd, 3rd, 4th ... arguments are the params to pass to the constructor of the factory

Parameters:

  • modFirstName String

Returns:

BaseFactory:

createModel

(
  • modFirstName
  • obj
  • [options]
)
BaseModel

Defined in /home/ubuntu/base-domain/src/interface/root-interface.coffee:71

create an instance of the given modFirstName using obj if obj is null or undefined, empty object will be created.

Parameters:

  • modFirstName String
  • obj Object
  • [options] Object optional

Returns:

BaseModel:

createPreferredFactory

(
  • firstName
  • [options]
)
BaseFactory

Defined in /home/ubuntu/base-domain/src/interface/root-interface.coffee:93

create a preferred factory instance 3rd, 4th ... arguments are the params to pass to the constructor of the factory

Parameters:

  • firstName String
  • [options] Object optional
    • [noParent=true] Object optional

      if true, stop requiring parent class

Returns:

BaseFactory:

createPreferredRepository

(
  • firstName
  • [options]
)
BaseRepository

Defined in /home/ubuntu/base-domain/src/interface/root-interface.coffee:82

create a preferred repository instance 3rd, 4th ... arguments are the params to pass to the constructor of the repository

Parameters:

  • firstName String
  • [options] Object optional
    • [noParent] Object optional

      if true, stop requiring parent class

Returns:

BaseRepository:

createPreferredService

(
  • firstName
  • [options]
)
BaseService

Defined in /home/ubuntu/base-domain/src/interface/root-interface.coffee:104

create a preferred service instance 3rd, 4th ... arguments are the params to pass to the constructor of the factory

Parameters:

  • firstName String
  • [options] Object optional
    • [noParent=true] Object optional

      if true, stop requiring parent class

Returns:

BaseService:

createRepository

(
  • modFirstName
)
BaseRepository

Defined in /home/ubuntu/base-domain/src/interface/root-interface.coffee:46

create a repository instance 2nd, 3rd, 4th ... arguments are the params to pass to the constructor of the repository

Parameters:

  • modFirstName String

Returns:

BaseRepository:

createService

(
  • name
)
BaseRepository

Defined in /home/ubuntu/base-domain/src/interface/root-interface.coffee:55

create a service instance 2nd, 3rd, 4th ... arguments are the params to pass to the constructor of the service

Parameters:

  • name String

Returns:

BaseRepository:

getModule

() BaseModule

Defined in /home/ubuntu/base-domain/src/interface/root-interface.coffee:64

get module the class belongs to

Returns:

BaseModule:

Properties

isRoot

Boolean static

Defined in /home/ubuntu/base-domain/src/interface/root-interface.coffee:26

is root (to identify RootInterface)