Documentation
¶
Overview ¶
Package business implements different business services required by the project service
Package business implements different business services required by the project service ¶
Package business implements different business services required by the project service ¶
Package business implements different business services required by the project service ¶
Package business implements different business services required by the project service
Index ¶
- func IsProjectAlreadyExistsError(err error) bool
- func IsProjectNotFoundError(err error) bool
- func IsUnknownError(err error) bool
- func NewProjectAlreadyExistsError() error
- func NewProjectAlreadyExistsErrorWithError(err error) error
- func NewProjectNotFoundError(projectID string) error
- func NewProjectNotFoundErrorWithError(projectID string, err error) error
- func NewUnknownError(message string) error
- func NewUnknownErrorWithError(message string, err error) error
- type BusinessContract
- type CreateProjectRequest
- type CreateProjectResponse
- type DeleteProjectRequest
- type DeleteProjectResponse
- type ProjectAlreadyExistsError
- type ProjectNotFoundError
- type ReadProjectRequest
- type ReadProjectResponse
- type SearchRequest
- type SearchResponse
- type UnknownError
- type UpdateProjectRequest
- type UpdateProjectResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsProjectAlreadyExistsError ¶
IsProjectAlreadyExistsError indicates whether the error is of type ProjectAlreadyExistsError
func IsProjectNotFoundError ¶
IsProjectNotFoundError indicates whether the error is of type ProjectNotFoundError
func IsUnknownError ¶
IsUnknownError indicates whether the error is of type UnknownError
func NewProjectAlreadyExistsError ¶
func NewProjectAlreadyExistsError() error
NewProjectAlreadyExistsError creates a new ProjectAlreadyExistsError error
func NewProjectAlreadyExistsErrorWithError ¶
NewProjectAlreadyExistsErrorWithError creates a new ProjectAlreadyExistsError error
func NewProjectNotFoundError ¶
NewProjectNotFoundError creates a new ProjectNotFoundError error projectID: Mandatory. The projectID that did not match any existing project
func NewProjectNotFoundErrorWithError ¶
NewProjectNotFoundErrorWithError creates a new ProjectNotFoundError error projectID: Mandatory. The projectID that did not match any existing project
func NewUnknownError ¶
NewUnknownError creates a new UnknownError error
func NewUnknownErrorWithError ¶
NewUnknownErrorWithError creates a new UnknownError error
Types ¶
type BusinessContract ¶
type BusinessContract interface {
// CreateProject creates a new project.
// ctx: Mandatory The reference to the context
// request: Mandatory. The request to create a new project
// Returns either the result of creating new project or error if something goes wrong.
CreateProject(
ctx context.Context,
request *CreateProjectRequest) (*CreateProjectResponse, error)
// ReadProject read an existing project
// ctx: Mandatory The reference to the context
// request: Mandatory. The request to read an existing project
// Returns either the result of reading an exiting project or error if something goes wrong.
ReadProject(
ctx context.Context,
request *ReadProjectRequest) (*ReadProjectResponse, error)
// UpdateProject update an existing project
// ctx: Mandatory The reference to the context
// request: Mandatory. The request to update an existing project
// Returns either the result of updateing an exiting project or error if something goes wrong.
UpdateProject(
ctx context.Context,
request *UpdateProjectRequest) (*UpdateProjectResponse, error)
// DeleteProject delete an existing project
// ctx: Mandatory The reference to the context
// request: Mandatory. The request to delete an existing project
// Returns either the result of deleting an exiting project or error if something goes wrong.
DeleteProject(
ctx context.Context,
request *DeleteProjectRequest) (*DeleteProjectResponse, error)
// Search returns the list of projects that matched the criteria
// ctx: Mandatory The reference to the context
// request: Mandatory. The request contains the search criteria
// Returns the list of projects that matched the criteria
Search(
ctx context.Context,
request *SearchRequest) (*SearchResponse, error)
}
BusinessContract declares the service that can create new project, read, update and delete existing projects.
func NewBusinessService ¶
func NewBusinessService( repositoryService repository.RepositoryContract) (BusinessContract, error)
NewBusinessService creates new instance of the BusinessService, setting up all dependencies and returns the instance repositoryService: Mandatory. Reference to the repository service that can persist the project related data Returns the new service or error if something goes wrong
type CreateProjectRequest ¶
CreateProjectRequest contains the request to create a new project
func (CreateProjectRequest) Validate ¶
func (val CreateProjectRequest) Validate() error
Validate validates the CreateProjectRequest model and return error if the validation failes Returns error if validation failes
type CreateProjectResponse ¶
type CreateProjectResponse struct {
Err error
ProjectID string
Project models.Project
Cursor string
}
CreateProjectResponse contains the result of creating a new project
type DeleteProjectRequest ¶
type DeleteProjectRequest struct {
ProjectID string
}
DeleteProjectRequest contains the request to delete an existing project
func (DeleteProjectRequest) Validate ¶
func (val DeleteProjectRequest) Validate() error
Validate validates the DeleteProjectRequest model and return error if the validation failes Returns error if validation failes
type DeleteProjectResponse ¶
type DeleteProjectResponse struct {
Err error
}
DeleteProjectResponse contains the result of deleting an existing project
type ProjectAlreadyExistsError ¶
type ProjectAlreadyExistsError struct {
Err error
}
ProjectAlreadyExistsError indicates that the project with the given information already exists
func (ProjectAlreadyExistsError) Error ¶
func (e ProjectAlreadyExistsError) Error() string
Error returns message for the ProjectAlreadyExistsError error type Returns the error nessage
func (ProjectAlreadyExistsError) Unwrap ¶
func (e ProjectAlreadyExistsError) Unwrap() error
Unwrap returns the err if provided through NewProjectAlreadyExistsErrorWithError function, otherwise returns nil
type ProjectNotFoundError ¶
ProjectNotFoundError indicates that the project with the given projectID does not exist
func (ProjectNotFoundError) Error ¶
func (e ProjectNotFoundError) Error() string
Error returns message for the ProjectNotFoundError error type Returns the error nessage
func (ProjectNotFoundError) Unwrap ¶
func (e ProjectNotFoundError) Unwrap() error
Unwrap returns the err if provided through NewProjectNotFoundErrorWithError function, otherwise returns nil
type ReadProjectRequest ¶
type ReadProjectRequest struct {
ProjectID string
}
ReadProjectRequest contains the request to read an existing project
func (ReadProjectRequest) Validate ¶
func (val ReadProjectRequest) Validate() error
Validate validates the ReadProjectRequest model and return error if the validation failes Returns error if validation failes
type ReadProjectResponse ¶
ReadProjectResponse contains the result of reading an existing project
type SearchRequest ¶
type SearchRequest struct {
Pagination common.Pagination
SortingOptions []common.SortingOptionPair
ProjectIDs []string
}
SearchRequest contains the filter criteria to look for existing projects
func (SearchRequest) Validate ¶
func (val SearchRequest) Validate() error
Validate validates the SearchRequest model and return error if the validation failes Returns error if validation failes
type SearchResponse ¶
type SearchResponse struct {
Err error
HasPreviousPage bool
HasNextPage bool
TotalCount int64
Projects []models.ProjectWithCursor
}
SearchResponse contains the list of the projects that matched the result
type UnknownError ¶
UnknownError indicates that an unknown error has happened
func (UnknownError) Error ¶
func (e UnknownError) Error() string
Error returns message for the UnknownError error type Returns the error nessage
func (UnknownError) Unwrap ¶
func (e UnknownError) Unwrap() error
Unwrap returns the err if provided through NewUnknownErrorWithError function, otherwise returns nil
type UpdateProjectRequest ¶
UpdateProjectRequest contains the request to update an existing project
func (UpdateProjectRequest) Validate ¶
func (val UpdateProjectRequest) Validate() error
Validate validates the UpdateProjectRequest model and return error if the validation failes Returns error if validation failes