OSID Logo
OSID Specifications
proxy package
Version 3.1.0
Interfaceosid.proxy.ProxyCondition
Implementsosid.OsidCondition
Used Byosid.OsidProxyManager
osid.proxy.ProxySession
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.IdagentId an agent Id
ErrorsNULL_ARGUMENT agentId is null
Compliancemandatory This method must be implemented.
MethodsetEffectiveDate
Description

Sets the effective date.

Parameterstimestampdate the requested effective date
ErrorsNULL_ARGUMENT date is null
Compliancemandatory This method must be implemented.
MethodsetEffectiveClockRate
Description

Sets the preferred clock rate.

Parametersdecimalrate the rate at which the clock should tick from the given effective date. 0 is a clock that is fixed
ErrorsNULL_ARGUMENT rate is null
Compliancemandatory This method must be implemented.
MethodsetLocales
Description

Sets the preferred Locales.

Parametersosid.locale.Locale[]languageType the preferred Locales
ErrorsNULL_ARGUMENT locales is null
Compliancemandatory This method must be implemented.
MethodsetFormatTypes
Description

Sets the preferred DisplayText format types.

Parametersosid.type.Type[]formatTypes the preferred format types
ErrorsNULL_ARGUMENT formatTypes is null
Compliancemandatory This 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.TypeproxyConditionType the type of proxy condition record to retrieve
Returnosid.proxy.records.ProxyConditionRecord the proxy condition record
ErrorsNULL_ARGUMENT proxyConditionRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(proxyConditionRecordType) is false
Compliancemandatory This method must be implemented.