github.com/cs3org/reva/v2@v2.27.7/pkg/mentix/entity/entity.go (about)

     1  // Copyright 2018-2021 CERN
     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  // In applying this license, CERN does not waive the privileges and immunities
    16  // granted to it by virtue of its status as an Intergovernmental Organization
    17  // or submit itself to any jurisdiction.
    18  
    19  package entity
    20  
    21  import (
    22  	"github.com/cs3org/reva/v2/pkg/mentix/config"
    23  
    24  	"github.com/rs/zerolog"
    25  )
    26  
    27  // Entity is the base interface for all Mentix entities.
    28  type Entity interface {
    29  	// GetID returns the ID of the entity.
    30  	GetID() string
    31  	// GetName returns the display name of the entity.
    32  	GetName() string
    33  
    34  	// Activate activates the entity.
    35  	Activate(conf *config.Configuration, log *zerolog.Logger) error
    36  }