• Home
• eu.fispace
• api
• 0.17.5
• source code
• LGMessages.xjb

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

schema.domain.lg.LGMessages.xjb Maven / Gradle / Ivy

	
	
		
		
                
	

	

		

		
			
				
                    
This package contains the classes that describe the messages that
the FIspace SDI component will exchange with apps and external systems
in the logistics domain.
                    ]]>
				
			
		

		

		
			
				
Message sent from logistics planning app to FIspace,
representing a notification about a logistics plan,
can be used for a new logistics plan as well as an update of an existing plan.
				
			
		
		
			
				
Message sent from logistics planning app to FIspace,
representing a notification that the deadline of a leg has exceeded.
				
			
		
		
			
				
Message sent from manual notification app to FIspace as well as
from FIspace to logistics planning app,
representing a notification about a delay.
				
			
		
		
			
				
Message sent from manual notification app to FIspace as well as
from FIspace to logistics planning app,
representing a notification about a leg that was finished.
				
			
		
		
			
				
Message sent from shipment status app to FIspace,
requesting notifications (for a specific transport plan).
				
			
		
		
			
				
Message sent from FIspace to shipment status app.

To be clarified:
 - What are the envisaged contents of such a notification? Is a String attribute sufficient?
 - Should several notifications be contained in one message?
				
			
		

		
		
			
				
This class represents a message that reports a status change of a shipment.
In addition to the status itself, the message also contains an optional notification text.
				
			
		
		
			
				
This class represents a request for detailed information about a specific shipment. It is typically sent
by a shipment recipient to get detailed information about the shipment from the shipment supplier.
The expected response by the shipment supplier is a @ProvideShipmentDetailsResponseMessage.
				
			
		
		
			
				
This class represents a message that includes detail information about a specific shipment. It is typically
sent by the supplier of a shipment to the shipment recipient. It is a response to a message of type
@ProvideShipmentDetailsRequestMessage.
				
			
		
		
			
				
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!!                  BEWARE OF THE LEOPARD                   !!!
!!!       This is a quick and dirty workaround for RM3       !!!
!!! Under no circumstances should anyone try and do the same !!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

FIXME !!!

This class represents a message that reports a status change of a shipment's RTIs.
... TODO ...
				
			
		
		
			
				
This class represents a link to the TIC app.
On acceptance of an incoming shipment, this message reports quality-related information of the goods to the TIC app.
				
			
		

	

	

		

		
			
				
This class represents the ID and designator of a transport plan.

This will e.g. be sent to FIspace as part of the message
@link eu.fispace.api.sdi.domain.lg.vo.TransportPlan [TransportPlan].
				
			
		
		
			
				
This class is used to describe one leg of an overall transport plan.
				
			
		

		
        
            
                
This class represents a common base for all other messages.
It provides the IDs of the message itself, the sender and the receiver as well as the types of apps exchanging this message.
This is a preliminary proposal and will be defined from WP200, which is defining and implementing the platform modules.
                
            
        

        
            
                
This class represents a common base for messages that are sent in the context of a specific shipment.
It provides the ID of the shipment as well as a link (URL) to a web service of a PIA backend for accessing the associated shipment data.
                
            
        

        
            
                
This class represents a message that reports a status change of a shipment extending the PIAPushMessage.
In addition to the status itself, the message also contains an optional notification text.
Supported options for the shipment status are:
- In Work: when a new shipment is created by a supplier, its initial status is “In Work”. The customer of the shipment is only aware of its existence after its announcement (see the next status below). Sending the status “In Work” has the purpose of undoing an announcement, e.g. for the case that the shipment is cancelled or its details need to changed.
- Announced: after finalising a shipment, the latter needs to be announced to the customer – only after that its details are visible to the customer. After announcing a shipment editing is only possible if the status is set to “In Work” before.
- On Transport: this message informs the customer that the (physical) shipment has left the supplier’s premises and are being transported to the announced delivery location
- Delivered: sent by the customer. It informs the supplier that a shipment has arrived at the delivery location.
- Accepted: after a quality check of the arrived shipment, the customer can accept or reject the goods. In the former case the status “Accepted” is sent to the supplier.
- Rejected: same as above, but the shipment is rejected. In addition a feedback message stating the reason for the rejection is returned to the supplier.
                
            
        

        
            
                
This class represents an information item based on a boolean.
                
            
        

        
            
                
This class represents an information item based on a date.
                
            
        

        
            
                
This class represents an information item based on a double.
                
            
        

        
            
                
This class represents an information item based on an integer.
                
            
        

        
            
                
This class represents an information item based on a string.
                
            
        

        
            
                
This class represents an information item based on a string list.
                
            
        

		
			
				
TODO
				
			
		

        
            
                
This class represents a packaging type based on master data.
                
            
        

        
            
                
This class represents a packaging type based on custom data.
                
            
        

        
            
                
This class represents a product type based on master data.
                
            
        

        
            
                
This class represents a product type based on custom data.
                
            
        

        
            
                
This class represents a shipment status update linking a shipment status and a date.
                
            
        

        
            
                
This class represents a shipment which is kind of a root element. Within this element basic shipment information as well as shipment items are ordered.
                
            
        

        
            
                
This class represents an actor which can be supplier or customer of a shipment.
                
            
        

        
            
                
This class represents a location which can be a source or destination of a shipment.
                
            
        

		
			
				
					TODO
				
			
		

		
			
				
					TODO
				
			
		

        
            
                
This class represents a shipment identification.
                
            
        

        
            
                
This class represents a shipment item which is kind of sub-root element. Within this element basic information about product and packaging as well as information items are ordered.
                
            
        

        
            
                
This class represents a generalized information item. Specified information items have a specific value type, like booean or integer.
                
            
        

        
            
                
This class represents a notification entered by an actor incontext of a shipment.