Class ResourceRequirementPlanningClient

SignalR client for communication with the resource-requirement-planning server

Inheritance

System.Object

ResourceRequirementPlanningClient

Namespace: Simplic.Logistics.Planning.Client

Assembly: Simplic.Logistics.Planning.Client.dll

Syntax

public abstract class ResourceRequirementPlanningClient : HubClientBase

Constructors

| Improve this Doc View Source

ResourceRequirementPlanningClient(IClient, IConnectionConfigurationService)

Initialize new server connection

Declaration

public ResourceRequirementPlanningClient(IClient clientBase, IConnectionConfigurationService configurationService)

Parameters

Type	Name	Description
IClient	clientBase
IConnectionConfigurationService	configurationService

Methods

| Improve this Doc View Source

Initialize(String)

Declaration

public override void Initialize(string connectionName = "SimplicWebApi")

Parameters

Type	Name	Description
System.String	connectionName

| Improve this Doc View Source

OnAddResourcesAsync(IList<ResourceModel>)

Will be called when new resources are added

Declaration

protected abstract Task OnAddResourcesAsync(IList<ResourceModel> resources)

Parameters

Type	Name	Description
System.Collections.Generic.IList<ResourceModel>	resources

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

OnAddShipmentsAsync(IList<Shipment>)

Will be called when a new shipment is added

Declaration

protected abstract Task OnAddShipmentsAsync(IList<Shipment> shipments)

Parameters

Type	Name	Description
System.Collections.Generic.IList<Shipment>	shipments

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

OnCompleteAsync()

Will be called when a shipment was scheduled by someone else

Declaration

protected abstract Task OnCompleteAsync()

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

OnConnectionClosed()

Declaration

protected abstract Task OnConnectionClosed()

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

OnResponseAsync(ChangeResponse)

Retrieve a response from the server, containing the changed data

Declaration

protected abstract Task OnResponseAsync(ChangeResponse model)

Parameters

Type	Name	Description
ChangeResponse	model	Change data as model

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

OnScheduleAsync(ScheduleShipmentModel)

Will be called when a shipment was scheduled by someone else

Declaration

protected abstract Task OnScheduleAsync(ScheduleShipmentModel model)

Parameters

Type	Name	Description
ScheduleShipmentModel	model

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

OnScheduleBulkAsync(IList<ScheduleShipmentModel>)

Schedule a batch of shipments at a time

Declaration

protected abstract Task OnScheduleBulkAsync(IList<ScheduleShipmentModel> model)

Parameters

Type	Name	Description
System.Collections.Generic.IList<ScheduleShipmentModel>	model

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

OnUnscheduleAsync(UnscheduleShipmentModel)

Will be called when a shipment was unscheduled by someone else

Declaration

protected abstract Task OnUnscheduleAsync(UnscheduleShipmentModel model)

Parameters

Type	Name	Description
UnscheduleShipmentModel	model

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

RequestResourcesAsync(Guid, String, DateTime)

Request all resources from the server

Declaration

public async Task RequestResourcesAsync(Guid resourceGroup, string template, DateTime startDate)

Parameters

Type	Name	Description
System.Guid	resourceGroup	Resource gorup id
System.String	template	String template
System.DateTime	startDate

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

RequestShipmentsAsync()

Request all shipments from the server

Declaration

public async Task RequestShipmentsAsync()

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

RequestTourAsync(DateTime, DateTime)

Request all resources from the server

Declaration

public async Task RequestTourAsync(DateTime start, DateTime end)

Parameters

Type	Name	Description
System.DateTime	start
System.DateTime	end

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

ScheduleAsync(ScheduleShipmentModel)

Schedule an shipment

Declaration

public async Task ScheduleAsync(ScheduleShipmentModel scheduleShipmentModel)

Parameters

Type	Name	Description
ScheduleShipmentModel	scheduleShipmentModel

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

StartAsync()

Declaration

public async Task StartAsync()

Returns

Type	Description
System.Threading.Tasks.Task

| Improve this Doc View Source

UnscheduleAsync(UnscheduleShipmentModel)

Unschedule a shipment

Declaration

public async Task UnscheduleAsync(UnscheduleShipmentModel unscheduleShipmentModel)

Parameters

Type	Name	Description
UnscheduleShipmentModel	unscheduleShipmentModel

Returns

Type	Description
System.Threading.Tasks.Task