// 2020 Rackspace, Inc.
//
// 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 ecm

import "github.rackspace.com/DCM/tools"

// Example type represents client references to third-party resources required
// for the methods within this package.
type Example struct {
	/*
		 Within this structure will be any type of data needed to pass between methods within
		this interface implementation. This should hold clients as well as context data.
	*/
}

// exampleECM [nameECM] function should exist in every implementation of the Updater interface. This function
// will initialize all the required data in the implementations structure.
//func exampleECM(key *passkey.Client) (*Example, error) {
/*
	Within this function you would take any initialization of clients that are needed to initialize any
	data types that are attached to the returning structure.
*/
//return new(Example), nil
//}

// Update method takes a Recorded device and performs the logic on how, what and where we should update
// the environment management system.
func (c *Example) Update(m tools.Device, modify bool) []error {
	/*
		This is where we would perform update logic. In this function we will do any API calls and
		determination that we'll need on where to place this modeled device into the system.
	*/
	return nil
}