Class SequenceNumber

Represents a number sequence and hold a list of NumberSequenceCounters

Inheritance
System.Object
SequenceNumber
Namespace: Simplic.Framework.Core
Assembly: Simplic.Framework.Base.dll
Syntax
public class SequenceNumber : UI.MVC.ViewModelBase

Constructors

| Improve this Doc View Source

SequenceNumber()

Create new sequence instance

Declaration
public SequenceNumber()

Properties

| Improve this Doc View Source

Counters

List with available counters

Declaration
public ObservableCollection<SequenceNumberCounter> Counters { get; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<SequenceNumberCounter>
| Improve this Doc View Source

DeletedCounters

Contains a list of all deleted counters

Declaration
public IList<SequenceNumberCounter> DeletedCounters { get; }
Property Value
Type Description
System.Collections.Generic.IList<SequenceNumberCounter>
| Improve this Doc View Source

DisplayName

Friendly name

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Format

Default formatting, can be overwritten by counters

Declaration
public string Format { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Id

Unique id

Declaration
public Guid Id { get; set; }
Property Value
Type Description
System.Guid
| Improve this Doc View Source

InternName

Name for intern usage

Declaration
[Required]
[RegularExpression("[^0-9a-zA-Z]+")]
public string InternName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

SelectedItem

Currently selected tab

Declaration
public SequenceNumberCounter SelectedItem { get; set; }
Property Value
Type Description
SequenceNumberCounter

Methods

| Improve this Doc View Source

Commit(DateTime, String, Nullable<Guid>)

Commit number so it can't be reused

Declaration
public void Commit(DateTime date, string number, Guid? tenantId = null)
Parameters
Type Name Description
System.DateTime date

Date for validating a counter
System.String number

Number to commit
System.Nullable<System.Guid> tenantId

Tenant to use
| Improve this Doc View Source

DeleteCounter(SequenceNumberCounter)

Delete counter

Declaration
public void DeleteCounter(SequenceNumberCounter counter)
Parameters
Type Name Description
SequenceNumberCounter counter

Counter instance
| Improve this Doc View Source

Generate(DateTime, Boolean, Nullable<Guid>)

Select counter and generate new number from sequence

Declaration
public string Generate(DateTime date, bool useReservation, Guid? tenantId = null)
Parameters
Type Name Description
System.DateTime date

Date for validating a counter
System.Boolean useReservation

True if reservation should be used
System.Nullable<System.Guid> tenantId

Optional tenant id
Returns
Type Description
System.String

Throws an exception if no or more than one counter was found, else returns a valid counter value
| Improve this Doc View Source

Generate(DateTime, Nullable<Guid>)

Select counter and generate new number from sequence

Declaration
public string Generate(DateTime date, Guid? tenantId = null)
Parameters
Type Name Description
System.DateTime date

Date for validating a counter
System.Nullable<System.Guid> tenantId

Optional tenant id
Returns
Type Description
System.String

Throws an exception if no or more than one counter was found, else returns a valid counter value
| Improve this Doc View Source

GetAsJson()

Get current sequence as json

Declaration
public string GetAsJson()
Returns
Type Description
System.String

Returns json string
| Improve this Doc View Source

GetCounter(DateTime, Nullable<Guid>)

Get a valid counter for a given date and tenant

Declaration
public SequenceNumberCounter GetCounter(DateTime date, Guid? tenantId = null)
Parameters
Type Name Description
System.DateTime date

Date for validating a counter
System.Nullable<System.Guid> tenantId

Optional tenant id
Returns
Type Description
SequenceNumberCounter

Sequence number counter instance