subscription_type.go

/*
Copyright (c) 2020 Red Hat, 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.
*/

// IMPORTANT: This file has been generated automatically, refrain from modifying it manually as all
// your changes will be lost when the file is generated again.

package v1 // github.com/openshift-online/ocm-sdk-go/accountsmgmt/v1

import (
	time "time"
)

// SubscriptionKind is the name of the type used to represent objects
// of type 'subscription'.
const SubscriptionKind = "Subscription"

// SubscriptionLinkKind is the name of the type used to represent links
// to objects of type 'subscription'.
const SubscriptionLinkKind = "SubscriptionLink"

// SubscriptionNilKind is the name of the type used to nil references
// to objects of type 'subscription'.
const SubscriptionNilKind = "SubscriptionNil"

// Subscription represents the values of the 'subscription' type.
//
//
type Subscription struct {
	bitmap_                   uint64
	id                        string
	href                      string
	billingMarketplaceAccount string
	capabilities              []*Capability
	cloudAccountID            string
	cloudProviderID           string
	clusterID                 string
	clusterBillingModel       BillingModel
	consoleURL                string
	consumerUUID              string
	cpuTotal                  int
	createdAt                 time.Time
	creator                   *Account
	displayName               string
	externalClusterID         string
	labels                    []*Label
	lastReconcileDate         time.Time
	lastReleasedAt            time.Time
	lastTelemetryDate         time.Time
	metrics                   []*SubscriptionMetrics
	notificationContacts      []*Account
	organizationID            string
	plan                      *Plan
	productBundle             string
	provenance                string
	regionID                  string
	serviceLevel              string
	socketTotal               int
	status                    string
	supportLevel              string
	systemUnits               string
	trialEndDate              time.Time
	updatedAt                 time.Time
	usage                     string
	managed                   bool
	released                  bool
}

// Kind returns the name of the type of the object.
func (o *Subscription) Kind() string {
	if o == nil {
		return SubscriptionNilKind
	}
	if o.bitmap_&1 != 0 {
		return SubscriptionLinkKind
	}
	return SubscriptionKind
}

// Link returns true iif this is a link.
func (o *Subscription) Link() bool {
	return o != nil && o.bitmap_&1 != 0
}

// ID returns the identifier of the object.
func (o *Subscription) ID() string {
	if o != nil && o.bitmap_&2 != 0 {
		return o.id
	}
	return ""
}

// GetID returns the identifier of the object and a flag indicating if the
// identifier has a value.
func (o *Subscription) GetID() (value string, ok bool) {
	ok = o != nil && o.bitmap_&2 != 0
	if ok {
		value = o.id
	}
	return
}

// HREF returns the link to the object.
func (o *Subscription) HREF() string {
	if o != nil && o.bitmap_&4 != 0 {
		return o.href
	}
	return ""
}

// GetHREF returns the link of the object and a flag indicating if the
// link has a value.
func (o *Subscription) GetHREF() (value string, ok bool) {
	ok = o != nil && o.bitmap_&4 != 0
	if ok {
		value = o.href
	}
	return
}

// Empty returns true if the object is empty, i.e. no attribute has a value.
func (o *Subscription) Empty() bool {
	return o == nil || o.bitmap_&^1 == 0
}

// BillingMarketplaceAccount returns the value of the 'billing_marketplace_account' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) BillingMarketplaceAccount() string {
	if o != nil && o.bitmap_&8 != 0 {
		return o.billingMarketplaceAccount
	}
	return ""
}

// GetBillingMarketplaceAccount returns the value of the 'billing_marketplace_account' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetBillingMarketplaceAccount() (value string, ok bool) {
	ok = o != nil && o.bitmap_&8 != 0
	if ok {
		value = o.billingMarketplaceAccount
	}
	return
}

// Capabilities returns the value of the 'capabilities' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) Capabilities() []*Capability {
	if o != nil && o.bitmap_&16 != 0 {
		return o.capabilities
	}
	return nil
}

// GetCapabilities returns the value of the 'capabilities' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetCapabilities() (value []*Capability, ok bool) {
	ok = o != nil && o.bitmap_&16 != 0
	if ok {
		value = o.capabilities
	}
	return
}

// CloudAccountID returns the value of the 'cloud_account_ID' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) CloudAccountID() string {
	if o != nil && o.bitmap_&32 != 0 {
		return o.cloudAccountID
	}
	return ""
}

// GetCloudAccountID returns the value of the 'cloud_account_ID' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetCloudAccountID() (value string, ok bool) {
	ok = o != nil && o.bitmap_&32 != 0
	if ok {
		value = o.cloudAccountID
	}
	return
}

