energylink/pkg/models/folders.go

package models

import (
	"errors"
	"time"
)

// Typed errors
var (
	ErrFolderNotFound                = errors.New("Folder not found")
	ErrFolderVersionMismatch         = errors.New("The folder has been changed by someone else")
	ErrFolderTitleEmpty              = errors.New("Folder title cannot be empty")
	ErrFolderWithSameUIDExists       = errors.New("A folder with the same uid already exists")
	ErrFolderFailedGenerateUniqueUid = errors.New("Failed to generate unique folder id")
)

type Folder struct {
	Id      int64
	Title   string
	Slug    string
	OrgId   int64
	Version int

	Created time.Time
	Updated time.Time

	UpdatedBy int64
	CreatedBy int64
	HasAcl    bool
}

//
// COMMANDS
//

type CreateFolderCommand struct {
	OrgId  int64  `json:"-"`
	UserId int64  `json:"userId"`
	Title  string `json:"title"`

	Result *Folder
}

type UpdateFolderCommand struct {
	OrgId   int64  `json:"-"`
	UserId  int64  `json:"userId"`
	Title   string `json:"title"`
	Version int    `json:"version"`

	Result *Folder
}

//
// QUERIES
//

type DashboardFolder struct {
	Id    int64  `json:"id"`
	Title string `json:"title"`
}

type GetFoldersForSignedInUserQuery struct {
	OrgId        int64
	SignedInUser *SignedInUser
	Title        string
	Result       []*DashboardFolder
}