Interface ICheckout

Provides details of the currently held Checkout (and a Relinquish() operation).

Namespace: Sp.Agent.Distributor

Assembly: Sp.Agent.Distributor.dll

Properties

Features

Gets the set of Features that have been reserved as part of the Checkout.

Declaration

ISet<string> Features { get; }

Property Value

Type	Description
System.Collections.Generic.ISet<System.String>

Exceptions

Type	Condition
CheckoutStorageAccessException	Thrown if there is a issue reading the checkout storage. See the InnerException for details.

ValidUntil

Gets the UTC date and time until which this Checked out set of Features will remain valid.

Declaration

DateTime ValidUntil { get; }

Property Value

Type	Description
System.DateTime

Exceptions

Type	Condition
CheckoutStorageAccessException	Thrown if there is a issue reading the checkout storage. See the InnerException for details.

Methods

Relinquish()

Releases this Checkout reservation. Upon success, the Client will move back to Connected mode.

Declaration

void Relinquish()

Remarks

Checked Out Features are reserved until a given date/time and must then be explicitly Relinquished in order to return to Connected mode.

Exceptions

Type	Condition
NoDistributorException	Thrown if there is no Distributor configured or discoverable available at the present time.
DistributorRequestException	Thrown if there is a connectivity or related issue contacting the service. See the InnerException for details.
CheckoutStorageAccessException	Thrown if there is a issue reading the checkout storage. See the InnerException for details.
System.InvalidOperationException	Thrown if you have already Relinquish()ed.