// CloudProviderID returns the value of the 'cloud_provider_ID' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) CloudProviderID() string {
	if o != nil && o.bitmap_&64 != 0 {
		return o.cloudProviderID
	}
	return ""
}

// GetCloudProviderID returns the value of the 'cloud_provider_ID' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetCloudProviderID() (value string, ok bool) {
	ok = o != nil && o.bitmap_&64 != 0
	if ok {
		value = o.cloudProviderID
	}
	return
}

// ClusterID returns the value of the 'cluster_ID' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) ClusterID() string {
	if o != nil && o.bitmap_&128 != 0 {
		return o.clusterID
	}
	return ""
}

// GetClusterID returns the value of the 'cluster_ID' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetClusterID() (value string, ok bool) {
	ok = o != nil && o.bitmap_&128 != 0
	if ok {
		value = o.clusterID
	}
	return
}

// ClusterBillingModel returns the value of the 'cluster_billing_model' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) ClusterBillingModel() BillingModel {
	if o != nil && o.bitmap_&256 != 0 {
		return o.clusterBillingModel
	}
	return BillingModel("")
}

// GetClusterBillingModel returns the value of the 'cluster_billing_model' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetClusterBillingModel() (value BillingModel, ok bool) {
	ok = o != nil && o.bitmap_&256 != 0
	if ok {
		value = o.clusterBillingModel
	}
	return
}

// ConsoleURL returns the value of the 'console_URL' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) ConsoleURL() string {
	if o != nil && o.bitmap_&512 != 0 {
		return o.consoleURL
	}
	return ""
}

// GetConsoleURL returns the value of the 'console_URL' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetConsoleURL() (value string, ok bool) {
	ok = o != nil && o.bitmap_&512 != 0
	if ok {
		value = o.consoleURL
	}
	return
}

// ConsumerUUID returns the value of the 'consumer_UUID' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) ConsumerUUID() string {
	if o != nil && o.bitmap_&1024 != 0 {
		return o.consumerUUID
	}
	return ""
}

// GetConsumerUUID returns the value of the 'consumer_UUID' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetConsumerUUID() (value string, ok bool) {
	ok = o != nil && o.bitmap_&1024 != 0
	if ok {
		value = o.consumerUUID
	}
	return
}

// CpuTotal returns the value of the 'cpu_total' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) CpuTotal() int {
	if o != nil && o.bitmap_&2048 != 0 {
		return o.cpuTotal
	}
	return 0
}

// GetCpuTotal returns the value of the 'cpu_total' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetCpuTotal() (value int, ok bool) {
	ok = o != nil && o.bitmap_&2048 != 0
	if ok {
		value = o.cpuTotal
	}
	return
}

// CreatedAt returns the value of the 'created_at' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) CreatedAt() time.Time {
	if o != nil && o.bitmap_&4096 != 0 {
		return o.createdAt
	}
	return time.Time{}
}

// GetCreatedAt returns the value of the 'created_at' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetCreatedAt() (value time.Time, ok bool) {
	ok = o != nil && o.bitmap_&4096 != 0
	if ok {
		value = o.createdAt
	}
	return
}

// Creator returns the value of the 'creator' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
// Link to the account that created the subscription.
func (o *Subscription) Creator() *Account {
	if o != nil && o.bitmap_&8192 != 0 {
		return o.creator
	}
	return nil
}

// GetCreator returns the value of the 'creator' attribute and
// a flag indicating if the attribute has a value.
//
// Link to the account that created the subscription.
func (o *Subscription) GetCreator() (value *Account, ok bool) {
	ok = o != nil && o.bitmap_&8192 != 0
	if ok {
		value = o.creator
	}
	return
}

// DisplayName returns the value of the 'display_name' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) DisplayName() string {
	if o != nil && o.bitmap_&16384 != 0 {
		return o.displayName
	}
	return ""
}

// GetDisplayName returns the value of the 'display_name' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetDisplayName() (value string, ok bool) {
	ok = o != nil && o.bitmap_&16384 != 0
	if ok {
		value = o.displayName
	}
	return
}

// ExternalClusterID returns the value of the 'external_cluster_ID' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) ExternalClusterID() string {
	if o != nil && o.bitmap_&32768 != 0 {
		return o.externalClusterID
	}
	return ""
}

// GetExternalClusterID returns the value of the 'external_cluster_ID' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetExternalClusterID() (value string, ok bool) {
	ok = o != nil && o.bitmap_&32768 != 0
	if ok {
		value = o.externalClusterID
	}
	return
}

