datamapper

Documentation

Index

• func SetLinkTableMapper(mapper IDataMapper)
• func SetMockOwnershipMapper(mapper IDataMapper)
• func SetOrgPartition(mapper IDataMapper)
• func SetOrganizationMapper(mapper IDataMapper)
• func SetSharedGlobalMapper(mapper IDataMapper)
• type DataMapper
  • func (mapper *DataMapper) Create(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)
  • func (mapper *DataMapper) DeleteMany(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)
  • func (mapper *DataMapper) DeleteOne(db *gorm.DB, id *datatype.UUID, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)
  • func (mapper *DataMapper) Patch(db *gorm.DB, jsonIDPatches []mdlutil.JSONIDPatch, ep *hook.EndPoint, ...) (*MapperRet, *webrender.RetError)
  • func (mapper *DataMapper) ReadMany(db *gorm.DB, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, []userrole.UserRole, *int, *webrender.RetError)
  • func (mapper *DataMapper) ReadOne(db *gorm.DB, id *datatype.UUID, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, userrole.UserRole, *webrender.RetError)
  • func (mapper *DataMapper) Update(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)
• type IDataMapper
  • func SharedGlobalMapper() IDataMapper
  • func SharedLinkTableMapper() IDataMapper
  • func SharedOrgPartition() IDataMapper
  • func SharedOrganizationMapper() IDataMapper
  • func SharedOwnershipMapper() IDataMapper
• type MapperRet
• type OrgPartition
  • func (mapper *OrgPartition) Create(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)
  • func (mapper *OrgPartition) DeleteMany(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)
  • func (mapper *OrgPartition) DeleteOne(db *gorm.DB, id *datatype.UUID, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)
  • func (mapper *OrgPartition) Patch(db *gorm.DB, jsonIDPatches []mdlutil.JSONIDPatch, ep *hook.EndPoint, ...) (*MapperRet, *webrender.RetError)
  • func (mapper *OrgPartition) ReadMany(db *gorm.DB, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, []userrole.UserRole, *int, *webrender.RetError)
  • func (mapper *OrgPartition) ReadOne(db *gorm.DB, id *datatype.UUID, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, userrole.UserRole, *webrender.RetError)
  • func (mapper *OrgPartition) Update(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)
