org.osid.proxy

Interface Proxy

All Superinterfaces:

Browsable, Extensible, OsidResult

public interface Proxy
extends OsidResult

A Proxy is used to transfer external information from an application server into an OSID Provider.

Method Summary

Methods

Modifier and Type	Method and Description
Authentication	getAuthentication() Gets the Authentication for this proxy.
Agent	getEffectiveAgent() Gets the effective Agent for this proxy.
Id	getEffectiveAgentId() Gets the effective Agent Id for this proxy.
java.math.BigDecimal	getEffectiveClockRate() Gets the rate of the clock.
java.util.Date	getEffectiveDate() Gets the effective date.
Type	getFormatType() Gets the DisplayText format Type.
Locale	getLocale() Gets the locale.
ProxyRecord	getProxyRecord(Type proxyRecordType) Gets the proxy record corresponding to the given Proxy record Type.
boolean	hasAuthentication() Tests if an authentication is available.
boolean	hasEffectiveAgent() Tests if an effective agent is available.
boolean	hasEffectiveDate() Tests if an effective date is available.
boolean	hasFormatType() Tests if a DisplayText format Type is available.

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

hasAuthentication

boolean hasAuthentication()

Tests if an authentication is available.

Returns:

true if an Authentication is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAuthentication

Authentication getAuthentication()

Gets the Authentication for this proxy.

Returns:

the authentication

Throws:

IllegalStateException - hasAuthentication() is false

Compliance:

mandatory - This method must be implemented.

hasEffectiveAgent

boolean hasEffectiveAgent()

Tests if an effective agent is available.

Returns:

true if an effective agent is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEffectiveAgentId

Id getEffectiveAgentId()

Gets the effective Agent Id for this proxy.

Returns:

the effective agent Id

Throws:

IllegalStateException - hasEffectiveAgent() is false

Compliance:

mandatory - This method must be implemented.

getEffectiveAgent

Agent getEffectiveAgent()
                        throws OperationFailedException

Gets the effective Agent for this proxy.

Returns:

the effective agent

Throws:

IllegalStateException - hasEffectiveAgent() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasEffectiveDate

boolean hasEffectiveDate()

Tests if an effective date is available.

Returns:

true if an effective date is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEffectiveDate

java.util.Date getEffectiveDate()

Gets the effective date.

Returns:

the effective date

Throws:

IllegalStateException - hasEffectiveDate() is false

Compliance:

mandatory - This method must be implemented.

getEffectiveClockRate

java.math.BigDecimal getEffectiveClockRate()

Gets the rate of the clock.

Returns:

the rate

Throws:

IllegalStateException - hasEffectiveDate() is false

Compliance:

mandatory - This method must be implemented.

getLocale

Locale getLocale()

Gets the locale.

Returns:

a locale

Compliance:

mandatory - This method must be implemented.

hasFormatType

boolean hasFormatType()

Tests if a DisplayText format Type is available.

Returns:

true if a format type is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFormatType

Type getFormatType()

Gets the DisplayText format Type.

Returns:

the format Type

Throws:

IllegalStateException - hasFormatType() is false

Compliance:

mandatory - This method must be implemented.

getProxyRecord

ProxyRecord getProxyRecord(Type proxyRecordType)
                           throws OperationFailedException

Gets the proxy 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:

proxyRecordType - the type of proxy record to retrieve

Returns:

the proxy record

Throws:

NullArgumentException - proxyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(proxyRecordType) is false

Compliance:

mandatory - This method must be implemented.