@twin.org/standards-w3c-odrl 0.0.1-next.21

package/docs/reference/variables/LeftOperandType.md

@@ -0,0 +1,199 @@
+# Variable: LeftOperandType
+
+> `const` **LeftOperandType**: `object`
+
+The types for ODRL Data Types.
+
+## Type declaration
+
+### AbsolutePosition
+
+> `readonly` **AbsolutePosition**: `"absolutePosition"` = `"absolutePosition"`
+
+Absolute Position type.
+
+### AbsoluteSpatialPosition
+
+> `readonly` **AbsoluteSpatialPosition**: `"absoluteSpatialPosition"` = `"absoluteSpatialPosition"`
+
+Absolute Spatial Position type.
+
+### AbsoluteTemporalPosition
+
+> `readonly` **AbsoluteTemporalPosition**: `"absoluteTemporalPosition"` = `"absoluteTemporalPosition"`
+
+Absolute Temporal Position type.
+
+### AbsoluteSize
+
+> `readonly` **AbsoluteSize**: `"absoluteSize"` = `"absoluteSize"`
+
+Absolute Size type.
+
+### Count
+
+> `readonly` **Count**: `"count"` = `"count"`
+
+Count type.
+
+### DateTime
+
+> `readonly` **DateTime**: `"dateTime"` = `"dateTime"`
+
+DateTime type.
+
+### DelayPeriod
+
+> `readonly` **DelayPeriod**: `"delayPeriod"` = `"delayPeriod"`
+
+Delay Period type.
+
+### DeliveryChannel
+
+> `readonly` **DeliveryChannel**: `"deliveryChannel"` = `"deliveryChannel"`
+
+Delivery Channel type.
+
+### ElapsedTime
+
+> `readonly` **ElapsedTime**: `"elapsedTime"` = `"elapsedTime"`
+
+Elapsed Time type.
+
+### Event
+
+> `readonly` **Event**: `"event"` = `"event"`
+
+Event type.
+
+### FileFormat
+
+> `readonly` **FileFormat**: `"fileFormat"` = `"fileFormat"`
+
+File Format type.
+
+### Industry
+
+> `readonly` **Industry**: `"industry"` = `"industry"`
+
+Industry type.
+
+### Language
+
+> `readonly` **Language**: `"language"` = `"language"`
+
+Language type.
+
+### Media
+
+> `readonly` **Media**: `"media"` = `"media"`
+
+Media type.
+
+### MeteredTime
+
+> `readonly` **MeteredTime**: `"meteredTime"` = `"meteredTime"`
+
+Metered Time type.
+
+### PayAmount
+
+> `readonly` **PayAmount**: `"payAmount"` = `"payAmount"`
+
+Pay Amount type.
+
+### Percentage
+
+> `readonly` **Percentage**: `"percentage"` = `"percentage"`
+
+Percentage type.
+
+### Product
+
+> `readonly` **Product**: `"product"` = `"product"`
+
+Product type.
+
+### Purpose
+
+> `readonly` **Purpose**: `"purpose"` = `"purpose"`
+
+Purpose type.
+
+### Recipient
+
+> `readonly` **Recipient**: `"recipient"` = `"recipient"`
+
+Recipient type.
+
+### RelativePosition
+
+> `readonly` **RelativePosition**: `"relativePosition"` = `"relativePosition"`
+
+Relative Position type.
+
+### RelativeSpatialPosition
+
+> `readonly` **RelativeSpatialPosition**: `"relativeSpatialPosition"` = `"relativeSpatialPosition"`
+
+Relative Spatial Position type.
+
+### RelativeTemporalPosition
+
+> `readonly` **RelativeTemporalPosition**: `"relativeTemporalPosition"` = `"relativeTemporalPosition"`
+
+Relative Temporal Position type.
+
+### RelativeSize
+
+> `readonly` **RelativeSize**: `"relativeSize"` = `"relativeSize"`
+
+Relative Size type.
+
+### Resolution
+
+> `readonly` **Resolution**: `"resolution"` = `"resolution"`
+
+Resolution type.
+
+### Spatial
+
+> `readonly` **Spatial**: `"spatial"` = `"spatial"`
+
+Spatial type.
+
+### SpatialCoordinates
+
+> `readonly` **SpatialCoordinates**: `"spatialCoordinates"` = `"spatialCoordinates"`
+
+Spatial Coordinates type.
+
+### SystemDevice
+
+> `readonly` **SystemDevice**: `"systemDevice"` = `"systemDevice"`
+
+System Device type.
+
+### TimeInterval
+
+> `readonly` **TimeInterval**: `"timeInterval"` = `"timeInterval"`
+
+Time Interval type.
+
+### UnitOfCount
+
+> `readonly` **UnitOfCount**: `"unitOfCount"` = `"unitOfCount"`
+
+Unit of Count type.
+
+### Version
+
+> `readonly` **Version**: `"version"` = `"version"`
+
+Version type.
+
+### VirtualLocation
+
+> `readonly` **VirtualLocation**: `"virtualLocation"` = `"virtualLocation"`
+
+Virtual Location type.

