Documentation
¶
Index ¶
- type AddressDataService
- func (addressDataService AddressDataService) Create(tenantID, applicationID system.UUID, address contract.Address) (system.UUID, error)
- func (addressDataService AddressDataService) Delete(tenantID, applicationID, addressID system.UUID) error
- func (addressDataService AddressDataService) Read(tenantID, applicationID, addressID system.UUID, keys []string) (contract.Address, error)
- func (addressDataService AddressDataService) ReadAll(tenantID, applicationID, addressID system.UUID) (contract.Address, error)
- func (addressDataService AddressDataService) Update(tenantID, applicationID, addressID system.UUID, address contract.Address) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddressDataService ¶
type AddressDataService struct {
UUIDGeneratorService system.UUIDGeneratorService
ClusterConfig *gocql.ClusterConfig
}
AddressDataService provides access to add new address and update/retrieve/remove an existing address.
func (AddressDataService) Create ¶
func (addressDataService AddressDataService) Create(tenantID, applicationID system.UUID, address contract.Address) (system.UUID, error)
Create creates a new address. tenantID: Mandatory. The unique identifier of the tenant owning the address. applicationID: Mandatory. The unique identifier of the tenant's application will be owning the address. address: Mandatory. The reference to the new address information. Returns either the unique identifier of the new address or error if something goes wrong.
func (AddressDataService) Delete ¶
func (addressDataService AddressDataService) Delete(tenantID, applicationID, addressID system.UUID) error
Delete deletes an existing address information. tenantID: Mandatory. The unique identifier of the tenant owning the address. applicationID: Mandatory. The unique identifier of the tenant's application will be owning the address. addressID: Mandatory. The unique identifier of the existing address to remove. Returns error if something goes wrong.
func (AddressDataService) Read ¶
func (addressDataService AddressDataService) Read(tenantID, applicationID, addressID system.UUID, keys []string) (contract.Address, error)
Read retrieves an existing address information and returns only the detail which the keys provided by the keys. tenantID: Mandatory. The unique identifier of the tenant owning the address. applicationID: Mandatory. The unique identifier of the tenant's application will be owning the address. addressID: Mandatory. The unique identifier of the existing address. keys: Mandatory. The interested address details keys to return. Returns either the address information or error if something goes wrong.
func (AddressDataService) ReadAll ¶
func (addressDataService AddressDataService) ReadAll(tenantID, applicationID, addressID system.UUID) (contract.Address, error)
ReadAll retrieves an existing address information and returns all the detail of it. tenantID: Mandatory. The unique identifier of the tenant owning the address. applicationID: Mandatory. The unique identifier of the tenant's application will be owning the address. addressID: Mandatory. The unique identifier of the existing address. Returns either the address information or error if something goes wrong.
func (AddressDataService) Update ¶
func (addressDataService AddressDataService) Update(tenantID, applicationID, addressID system.UUID, address contract.Address) error
Update updates an existing address. tenantID: Mandatory. The unique identifier of the tenant owning the address. applicationID: Mandatory. The unique identifier of the tenant's application will be owning the address. addressID: Mandatory. The unique identifier of the existing address. address: Mandatory. The reeference to the updated address information. Returns error if something goes wrong.
Source Files