OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.AssetTemporalAssignmentSession
Implementsosid.OsidSession
Description

This session defines methods to manage temporal coverage of an asset.

MethodgetRepositoryId
Description

Gets the Repository Id associated with this session.

Returnosid.id.Idthe Repository Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetRepository
Description

Gets the Repository associated with this session.

Returnosid.repository.Repositorythe Repository associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignTemporalCoverage
Description

Tests if this user can manage temporal lookups. 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 opt not to offer assignment operations.

Returnboolean false if temporal management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddTemporalCoverage
Description

Adds a temporal coverage to this asset expressed as a range between two date/times.

Parametersosid.id.IdassetId Id of the Asset
osid.calendaring.DateTimebeginstart date/time
osid.calendaring.DateTimeendend date/time
ErrorsALREADY_EXISTSinterval already exists
INVALID_ARGUMENT begin is greater than end
NOT_FOUND assetId not found
NULL_ARGUMENT assetId, begin or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization fauilure
CompliancemandatoryThis method must be implemented.
MethodremoveTemporalCoverage
Description

Removes a temporal range from an asset.

Parametersosid.id.IdassetId Id of the Asset
osid.calendaring.DateTimebeginstart date/time
osid.calendaring.DateTimeendend date/time
ErrorsNOT_FOUND assetId with begin and end not found
NULL_ARGUMENT assetId, begin or end is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization fauilure
CompliancemandatoryThis method must be implemented.