// Copyright Project Harbor Authors
//
// 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.

package retention

import "github.com/goharbor/harbor/src/jobservice/job"

// APIController to handle the requests related with retention
type APIController interface {
	// Handle the related hooks from the job service and launch the corresponding actions if needed
	//
	//  Arguments:
	//    policyID string         : uuid of the retention policy
	//    event *job.StatusChange : event object sent by job service
	//
	//  Returns:
	//    common error object if any errors occurred
	HandleHook(policyID string, event *job.StatusChange) error
}