TimeEntitlement
RIXML 2.5 Element
Establishes temporal boundaries for research accessibility through a mandatory endDateTime attribute in Level One. Defines when content should expire or become inaccessible to consumers.
Usage
Include at most one TimeEntitlement element within an Entitlement when time-based access control is needed. The endDateTime must be later than the ProductDetails.publicationDateTime and uses ISO 8601 format with Zulu time.
Business Context
Supports time-sensitive content management by automating research expiration, managing embargo periods, and ensuring stale information doesn't persist in client systems beyond intended shelf life.
Where It Fits
Canonical Path
Definition
| Type | |
| Namespace | http://www.rixml.org/2017/9/RIXML |
| Min Occurs | 1 |
| Max Occurs | 1 |
| Content Model | Text content (string) |
Attributes
startDateTimedateTime |
The date and time after which the product should be read. It is optional because using only an endDateTime is also a meaningful use-case for products that are immediately readable, but expire at a certain time. The startDateTime must be later on the time scale than the value of Product.publicationDateTime. optionalSince 2.1 |
endDateTimedateTime |
The date and time after which the product should not be read. It is optional because using only a startDateTime is also a meaningful use-case for products that are only readable after a time embargo, but never expire. The endDateTime must be later on the time scale than the value of Product.publicationDateTime. optionalSince 2.1 |
Children
Contains text content (type: string)
This element's value is its text content. Attributes provide additional context.
Example
<TimeEntitlement>ABC-123</TimeEntitlement>Version History
Unchanged since introduction in RIXML 2.1
Business Rules
The startDateTime must be later on the time scale than the value of Product publicationDateTime
The endDateTime must be later on the time scale than the value of Product publicationDateTime
The endDateTime attribute in TimeEntitlement must be set to a time later than the publicationDateTime
Design Decisions
endDateTime attribute is required in TimeEntitlement for Level One
To ensure clear time-based entitlement boundaries in the simplified schema
RIXML Level One Addendum v2.5, p.23
startDateTime must be later than Product.publicationDateTime
Ensures logical temporal ordering where products cannot be readable before they are actually published
RIXML Research Data Dictionary v2.5.1, p.60
endDateTime must be later than Product.publicationDateTime
Ensures logical temporal ordering where products cannot expire before they are published
RIXML Research Data Dictionary v2.5.1, p.60
Semantic Relationships
Constrains3 relationships
Start date time must be later than the product publication date time
RIXML Research Data Dictionary v2.5.1, p.60— Elements and Attributes
End date time must be later than the product publication date time
RIXML Research Data Dictionary v2.5.1, p.60— Elements and Attributes
TimeEntitlement endDateTime must be later in time than ProductDetails publicationDateTime
RIXML Level One Addendum v2.5, p.23— Research.Product.Context.ProductDetails.EntitlementGroup.Entitlement.TimeEntitlement