OSID — Ordering Entities

Order

Osid Object

An Order.

Like all OsidObjects, Order is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object

Name	Syntax	Description
`customerId`	id	the customer `Id`
`customer`	Resource	the customer
`totalCost`	Currency	the total cost
`isAtomic`	boolean	`true` if the order is atomic, `false` otherwise
`isSubmitted`	boolean	`true` if the order has been submitted, `false` otherwise
`submitDate`	datetime	the date submitted
`submitterId`	id	the submitting resource `Id`
`submitter`	Resource	the submitting resource
`submittingAgentId`	id	the submitting agent `Id`
`submittingAgent`	Agent	the submitting agent
`isClosed`	boolean	`true` if the order is closed, `false` otherwise
`closedDate`	datetime	the date closed
`closerId`	id	the closing resource `Id`
`closer`	Resource	the closing resource
`closingAgentId`	id	the closing agent `Id`
`closingAgent`	Agent	the closing agent

Order Item

Osid Relationship

A OrderItem represents a collection of orders. Like all OSID objects, a OrderItem is identified by its Id and any persisted references should use the Id.

An OrderItem may have multiple unit prices for different types of currencies, such as one for payment and one for credits. Each line item cost type should be lined up with the unit price type.

Like all OsidObjects, OrderItem is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Temporal
`isEffective`	boolean		`true` if this is effective, `false` otherwise
`startDate`	datetime		the start date
`endDate`	datetime		the end date
OsidRelationship
`hasEndReason`	boolean		`true` if an end reason is available, `false` otherwise
`endReasonId`	id		a state `Id`
`endReason`	State		a state

Name	Syntax	Many	Description
`orderId`	id		the order `Id`
`order`	Order		the order
`isDerived`	boolean		`true` if this order item is derived, `false` otherwise
`productId`	id		the product `Id`
`product`	Product		the product
`unitPriceIds`	id	⋆	the price `Ids`
`unitPrices`	Price	⋆	the prices
`quantity`	cardinal		the quantity of the product
`costs`	Cost	⋆	the costs.

Product

Osid Object

A Product represents something ordered.

Like all OsidObjects, Product is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object

Name	Syntax	Many	Description
`code`	string		a product code
`priceScheduleIds`	id	⋆	a price schedule `Id`
`priceSchedules`	PriceSchedule	⋆	the price schedules
`hasAvailability`	boolean		`true` if an available is available, `false` otherwise
`availability`	cardinal		the availability

Price Schedule

Osid Object Aggregateable

A PriceSchedule lists the price catalog.

Like all OsidObjects, PriceSchedule is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object

Name	Syntax	Description
`hasListPrice`	boolean	`true` if this price schedule has a list price, `false` otherwise
`listPrice`	Currency	the list price
`isRecurring`	boolean	`true` if the list price is recurring, `false` if one-time
`recurringInterval`	duration	the interval

Price

Osid Rule Subjugateable

A Price.

Like all OsidObjects, Price is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Operable
`isActive`	boolean		`true` if this operable is active, `false` if it is inactive
`isEnabled`	boolean		`true` if this operable is enabled, `false` if the active status is determined by other rules
`isDisabled`	boolean		`true` if this operable is disabled, `false` if the active status is determined by other rules
`isOperational`	boolean		`true` if this operable is operational, `false` otherwise
OsidRule
`hasRule`	boolean		`true` if an explicit rule is available, `false` otherwise
`ruleId`	id		the rule `Id`
`rule`	Rule		the rule
`conditionRecordTypes`	type	⋆	a list of `OsidCondition` record `Types`

Name	Syntax	Description
`priceScheduleId`	id	the price schedule `Id`
`priceSchedule`	PriceSchedule	the price schedule
`hasQuantityRange`	boolean	`true` if this price has a quantity range, `false` if this price is the same for any quantity
`minimumQuantity`	cardinal	the quantity
`maximumQuantity`	cardinal	the quantity
`hasDemographic`	boolean	`true` if this price has a demographic, `false` otherwise
`demographicId`	id	the resource `Id`
`demographic`	Resource	the resource
`amount`	Currency	the amount
`isRecurring`	boolean	`true` if this price is recurring, `false` if one-time
`recurringInterval`	duration	the interval

Store

Osid Catalog

A Store represents a collection of orders. Like all OSID objects, a Store is identified by its Id and any persisted references should use the Id.

Like all OsidObjects, Store is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Sourceable
`providerId`	id		the provider `Id`
`provider`	Resource		the provider
`brandingIds`	id	⋆	a list of asset `Ids`
`branding`	Asset	⋆	a list of assets
`license`	displaytext		the license

Ordering

Orders

Products

Prices and Price Schedules

Store Cataloging

Sub Packages

Order

Order Item

Product

Price Schedule

Price

Store