OSID - osid.mapping.path.ResourceVelocitySession Service Interface Definition

Interface	osid.mapping.path.ResourceVelocitySession
Implements	`osid.OsidSession`
Description	This session defines methods to look up resources on paths.
Method	getMapId
Description	Gets the `Map` `Id` associated with this session.
Return	`osid.id.Id`		the `Map Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMap
Description	Gets the `Map` associated with this session.
Return	`osid.mapping.Map`		the map
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAccessResourcePaths
Description	Tests if this user can access the velocities of resources. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not offer location operations to unauthorized users.
Return	`boolean`		`false` if velocity methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeResourcePathView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryResourcePathView
Description	A complete view of the `Path` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedMapView
Description	Federates the view for methods in this session. A federated view will include paths in maps which are children of this map in the map hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedMapView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this map only.
Compliance	`mandatory`		This method is must be implemented.
Method	getResourceVelocity
Description	Gets the current velocity of the given resource.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.mapping.path.ResourceVelocity`		the current velocity
Errors	NOT_FOUND		`resourceId` is not on map
	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	geResourceVelociiesForResource
Description	Gets the current velocities of the given resources. In plenary mode, the returned list contains all of the velocities of the supplied resources or an error results. In comparative mode, inaccessible resources may be omitted or duplicates suppressed or reordered.
Parameters	`osid.id.IdList`	`resourceIds`	a resource list
Return	`osid.mapping.path.ResourceVelocityList`		the current velocities
Errors	NOT_FOUND		a resource `Id` is not on map
	NULL_ARGUMENT		`resourceIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceVelocitiesByGenusType
Description	Gets the current velocities for a resource genus type. In plenary mode, the returned list contains all of the velocities of the supplied resources or an error results. In comparative mode, inaccessible resources may be omitted or duplicates suppressed or reordered.
Parameters	`osid.id.Id`	`pathId`	a path `Id`
Return	`osid.mapping.path.ResourceVelocityList`		the resource velocities
Errors	NOT_FOUND		`pathId` not found
	NULL_ARGUMENT		`pathId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceVelocitiesOnPath
Description	Gets the current resource velocities on a given path. In plenary mode, the returned list contains all of the velocities of the supplied resources or an error results. In comparative mode, inaccessible resources may be omitted or duplicates suppressed or reordered.
Parameters	`osid.id.Id`	`pathId`	a path `Id`
Return	`osid.mapping.path.ResourceVelocityList`		the resource velocities
Errors	NULL_ARGUMENT		`pathId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceVelocitiesOnPathByGenusType
Description	Gets the current velocities on a given path for a resource genus type. In plenary mode, the returned list contains all of the velocities of the supplied resources or an error results. In comparative mode, inaccessible resources may be omitted or duplicates suppressed or reordered.
Parameters	`osid.id.Id`	`pathId`	a path `Id`
Parameters	`osid.type.Type`	`resourceGenusType`	a resource genus type
Return	`osid.mapping.path.ResourceVelocityList`		the resource velocities
Errors	NOT_FOUND		`pathId` not found
	NULL_ARGUMENT		`pathId` or `resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getResourceVelocitiesInSpatialUnit
Description	Gets the current velocities for given resources in the given spatial unit.
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	a spatial unit
Return	`osid.mapping.path.ResourceVelocityList`		the current velocities
Errors	NULL_ARGUMENT		`spatialUnit` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		spatial unit not supported
Compliance	`mandatory`		This method must be implemented.
Method	getResourceVelocitiesInSpatialUnitByGenusType
Description	Gets the current velocities on a given path for a resource genus type. In plenary mode, the returned list contains all of the velocities of the supplied resources or an error results. In comparative mode, inaccessible resources may be omitted or duplicates suppressed or reordered.
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	a spatial unit
Parameters	`osid.type.Type`	`resourceGenusType`	a resource genus type
Return	`osid.mapping.path.ResourceVelocityList`		the resource velocities
Errors	NULL_ARGUMENT		`spatialUnit` or `resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		spatial unit not supported
Compliance	`mandatory`		This method must be implemented.