Product Order ABE UML Documentation

Element

Common Domain::Product Order ABE
Class ProductOrder

A ProductOrder represents a communication used to procure, update or remove one or many Products in the context of a ProductOffering through all its ProductOrderItems.
One or many PartyRoles might be involved in a ProductOrder / ProductOrderItem such as Distributor, Holder, Buyer or DeliveryDriver.

Attributes
ProductOrderItem	_partyOrderItem
Agreement	agreement
Integer	assignedPriority	The order's assigned priority after review.
DateTime	assignedResponsibilityDate	The target response date assigned after review.
Attachment	attachment
CommunicationInteraction	communicationInteraction
DateTime	dueDate	The date upon which the ProductOrder is due for completion.
«preliminary» DunningCaseRule	dunningCaseRule
DateTime	expectedCompletionDate	Expected delivery date amended by the provider.
PartyRole	partyRole
ProductOrderRelationship	productOrderRelationship
ProductOrderRelationship	productOrderRelationship2
ProductPrice	productPrice
String	purchaseOrderNumber	A number that uniquely identifies a ProductOrder within the ordering Party's enterprise.
DateTime	requestedCompletionDate	Requested delivery date from the requestor perspective.
DateTime	requestedStartDate	Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date. It can happen for example in the context of a move.
String	status	Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on.
String	type	An indicator that specifies the kind of ProductOrder.
«baseType» TimePeriod	validFor	Period during which the provider's proposal is valid. After this period, if the requester hasn't validated the order, the tarification might change.

Attributes inherited from SID Models::Common Domain::Root Business Entities ABE::RootEntity
_rootEntityType, _revenueAssuranceParmValue, _characteristicValue, name, description, ID, metric, _monitoredMetricInstancesCriteria, directedEdge, vertex, entityCatalogItem, rootEntityGroupMember, rootEntityGroup, rootEntityRelationship, rootEntityRelationship2, associationRole, entitySpecificationAttachment, interactionUseCase, interactionResult

Properties:

Alias
Classifier Behavior
Is Abstract	true
Is Active	false
Is Leaf	false
Keywords
Name	ProductOrder
Name Expression
Namespace	«009» Product Order ABE
Owned Template Signature
Owner	«009» Product Order ABE
Owning Template Parameter
Package	«009» Product Order ABE
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder
Representation
Stereotype
Template Parameter
Visibility	Public

Attribute Details

_partyOrderItem

Public ProductOrderItem _partyOrderItem

Constraints:

Properties:

Aggregation	Shared
Alias
Association	ProductOrderComprisedOf
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	false
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	_partyOrderItem
Name Expression
Namespace	ProductOrder
Opposite	_partyOrder
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::_partyOrderItem
Stereotype
Template Parameter
Type	ProductOrderItem
Upper	*
Upper Value	(*)
Visibility	Public

agreement

Public Agreement agreement

Constraints:

Properties:

Aggregation	None
Alias
Association	ProductOrderRefersTo
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	agreement
Name Expression
Namespace	ProductOrder
Opposite	productOrder
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::agreement
Stereotype
Template Parameter
Type	Agreement
Upper	1
Upper Value	(1)
Visibility	Public

assignedPriority

Public Integer assignedPriority

The order's assigned priority after review.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	assignedPriority
Name Expression
Namespace	ProductOrder
Opposite
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::assignedPriority
Stereotype
Template Parameter
Type	Integer
Upper	1
Upper Value
Visibility	Public

assignedResponsibilityDate

Public DateTime assignedResponsibilityDate

The target response date assigned after review.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	assignedResponsibilityDate
Name Expression
Namespace	ProductOrder
Opposite
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::assignedResponsibilityDate
Stereotype
Template Parameter
Type	DateTime
Upper	1
Upper Value
Visibility	Public

attachment

Public Attachment attachment

Constraints:

Properties:

Aggregation	None
Alias
Association	ProductOrderFurtherDescribedByAttachment
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	attachment
Name Expression
Namespace	ProductOrder
Opposite	productOrder
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::attachment
Stereotype
Template Parameter
Type	Attachment
Upper	*
Upper Value	(*)
Visibility	Public

communicationInteraction

Public CommunicationInteraction communicationInteraction

Constraints:

Properties:

Aggregation	None
Alias
Association	CommunicationInteractionConcernsProductOrder
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value	(1)
Multiplicity	1..*
Name	communicationInteraction
Name Expression
Namespace	ProductOrder
Opposite	productOrder
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::communicationInteraction
Stereotype
Template Parameter
Type	CommunicationInteraction
Upper	*
Upper Value	(*)
Visibility	Public

dueDate

Public DateTime dueDate

The date upon which the ProductOrder is due for completion.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	dueDate
Name Expression
Namespace	ProductOrder
Opposite
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::dueDate
Stereotype
Template Parameter
Type	DateTime
Upper	1
Upper Value
Visibility	Public

dunningCaseRule

Public «preliminary» DunningCaseRule dunningCaseRule

