Path
Osid Relationship
Aggregateable
A Path represents a means between two
nodes.
| 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 |
|---|---|---|---|
startingNodeId |
id | the starting node Id |
|
startingNode |
Node | the starting node | |
endingNodeId |
id | the ending node Id |
|
endingNode |
Node | the ending node | |
isComplete |
boolean | true if the path is complete, false otherwise |
|
isClosed |
boolean | true if the path is closed, false otherwise |
|
hops |
cardinal | the total path hops | |
distance |
decimal | the total path distance | |
cost |
decimal | the total path cost | |
edgeIds |
id | ⋆ | the edge Ids |
edges |
Edge | ⋆ | the edges |