org.osid.proxy

Interface ProxyCondition

All Superinterfaces:

Extensible, OsidCondition, Suppliable

public interface ProxyCondition
extends OsidCondition

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

Method Summary

Methods

Modifier and Type	Method and Description
ProxyConditionRecord	getProxyConditionRecord(Type proxyConditionType) Gets the proxy condition record corresponding to the given Proxy record Type.
void	setCalendarType(Type calendarType) Sets the calendar type.
void	setCurrencyType(Type currencyType) Sets the currency type.
void	setEffectiveAgentId(Id agentId) Sets the effective agent Id to indicate acting on behalf of.
void	setEffectiveDate(java.util.Date date, java.math.BigDecimal rate) Sets the effective date.
void	setFormatType(Type formatType) Sets the DisplayText format type.
void	setLanguageType(Type languageType) Sets the language type.
void	setScriptType(Type scriptType) Sets the script type.
void	setTimeType(Type timeType) Sets the time type.
void	setUnitSystemType(Type unitSystemType) Sets the unit system type.

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

setEffectiveAgentId

void setEffectiveAgentId(Id agentId)

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

Parameters:

agentId - an agent Id

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

setEffectiveDate

void setEffectiveDate(java.util.Date date,
                    java.math.BigDecimal rate)

Sets the effective date.

Parameters:

date - a date

rate - the rate at which the clock should tick from the given effective date. 0 is a clock that is fixed

Throws:

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

setLanguageType

void setLanguageType(Type languageType)

Sets the language type.

Parameters:

languageType - the language type

Throws:

NullArgumentException - languageType is null

Compliance:

mandatory - This method must be implemented.

setScriptType

void setScriptType(Type scriptType)

Sets the script type.

Parameters:

scriptType - the script type

Throws:

NullArgumentException - scriptType is null

Compliance:

mandatory - This method must be implemented.

setCalendarType

void setCalendarType(Type calendarType)

Sets the calendar type.

Parameters:

calendarType - the calendar type

Throws:

NullArgumentException - calendarType is null

Compliance:

mandatory - This method must be implemented.

setTimeType

void setTimeType(Type timeType)

Sets the time type.

Parameters:

timeType - the time type

Throws:

NullArgumentException - timeType is null

Compliance:

mandatory - This method must be implemented.

setCurrencyType

void setCurrencyType(Type currencyType)

Sets the currency type.

Parameters:

currencyType - the currency type

Throws:

NullArgumentException - currencyType is null

Compliance:

mandatory - This method must be implemented.

setUnitSystemType

void setUnitSystemType(Type unitSystemType)

Sets the unit system type.

Parameters:

unitSystemType - the unit system type

Throws:

NullArgumentException - unitSystemType is null

Compliance:

mandatory - This method must be implemented.

setFormatType

void setFormatType(Type formatType)

Sets the DisplayText format type.

Parameters:

formatType - the format type

Throws:

NullArgumentException - formatType is null

Compliance:

mandatory - This method must be implemented.

getProxyConditionRecord

ProxyConditionRecord getProxyConditionRecord(Type proxyConditionType)
                                             throws OperationFailedException

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 .

Parameters:

proxyConditionType - the type of proxy condition record to retrieve

Returns:

the proxy condition record

Throws:

NullArgumentException - proxyConditionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(proxyConditionRecordType) is false

Compliance:

mandatory - This method must be implemented.