package/docs/reference/variables/LogicalConstraintType.md

@@ -0,0 +1,31 @@
+# Variable: LogicalConstraintType
+
+> `const` **LogicalConstraintType**: `object`
+
+The types for ODRL Logical Constraints.
+
+## Type declaration
+
+### And
+
+> `readonly` **And**: `"and"` = `"and"`
+
+And type.
+
+### Or
+
+> `readonly` **Or**: `"or"` = `"or"`
+
+Or type.
+
+### Xone
+
+> `readonly` **Xone**: `"xone"` = `"xone"`
+
+Xone type.
+
+### AndSequence
+
+> `readonly` **AndSequence**: `"andSequence"` = `"andSequence"`
+
+And sequence type.

package/docs/reference/variables/OdrlContexts.md

@@ -0,0 +1,37 @@
+# Variable: OdrlContexts
+
+> `const` **OdrlContexts**: `object`
+
+The contexts for ODRL.
+
+## Type declaration
+
+### Context
+
+> `readonly` **Context**: `"https://www.w3.org/ns/odrl.jsonld"` = `"https://www.w3.org/ns/odrl.jsonld"`
+
+The context root for ODRL.
+
+### ContextVocabulary
+
+> `readonly` **ContextVocabulary**: `"https://www.w3.org/ns/odrl/2/"` = `"https://www.w3.org/ns/odrl/2/"`
+
+The context root for ODRL vocabulary.
+
+### ContextDcTerms
+
+> `readonly` **ContextDcTerms**: `"https://purl.org/dc/terms/"` = `"https://purl.org/dc/terms/"`
+
+The context root for Dublin Core Terms.
+
+### ContextRdf
+
+> `readonly` **ContextRdf**: `"https://www.w3.org/1999/02/22-rdf-syntax-ns#"` = `"https://www.w3.org/1999/02/22-rdf-syntax-ns#"`
+
+The context root for RDF.
+
+### ContextXsd
+
+> `readonly` **ContextXsd**: `"https://www.w3.org/2001/XMLSchema#"` = `"https://www.w3.org/2001/XMLSchema#"`
+
+The context root for XSD.

package/docs/reference/variables/OdrlTypes.md

@@ -0,0 +1,97 @@
+# Variable: OdrlTypes
+
+> `const` **OdrlTypes**: `object`
+
+The types for ODRL.
+
+## Type declaration
+
+### Policy
+
+> `readonly` **Policy**: `"Policy"` = `"Policy"`
+
+Policy type.
+
+### Set
+
+> `readonly` **Set**: `"Set"` = `"Set"`
+
+Set type (subclass of Policy).
+
+### Offer
+
+> `readonly` **Offer**: `"Offer"` = `"Offer"`
+
+Offer type (subclass of Policy).
+
+### Agreement
+
+> `readonly` **Agreement**: `"Agreement"` = `"Agreement"`
+
+Agreement type (subclass of Policy).
+
+### Asset
+
+> `readonly` **Asset**: `"Asset"` = `"Asset"`
+
+Asset type.
+
+### AssetCollection
+
+> `readonly` **AssetCollection**: `"AssetCollection"` = `"AssetCollection"`
+
+AssetCollection type.
+
+### Party
+
+> `readonly` **Party**: `"Party"` = `"Party"`
+
+Party type.
+
+### PartyCollection
+
+> `readonly` **PartyCollection**: `"PartyCollection"` = `"PartyCollection"`
+
+PartyCollection type.
+
+### Action
+
+> `readonly` **Action**: `"Action"` = `"Action"`
+
+Action type.
+
+### Rule
+
+> `readonly` **Rule**: `"Rule"` = `"Rule"`
+
+Rule type.
+
+### Permission
+
+> `readonly` **Permission**: `"Permission"` = `"Permission"`
+
+Permission type (subclass of Rule).
+
+### Prohibition
+
+> `readonly` **Prohibition**: `"Prohibition"` = `"Prohibition"`
+
+Prohibition type (subclass of Rule).
+
+### Duty
+
+> `readonly` **Duty**: `"Duty"` = `"Duty"`
+
+Duty type (subclass of Rule).
+
+### Constraint
+
+> `readonly` **Constraint**: `"Constraint"` = `"Constraint"`
+
+Constraint type.
+
+### LogicalConstraint
+
+> `readonly` **LogicalConstraint**: `"LogicalConstraint"` = `"LogicalConstraint"`
+
+LogicalConstraint type.

