OSID Logo
OSID Specifications
proxy package
Version 3.0.0
Release Candidate Preview
Interfaceosid.proxy.ProxyCondition
Implementsosid.OsidCondition
Description

A ProxyCondition is used to transfer external information into a proxy.

MethodsetEffectiveAgentId
Description

Sets the effective agent Id to indicate acting on behalf of.

Parametersosid.id.IdagentIdan agent Id
ErrorsNULL_ARGUMENT agentId is null
CompliancemandatoryThis method must be implemented.
MethodsetEffectiveDate
Description

Sets the effective date.

Parameterstimestampdatea date
decimalratethe rate at which the clock should tick from the given effective date. 0 is a clock that is fixed
ErrorsNULL_ARGUMENT date is null
CompliancemandatoryThis method must be implemented.
MethodsetLanguageType
Description

Sets the language type.

Parametersosid.type.TypelanguageTypethe language type
ErrorsNULL_ARGUMENT languageType is null
CompliancemandatoryThis method must be implemented.
MethodsetScriptType
Description

Sets the script type.

Parametersosid.type.TypescriptTypethe script type
ErrorsNULL_ARGUMENT scriptType is null
CompliancemandatoryThis method must be implemented.
MethodsetCalendarType
Description

Sets the calendar type.

Parametersosid.type.TypecalendarTypethe calendar type
ErrorsNULL_ARGUMENT calendarType is null
CompliancemandatoryThis method must be implemented.
MethodsetTimeType
Description

Sets the time type.

Parametersosid.type.TypetimeTypethe time type
ErrorsNULL_ARGUMENT timeType is null
CompliancemandatoryThis method must be implemented.
MethodsetCurrencyType
Description

Sets the currency type.

Parametersosid.type.TypecurrencyTypethe currency type
ErrorsNULL_ARGUMENT currencyType is null
CompliancemandatoryThis method must be implemented.
MethodsetUnitSystemType
Description

Sets the unit system type.

Parametersosid.type.TypeunitSystemTypethe unit system type
ErrorsNULL_ARGUMENT unitSystemType is null
CompliancemandatoryThis method must be implemented.
MethodsetFormatType
Description

Sets the DisplayText format type.

Parametersosid.type.TypeformatTypethe format type
ErrorsNULL_ARGUMENT formatType is null
CompliancemandatoryThis method must be implemented.
MethodgetProxyConditionRecord
Description

Gets the proxy condition record corresponding to the given Proxy record Type. This method is used to retrieve an object implementing the requested record. The proxyRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(proxyRecordType) is true .

Parametersosid.type.TypeproxyConditionTypethe type of proxy condition record to retrieve
Returnosid.proxy.records.ProxyConditionRecordthe proxy condition record
ErrorsNULL_ARGUMENT proxyConditionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(proxyConditionRecordType) is false
CompliancemandatoryThis method must be implemented.