github.com/erda-project/erda-infra@v1.0.9/providers/component-protocol/components/kanban/interface.go (about)

     1  // Copyright (c) 2021 Terminus, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package kanban
    16  
    17  import (
    18  	"github.com/erda-project/erda-infra/providers/component-protocol/cptype"
    19  )
    20  
    21  // IKanban is user-level interface for kanban.
    22  type IKanban interface {
    23  	cptype.IComponent
    24  	IKanbanStdOps
    25  }
    26  
    27  // IKanbanStdOps defines all standard operations of kanban.
    28  type IKanbanStdOps interface {
    29  	// kanban-level
    30  	// RegisterBoardCreateOp will refresh all boards.
    31  	RegisterBoardCreateOp(opData OpBoardCreate) (opFunc cptype.OperationFunc)
    32  	// board-level
    33  	// RegisterBoardLoadMoreOp only return specific board data, not all boards data.
    34  	RegisterBoardLoadMoreOp(opData OpBoardLoadMore) (opFunc cptype.OperationFunc)
    35  	// RegisterBoardUpdateOp will refresh all boards.
    36  	RegisterBoardUpdateOp(opData OpBoardUpdate) (opFunc cptype.OperationFunc)
    37  	// RegisterBoardDeleteOp will refresh all boards.
    38  	RegisterBoardDeleteOp(opData OpBoardDelete) (opFunc cptype.OperationFunc)
    39  	// card-level
    40  	RegisterCardMoveToOp(opData OpCardMoveTo) (opFunc cptype.OperationFunc)
    41  }