package/docs/reference/variables/OperatorType.md

@@ -0,0 +1,91 @@
+# Variable: OperatorType
+
+> `const` **OperatorType**: `object`
+
+The types for ODRL Operators.
+
+## Type declaration
+
+### Eq
+
+> `readonly` **Eq**: `"eq"` = `"eq"`
+
+Equal type.
+
+### Gt
+
+> `readonly` **Gt**: `"gt"` = `"gt"`
+
+Greater than type.
+
+### Gteq
+
+> `readonly` **Gteq**: `"gteq"` = `"gteq"`
+
+Greater than or equal to type.
+
+### Lt
+
+> `readonly` **Lt**: `"lt"` = `"lt"`
+
+Less than type.
+
+### Lteq
+
+> `readonly` **Lteq**: `"lteq"` = `"lteq"`
+
+Less than or equal to type.
+
+### Neq
+
+> `readonly` **Neq**: `"neq"` = `"neq"`
+
+Not equal to type.
+
+### IsA
+
+> `readonly` **IsA**: `"isA"` = `"isA"`
+
+Is a type.
+
+### HasPart
+
+> `readonly` **HasPart**: `"hasPart"` = `"hasPart"`
+
+Has part type.
+
+### IsPartOf
+
+> `readonly` **IsPartOf**: `"isPartOf"` = `"isPartOf"`
+
+Is part of type.
+
+### IsAllOf
+
+> `readonly` **IsAllOf**: `"isAllOf"` = `"isAllOf"`
+
+Is all of type.
+
+### IsAnyOf
+
+> `readonly` **IsAnyOf**: `"isAnyOf"` = `"isAnyOf"`
+
+Is any of type.
+
+### IsNoneOf
+
+> `readonly` **IsNoneOf**: `"isNoneOf"` = `"isNoneOf"`
+
+Is none of type.
+
+### LocTimeEq
+
+> `readonly` **LocTimeEq**: `"locTimeEq"` = `"locTimeEq"`
+
+Location time equal to type.
+
+### LocTimeGteq
+
+> `readonly` **LocTimeGteq**: `"locTimeGteq"` = `"locTimeGteq"`
+
+Location time greater than or equal to type.

package/docs/reference/variables/PolicyType.md

@@ -0,0 +1,31 @@
+# Variable: PolicyType
+
+> `const` **PolicyType**: `object`
+
+The types for ODRL Policies.
+
+## Type declaration
+
+### Policy
+
+> `readonly` **Policy**: `"Policy"` = `"Policy"`
+
+Policy type.
+
+### Set
+
+> `readonly` **Set**: `"Set"` = `"Set"`
+
+Set type.
+
+### Offer
+
+> `readonly` **Offer**: `"Offer"` = `"Offer"`
+
+Offer type.
+
+### Agreement
+
+> `readonly` **Agreement**: `"Agreement"` = `"Agreement"`
+
+Agreement type.

package/docs/reference/variables/RightOperandTypes.md

@@ -0,0 +1,13 @@
+# Variable: RightOperandTypes
+
+> `const` **RightOperandTypes**: `object`
+
+Right operand types for ODRL constraints
+
+## Type declaration
+
+### PolicyUsage
+
+> `readonly` **PolicyUsage**: `"odrl:policyUsage"` = `"odrl:policyUsage"`
+
+Reference to policy usage events

package/docs/reference/variables/RuleType.md

@@ -0,0 +1,25 @@
+# Variable: RuleType
+
+> `const` **RuleType**: `object`
+
+The types for ODRL Rules.
+
+## Type declaration
+
+### Permission
+
+> `readonly` **Permission**: `"Permission"` = `"Permission"`
+
+Permission type.
+
+### Prohibition
+
+> `readonly` **Prohibition**: `"Prohibition"` = `"Prohibition"`
+
+Prohibition type.
+
+### Duty
+
+> `readonly` **Duty**: `"Duty"` = `"Duty"`
+
+Duty type.

package/docs/reference/variables/StatusType.md

@@ -0,0 +1,31 @@
+# Variable: StatusType
+
+> `const` **StatusType**: `object`
+
+The types for ODRL Status.
+
+## Type declaration
+
+### Active
+
+> `readonly` **Active**: `"active"` = `"active"`
+
+Active type.
+
+### Inactive
+
+> `readonly` **Inactive**: `"inactive"` = `"inactive"`
+
+Inactive type.
+
+### Pending
+
+> `readonly` **Pending**: `"pending"` = `"pending"`
+
+Pending type.
+
+### Revoked
+
+> `readonly` **Revoked**: `"revoked"` = `"revoked"`
+
+Revoked type.