errors.go

/*
 *  Copyright (c) 2017-2018 Samsung Electronics Co., Ltd All Rights Reserved
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License
 */

// File errors.go provides definitions of errors common to Weles components.

package weles

import (
	"errors"
	"fmt"
)

var (
	// ErrNotImplemented is returned when function is not implemented yet.
	ErrNotImplemented = errors.New("function not implemented")
	// ErrJobNotFound is returned when Job is not found.
	ErrJobNotFound = errors.New("job not found")
	// ErrJobStatusChangeNotAllowed is returned when Job status change is not
	// possible. It suggests internal Weles logic error.
	ErrJobStatusChangeNotAllowed = errors.New("job status change not allowed")
	// ErrBeforeAfterNotAllowed is returned when client places request for a list
	// with both before and after parameters.
	ErrBeforeAfterNotAllowed = errors.New(
		"setting both before and after qeury parameters is not allowed")
	// ErrArtifactNotFound is returned by API when no artifact is returned by ArtifactManager
	ErrArtifactNotFound = errors.New("artifact not found")
)

// ErrInvalidArgument is returned when argument passed to public API cannot
// be parsed.
type ErrInvalidArgument string

func (err ErrInvalidArgument) Error() string {
	return fmt.Sprintf("invalid argument: %s", string(err))
}