// Labels returns the value of the 'labels' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) Labels() []*Label {
	if o != nil && o.bitmap_&65536 != 0 {
		return o.labels
	}
	return nil
}

// GetLabels returns the value of the 'labels' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetLabels() (value []*Label, ok bool) {
	ok = o != nil && o.bitmap_&65536 != 0
	if ok {
		value = o.labels
	}
	return
}

// LastReconcileDate returns the value of the 'last_reconcile_date' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
// Last time this subscription were reconciled about cluster usage.
func (o *Subscription) LastReconcileDate() time.Time {
	if o != nil && o.bitmap_&131072 != 0 {
		return o.lastReconcileDate
	}
	return time.Time{}
}

// GetLastReconcileDate returns the value of the 'last_reconcile_date' attribute and
// a flag indicating if the attribute has a value.
//
// Last time this subscription were reconciled about cluster usage.
func (o *Subscription) GetLastReconcileDate() (value time.Time, ok bool) {
	ok = o != nil && o.bitmap_&131072 != 0
	if ok {
		value = o.lastReconcileDate
	}
	return
}

// LastReleasedAt returns the value of the 'last_released_at' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
// Last time status was set to Released for this cluster/subscription.
func (o *Subscription) LastReleasedAt() time.Time {
	if o != nil && o.bitmap_&262144 != 0 {
		return o.lastReleasedAt
	}
	return time.Time{}
}

// GetLastReleasedAt returns the value of the 'last_released_at' attribute and
// a flag indicating if the attribute has a value.
//
// Last time status was set to Released for this cluster/subscription.
func (o *Subscription) GetLastReleasedAt() (value time.Time, ok bool) {
	ok = o != nil && o.bitmap_&262144 != 0
	if ok {
		value = o.lastReleasedAt
	}
	return
}

// LastTelemetryDate returns the value of the 'last_telemetry_date' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
// Last telemetry authorization request for this  cluster/subscription in Unix time
func (o *Subscription) LastTelemetryDate() time.Time {
	if o != nil && o.bitmap_&524288 != 0 {
		return o.lastTelemetryDate
	}
	return time.Time{}
}

// GetLastTelemetryDate returns the value of the 'last_telemetry_date' attribute and
// a flag indicating if the attribute has a value.
//
// Last telemetry authorization request for this  cluster/subscription in Unix time
func (o *Subscription) GetLastTelemetryDate() (value time.Time, ok bool) {
	ok = o != nil && o.bitmap_&524288 != 0
	if ok {
		value = o.lastTelemetryDate
	}
	return
}

// Managed returns the value of the 'managed' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) Managed() bool {
	if o != nil && o.bitmap_&1048576 != 0 {
		return o.managed
	}
	return false
}

// GetManaged returns the value of the 'managed' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetManaged() (value bool, ok bool) {
	ok = o != nil && o.bitmap_&1048576 != 0
	if ok {
		value = o.managed
	}
	return
}

// Metrics returns the value of the 'metrics' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
// Metrics array. One or zero elements will present.
func (o *Subscription) Metrics() []*SubscriptionMetrics {
	if o != nil && o.bitmap_&2097152 != 0 {
		return o.metrics
	}
	return nil
}

// GetMetrics returns the value of the 'metrics' attribute and
// a flag indicating if the attribute has a value.
//
// Metrics array. One or zero elements will present.
func (o *Subscription) GetMetrics() (value []*SubscriptionMetrics, ok bool) {
	ok = o != nil && o.bitmap_&2097152 != 0
	if ok {
		value = o.metrics
	}
	return
}

// NotificationContacts returns the value of the 'notification_contacts' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) NotificationContacts() []*Account {
	if o != nil && o.bitmap_&4194304 != 0 {
		return o.notificationContacts
	}
	return nil
}

// GetNotificationContacts returns the value of the 'notification_contacts' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetNotificationContacts() (value []*Account, ok bool) {
	ok = o != nil && o.bitmap_&4194304 != 0
	if ok {
		value = o.notificationContacts
	}
	return
}

// OrganizationID returns the value of the 'organization_ID' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) OrganizationID() string {
	if o != nil && o.bitmap_&8388608 != 0 {
		return o.organizationID
	}
	return ""
}

// GetOrganizationID returns the value of the 'organization_ID' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetOrganizationID() (value string, ok bool) {
	ok = o != nil && o.bitmap_&8388608 != 0
	if ok {
		value = o.organizationID
	}
	return
}

// Plan returns the value of the 'plan' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) Plan() *Plan {
	if o != nil && o.bitmap_&16777216 != 0 {
		return o.plan
	}
	return nil
}