• type UserMapper
  • func SharedUserMapper() *UserMapper
  • func (mapper *UserMapper) Create(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)
  • func (mapper *UserMapper) CreateMany(db *gorm.DB, modelObj []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)
  • func (mapper *UserMapper) DeleteMany(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)
  • func (mapper *UserMapper) DeleteOne(db *gorm.DB, id *datatype.UUID, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)
  • func (mapper *UserMapper) Patch(db *gorm.DB, jsonIDPatches []mdlutil.JSONIDPatch, ep *hook.EndPoint, ...) (*MapperRet, *webrender.RetError)
  • func (mapper *UserMapper) PatchMany(db *gorm.DB, jsonIDPatches []mdlutil.JSONIDPatch, ep *hook.EndPoint, ...) (*MapperRet, *webrender.RetError)
  • func (mapper *UserMapper) ReadMany(db *gorm.DB, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, []userrole.UserRole, *int, *webrender.RetError)
  • func (mapper *UserMapper) ReadOne(db *gorm.DB, id *datatype.UUID, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, userrole.UserRole, *webrender.RetError)
  • func (mapper *UserMapper) Update(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)
  • func (mapper *UserMapper) UpdateMany(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

Functions

func SetLinkTableMapper

func SetLinkTableMapper(mapper IDataMapper)

SetLinkTableMapper allows one to mock LinkTableMapper for testing

func SetMockOwnershipMapper

func SetMockOwnershipMapper(mapper IDataMapper)

SetMockOwnershipMapper allows one to mock OrganizationMapper for testing

func SetOrgPartition

func SetOrgPartition(mapper IDataMapper)

SetOrganizationMapper allows one to mock OrganizationMapper for testing

func SetOrganizationMapper

func SetOrganizationMapper(mapper IDataMapper)

SetOrganizationMapper allows one to mock OrganizationMapper for testing

func SetSharedGlobalMapper

func SetSharedGlobalMapper(mapper IDataMapper)

SetSharedGlobalMapper allows one to mock SharedGlobalMapper for testing

Types

type DataMapper

type DataMapper struct {
	Service    service.IService
	MapperType mappertype.MapperType
}

DataMapper is a basic CRUD manager

func (*DataMapper) Create

func (mapper *DataMapper) Create(db *gorm.DB, modelObjs []mdl.IModel,
	ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

CreateMany creates an instance of this model based on json and store it in db

func (*DataMapper) DeleteMany

func (mapper *DataMapper) DeleteMany(db *gorm.DB, modelObjs []mdl.IModel,
	ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

DeleteMany deletes multiple mdl

func (*DataMapper) DeleteOne

func (mapper *DataMapper) DeleteOne(db *gorm.DB, id *datatype.UUID, ep *hook.EndPoint,
	cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

DeleteOne delete the model TODO: delete the groups associated with this record?

func (*DataMapper) Patch

func (mapper *DataMapper) Patch(db *gorm.DB, jsonIDPatches []mdlutil.JSONIDPatch, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

func (*DataMapper) ReadMany

func (mapper *DataMapper) ReadMany(db *gorm.DB, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, []userrole.UserRole, *int, *webrender.RetError)

func (*DataMapper) ReadOne

func (mapper *DataMapper) ReadOne(db *gorm.DB, id *datatype.UUID, ep *hook.EndPoint,
	cargo *hook.Cargo) (*MapperRet, userrole.UserRole, *webrender.RetError)

ReadOne get one model object based on its type and its id string

func (*DataMapper) Update

func (mapper *DataMapper) Update(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

type IDataMapper

type IDataMapper interface {
	ReadMany(db *gorm.DB, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, []userrole.UserRole, *int, *webrender.RetError)

	ReadOne(db *gorm.DB, id *datatype.UUID, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, userrole.UserRole, *webrender.RetError)

	DeleteMany(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

	DeleteOne(db *gorm.DB, id *datatype.UUID, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

	// The new one, since endpoints other than read and delete are not necessary to differentiate between two endpoints
	Create(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

	Update(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

	Patch(db *gorm.DB, jsonIDPatches []mdlutil.JSONIDPatch, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)
}

IDataMapper has all the crud interfaces

func SharedGlobalMapper

func SharedGlobalMapper() IDataMapper

SharedGlobalMapper creats a singleton of Crud object

func SharedLinkTableMapper

func SharedLinkTableMapper() IDataMapper

SharedLinkTableMapper creats a singleton of Crud object

func SharedOrgPartition

func SharedOrgPartition() IDataMapper

SharedOrgPartition creats a singleton of Crud object

func SharedOrganizationMapper

func SharedOrganizationMapper() IDataMapper

SharedOrganizationMapper creats a singleton of Crud object

func SharedOwnershipMapper

func SharedOwnershipMapper() IDataMapper

SharedOwnershipMapper creats a singleton of Crud object

type MapperRet

type MapperRet struct {
	Ms      []mdl.IModel // if for cardinality 1, only contains one element
	Roles   []userrole.UserRole
	Fetcher *hfetcher.HandlerFetcher
}

type OrgPartition

type OrgPartition struct {
	Service    service.IService
	MapperType mappertype.MapperType
}

func (*OrgPartition) Create

func (mapper *OrgPartition) Create(db *gorm.DB, modelObjs []mdl.IModel,
	ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

CreateMany creates an instance of this model based on json and store it in db

func (*OrgPartition) DeleteMany

func (mapper *OrgPartition) DeleteMany(db *gorm.DB, modelObjs []mdl.IModel,
	ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

DeleteMany deletes multiple mdl

func (*OrgPartition) DeleteOne

func (mapper *OrgPartition) DeleteOne(db *gorm.DB, id *datatype.UUID, ep *hook.EndPoint,
	cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

DeleteOne delete the model TODO: delete the groups associated with this record?

func (*OrgPartition) Patch

func (mapper *OrgPartition) Patch(db *gorm.DB, jsonIDPatches []mdlutil.JSONIDPatch,
	ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

PatchMany patches multiple mdl

func (*OrgPartition) ReadMany

func (mapper *OrgPartition) ReadMany(db *gorm.DB, ep *hook.EndPoint,
	cargo *hook.Cargo) (*MapperRet, []userrole.UserRole, *int, *webrender.RetError)

func (*OrgPartition) ReadOne

func (mapper *OrgPartition) ReadOne(db *gorm.DB, id *datatype.UUID, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, userrole.UserRole, *webrender.RetError)

ReadOne get one model object based on its type and its id string

func (*OrgPartition) Update

func (mapper *OrgPartition) Update(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

type UserMapper

type UserMapper struct {
	Service    service.IService
	MapperType mappertype.MapperType
}

UserMapper is a User CRUD manager

func SharedUserMapper

func SharedUserMapper() *UserMapper

SharedUserMapper creats a singleton of Crud object

func (*UserMapper) Create

func (mapper *UserMapper) Create(db *gorm.DB, modelObjs []mdl.IModel,
	ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

CreateOne creates an user model based on json and store it in db Also creates a ownership with admin access

func (*UserMapper) CreateMany

func (mapper *UserMapper) CreateMany(db *gorm.DB,
	modelObj []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

CreateMany :-

func (*UserMapper) DeleteMany

func (mapper *UserMapper) DeleteMany(db *gorm.DB,
	modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

DeleteMany :-

func (*UserMapper) DeleteOne

func (mapper *UserMapper) DeleteOne(db *gorm.DB, id *datatype.UUID,
	ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

DeleteOne deletes the user with the ID

func (*UserMapper) Patch

func (mapper *UserMapper) Patch(db *gorm.DB, jsonIDPatches []mdlutil.JSONIDPatch, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

PatchOne updates model based on this json

func (*UserMapper) PatchMany

func (mapper *UserMapper) PatchMany(db *gorm.DB,
	jsonIDPatches []mdlutil.JSONIDPatch, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

PatchMany :-

func (*UserMapper) ReadMany

func (mapper *UserMapper) ReadMany(db *gorm.DB, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, []userrole.UserRole, *int, *webrender.RetError)

ReadMany :-

func (*UserMapper) ReadOne

func (mapper *UserMapper) ReadOne(db *gorm.DB, id *datatype.UUID, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, userrole.UserRole, *webrender.RetError)

ReadOne get one model object based on its type and its id string

func (*UserMapper) Update

func (mapper *UserMapper) Update(db *gorm.DB, modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

func (*UserMapper) UpdateMany

func (mapper *UserMapper) UpdateMany(db *gorm.DB,
	modelObjs []mdl.IModel, ep *hook.EndPoint, cargo *hook.Cargo) (*MapperRet, *webrender.RetError)

UpdateMany :-