Constraints:

Properties:

Aggregation	None
Alias
Association	DunningCaseRuleTriggersPartyOrder
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	0..1
Name	dunningCaseRule
Name Expression
Namespace	ProductOrder
Opposite	partyOrder
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::dunningCaseRule
Stereotype
Template Parameter
Type	«preliminary» DunningCaseRule
Upper	1
Upper Value	(1)
Visibility	Public

expectedCompletionDate

Public DateTime expectedCompletionDate

Expected delivery date amended by the provider.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	expectedCompletionDate
Name Expression
Namespace	ProductOrder
Opposite
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::expectedCompletionDate
Stereotype
Template Parameter
Type	DateTime
Upper	1
Upper Value
Visibility	Public

partyRole

Public PartyRole partyRole

Constraints:

Properties:

Aggregation	None
Alias
Association	PartyRoleInvolvedInProductOrder
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value	(1)
Multiplicity	1..*
Name	partyRole
Name Expression
Namespace	ProductOrder
Opposite	partyOrder
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::partyRole
Stereotype
Template Parameter
Type	PartyRole
Upper	*
Upper Value	(*)
Visibility	Public

productOrderRelationship

Public ProductOrderRelationship productOrderRelationship

Constraints:

Properties:

Aggregation	None
Alias
Association	ProductOrderReferencedBy
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	productOrderRelationship
Name Expression
Namespace	ProductOrder
Opposite	productOrder
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::productOrderRelationship
Stereotype
Template Parameter
Type	ProductOrderRelationship
Upper	*
Upper Value	(*)
Visibility	Public

productOrderRelationship2

Public ProductOrderRelationship productOrderRelationship2

Constraints:

Properties:

Aggregation	None
Alias
Association	ProductOrderReferences
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	productOrderRelationship2
Name Expression
Namespace	ProductOrder
Opposite	productOrder2
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::productOrderRelationship2
Stereotype
Template Parameter
Type	ProductOrderRelationship
Upper	*
Upper Value	(*)
Visibility	Public

productPrice

Public ProductPrice productPrice

Constraints:

Properties:

Aggregation	None
Alias
Association	ProductPriceAppliesOnProductOrder
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	0
Lower Value	(0)
Multiplicity	*
Name	productPrice
Name Expression
Namespace	ProductOrder
Opposite	productOrder
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::productPrice
Stereotype
Template Parameter
Type	ProductPrice
Upper	*
Upper Value	(*)
Visibility	Public

purchaseOrderNumber

Public String purchaseOrderNumber

A number that uniquely identifies a ProductOrder within the ordering Party's enterprise.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	purchaseOrderNumber
Name Expression
Namespace	ProductOrder
Opposite
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::purchaseOrderNumber
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

requestedCompletionDate

Public DateTime requestedCompletionDate

Requested delivery date from the requestor perspective.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	requestedCompletionDate
Name Expression
Namespace	ProductOrder
Opposite
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::requestedCompletionDate
Stereotype
Template Parameter
Type	DateTime
Upper	1
Upper Value
Visibility	Public

requestedStartDate

Public DateTime requestedStartDate

Order fulfillment start date wished by the requestor. This is used when, for any reason, requestor cannot allow seller to begin to operationally begin the fulfillment before a date. It can happen for example in the context of a move.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	requestedStartDate
Name Expression
Namespace	ProductOrder
Opposite
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::requestedStartDate
Stereotype
Template Parameter
Type	DateTime
Upper	1
Upper Value
Visibility	Public

status

Public String status

Tracks the lifecycle status of the product order, such as Acknowledged, Rejected, InProgress, Pending and so on.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	status
Name Expression
Namespace	ProductOrder
Opposite
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::status
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

type

Public String type

An indicator that specifies the kind of ProductOrder.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	type
Name Expression
Namespace	ProductOrder
Opposite
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::type
Stereotype
Template Parameter
Type	String
Upper	1
Upper Value
Visibility	Public

validFor

Public «baseType» TimePeriod validFor

Period during which the provider's proposal is valid. After this period, if the requester hasn't validated the order, the tarification might change.

Constraints:

Properties:

Aggregation	None
Alias
Association
Association End
Class	ProductOrder
Datatype
Default
Default Value
Is Composite	false
Is Derived	false
Is Derived Union	false
Is Leaf	false
Is Ordered	false
Is Read Only	false
Is Static	false
Is Unique	true
Keywords
Lower	1
Lower Value
Multiplicity	None (1)
Name	validFor
Name Expression
Namespace	ProductOrder
Opposite
Owner	ProductOrder
Owning Association
Owning Template Parameter
Qualified Name	SID Models::Common Domain::Product Order ABE::ProductOrder::validFor
Stereotype
Template Parameter
Type	«baseType» TimePeriod
Upper	1
Upper Value
Visibility	Public

Overview

Top

Package

Element

Product Order ABE UML Documentation

Summary:AttributesProperties

Detail:Attributes