// GetPlan returns the value of the 'plan' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetPlan() (value *Plan, ok bool) {
	ok = o != nil && o.bitmap_&16777216 != 0
	if ok {
		value = o.plan
	}
	return
}

// ProductBundle returns the value of the 'product_bundle' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) ProductBundle() string {
	if o != nil && o.bitmap_&33554432 != 0 {
		return o.productBundle
	}
	return ""
}

// GetProductBundle returns the value of the 'product_bundle' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetProductBundle() (value string, ok bool) {
	ok = o != nil && o.bitmap_&33554432 != 0
	if ok {
		value = o.productBundle
	}
	return
}

// Provenance returns the value of the 'provenance' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
// The origin of cluster registration (values are defined in AMS at pkg/api/subscription_types.go).
func (o *Subscription) Provenance() string {
	if o != nil && o.bitmap_&67108864 != 0 {
		return o.provenance
	}
	return ""
}

// GetProvenance returns the value of the 'provenance' attribute and
// a flag indicating if the attribute has a value.
//
// The origin of cluster registration (values are defined in AMS at pkg/api/subscription_types.go).
func (o *Subscription) GetProvenance() (value string, ok bool) {
	ok = o != nil && o.bitmap_&67108864 != 0
	if ok {
		value = o.provenance
	}
	return
}

// RegionID returns the value of the 'region_ID' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) RegionID() string {
	if o != nil && o.bitmap_&134217728 != 0 {
		return o.regionID
	}
	return ""
}

// GetRegionID returns the value of the 'region_ID' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetRegionID() (value string, ok bool) {
	ok = o != nil && o.bitmap_&134217728 != 0
	if ok {
		value = o.regionID
	}
	return
}

// Released returns the value of the 'released' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
// Flag used to denote whether or not the owner of the cluster has released the ownership and ready to be transferred to a different user.
func (o *Subscription) Released() bool {
	if o != nil && o.bitmap_&268435456 != 0 {
		return o.released
	}
	return false
}

// GetReleased returns the value of the 'released' attribute and
// a flag indicating if the attribute has a value.
//
// Flag used to denote whether or not the owner of the cluster has released the ownership and ready to be transferred to a different user.
func (o *Subscription) GetReleased() (value bool, ok bool) {
	ok = o != nil && o.bitmap_&268435456 != 0
	if ok {
		value = o.released
	}
	return
}

// ServiceLevel returns the value of the 'service_level' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) ServiceLevel() string {
	if o != nil && o.bitmap_&536870912 != 0 {
		return o.serviceLevel
	}
	return ""
}

// GetServiceLevel returns the value of the 'service_level' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetServiceLevel() (value string, ok bool) {
	ok = o != nil && o.bitmap_&536870912 != 0
	if ok {
		value = o.serviceLevel
	}
	return
}

// SocketTotal returns the value of the 'socket_total' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) SocketTotal() int {
	if o != nil && o.bitmap_&1073741824 != 0 {
		return o.socketTotal
	}
	return 0
}

// GetSocketTotal returns the value of the 'socket_total' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetSocketTotal() (value int, ok bool) {
	ok = o != nil && o.bitmap_&1073741824 != 0
	if ok {
		value = o.socketTotal
	}
	return
}

// Status returns the value of the 'status' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) Status() string {
	if o != nil && o.bitmap_&2147483648 != 0 {
		return o.status
	}
	return ""
}

// GetStatus returns the value of the 'status' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetStatus() (value string, ok bool) {
	ok = o != nil && o.bitmap_&2147483648 != 0
	if ok {
		value = o.status
	}
	return
}

// SupportLevel returns the value of the 'support_level' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) SupportLevel() string {
	if o != nil && o.bitmap_&4294967296 != 0 {
		return o.supportLevel
	}
	return ""
}

// GetSupportLevel returns the value of the 'support_level' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetSupportLevel() (value string, ok bool) {
	ok = o != nil && o.bitmap_&4294967296 != 0
	if ok {
		value = o.supportLevel
	}
	return
}

// SystemUnits returns the value of the 'system_units' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) SystemUnits() string {
	if o != nil && o.bitmap_&8589934592 != 0 {
		return o.systemUnits
	}
	return ""
}

// GetSystemUnits returns the value of the 'system_units' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetSystemUnits() (value string, ok bool) {
	ok = o != nil && o.bitmap_&8589934592 != 0
	if ok {
		value = o.systemUnits
	}
	return
}

// TrialEndDate returns the value of the 'trial_end_date' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
// If the subscription is a trial, date the trial ends.
func (o *Subscription) TrialEndDate() time.Time {
	if o != nil && o.bitmap_&17179869184 != 0 {
		return o.trialEndDate
	}
	return time.Time{}
}

