Documentation
¶
Overview ¶
******************************************************************************
- Copyright 2018 Dell 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. ******************************************************************************
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DBClient ¶
type DBClient interface {
CloseSession()
// ********************** REGISTRATION FUNCTIONS *****************************
// Return all the registrations
// UnexpectedError - failed to retrieve registrations from the database
Registrations() ([]contract.Registration, error)
// Add a new registration
// UnexpectedError - failed to add to database
AddRegistration(reg contract.Registration) (string, error)
// Update a registration
// UnexpectedError - problem updating in database
// NotFound - no registration with the ID was found
UpdateRegistration(reg contract.Registration) error
// Get a registration by ID
// UnexpectedError - problem getting in database
// NotFound - no registration with the ID was found
RegistrationById(id string) (contract.Registration, error)
// Get a registration by name
// UnexpectedError - problem getting in database
// NotFound - no registration with the name was found
RegistrationByName(name string) (contract.Registration, error)
// Delete a registration by ID
// UnexpectedError - problem getting in database
// NotFound - no registration with the ID was found
DeleteRegistrationById(id string) error
// Delete a registration by name
// UnexpectedError - problem getting in database
// NotFound - no registration with the ID was found
DeleteRegistrationByName(name string) error
// Delete all registrations
ScrubAllRegistrations() error
}
Directories
¶
| Path | Synopsis |
|---|---|
|
****************************************************************************** * Copyright 2018 Dell Inc.
|
****************************************************************************** * Copyright 2018 Dell Inc. |
|
****************************************************************************** * Copyright 2018 Dell Inc.
|
****************************************************************************** * Copyright 2018 Dell Inc. |
Click to show internal directories.
Click to hide internal directories.