// GetTrialEndDate returns the value of the 'trial_end_date' attribute and
// a flag indicating if the attribute has a value.
//
// If the subscription is a trial, date the trial ends.
func (o *Subscription) GetTrialEndDate() (value time.Time, ok bool) {
	ok = o != nil && o.bitmap_&17179869184 != 0
	if ok {
		value = o.trialEndDate
	}
	return
}

// UpdatedAt returns the value of the 'updated_at' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) UpdatedAt() time.Time {
	if o != nil && o.bitmap_&34359738368 != 0 {
		return o.updatedAt
	}
	return time.Time{}
}

// GetUpdatedAt returns the value of the 'updated_at' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetUpdatedAt() (value time.Time, ok bool) {
	ok = o != nil && o.bitmap_&34359738368 != 0
	if ok {
		value = o.updatedAt
	}
	return
}

// Usage returns the value of the 'usage' attribute, or
// the zero value of the type if the attribute doesn't have a value.
//
//
func (o *Subscription) Usage() string {
	if o != nil && o.bitmap_&68719476736 != 0 {
		return o.usage
	}
	return ""
}

// GetUsage returns the value of the 'usage' attribute and
// a flag indicating if the attribute has a value.
//
//
func (o *Subscription) GetUsage() (value string, ok bool) {
	ok = o != nil && o.bitmap_&68719476736 != 0
	if ok {
		value = o.usage
	}
	return
}

// SubscriptionListKind is the name of the type used to represent list of objects of
// type 'subscription'.
const SubscriptionListKind = "SubscriptionList"

// SubscriptionListLinkKind is the name of the type used to represent links to list
// of objects of type 'subscription'.
const SubscriptionListLinkKind = "SubscriptionListLink"

// SubscriptionNilKind is the name of the type used to nil lists of objects of
// type 'subscription'.
const SubscriptionListNilKind = "SubscriptionListNil"

// SubscriptionList is a list of values of the 'subscription' type.
type SubscriptionList struct {
	href  string
	link  bool
	items []*Subscription
}

// Kind returns the name of the type of the object.
func (l *SubscriptionList) Kind() string {
	if l == nil {
		return SubscriptionListNilKind
	}
	if l.link {
		return SubscriptionListLinkKind
	}
	return SubscriptionListKind
}

// Link returns true iif this is a link.
func (l *SubscriptionList) Link() bool {
	return l != nil && l.link
}

// HREF returns the link to the list.
func (l *SubscriptionList) HREF() string {
	if l != nil {
		return l.href
	}
	return ""
}

// GetHREF returns the link of the list and a flag indicating if the
// link has a value.
func (l *SubscriptionList) GetHREF() (value string, ok bool) {
	ok = l != nil && l.href != ""
	if ok {
		value = l.href
	}
	return
}

// Len returns the length of the list.
func (l *SubscriptionList) Len() int {
	if l == nil {
		return 0
	}
	return len(l.items)
}

// Empty returns true if the list is empty.
func (l *SubscriptionList) Empty() bool {
	return l == nil || len(l.items) == 0
}

// Get returns the item of the list with the given index. If there is no item with
// that index it returns nil.
func (l *SubscriptionList) Get(i int) *Subscription {
	if l == nil || i < 0 || i >= len(l.items) {
		return nil
	}
	return l.items[i]
}

// Slice returns an slice containing the items of the list. The returned slice is a
// copy of the one used internally, so it can be modified without affecting the
// internal representation.
//
// If you don't need to modify the returned slice consider using the Each or Range
// functions, as they don't need to allocate a new slice.
func (l *SubscriptionList) Slice() []*Subscription {
	var slice []*Subscription
	if l == nil {
		slice = make([]*Subscription, 0)
	} else {
		slice = make([]*Subscription, len(l.items))
		copy(slice, l.items)
	}
	return slice
}

// Each runs the given function for each item of the list, in order. If the function
// returns false the iteration stops, otherwise it continues till all the elements
// of the list have been processed.
func (l *SubscriptionList) Each(f func(item *Subscription) bool) {
	if l == nil {
		return
	}
	for _, item := range l.items {
		if !f(item) {
			break
		}
	}
}

// Range runs the given function for each index and item of the list, in order. If
// the function returns false the iteration stops, otherwise it continues till all
// the elements of the list have been processed.
func (l *SubscriptionList) Range(f func(index int, item *Subscription) bool) {
	if l == nil {
		return
	}
	for index, item := range l.items {
		if !f(index, item) {
			break
		}
	}
}