OSID - osid.proxy.Proxy Service Interface Definition

Interface	osid.proxy.Proxy
Implements	`osid.OsidResult`
Description	A `Proxy` is used to transfer external information from an application server into an OSID Provider.
Method	hasAuthentication
Description	Tests if an authentication is available.
Return	`boolean`		`true` if an `Authentication` is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAuthentication
Description	Gets the `Authentication` for this proxy.
Return	`osid.authentication.process.Authentication`		the authentication
Errors	ILLEGAL_STATE		`hasAuthentication()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasEffectiveAgent
Description	Tests if an effective agent is available.
Return	`boolean`		`true` if an effective agent is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEffectiveAgentId
Description	Gets the effective `Agent Id` for this proxy.
Return	`osid.id.Id`		the effective agent `Id`
Errors	ILLEGAL_STATE		`hasEffectiveAgent()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getEffectiveAgent
Description	Gets the effective `Agent` for this proxy.
Return	`osid.authentication.Agent`		the effective agent
Errors	ILLEGAL_STATE		`hasEffectiveAgent()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasEffectiveDate
Description	Tests if an effective date is available.
Return	`boolean`		`true` if an effective date is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEffectiveDate
Description	Gets the effective date.
Return	`timestamp`		the effective date
Errors	ILLEGAL_STATE		`hasEffectiveDate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getEffectiveClockRate
Description	Gets the rate of the clock.
Return	`decimal`		the rate
Errors	ILLEGAL_STATE		`hasEffectiveDate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getLocale
Description	Gets the locale.
Return	`osid.locale.Locale`		a locale
Compliance	`mandatory`		This method must be implemented.
Method	hasFormatType
Description	Tests if a `DisplayText` format `Type` is available.
Return	`boolean`		`true` if a format type is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFormatType
Description	Gets the `DisplayText` format `Type.`
Return	`osid.type.Type`		the format `Type`
Errors	ILLEGAL_STATE		`hasFormatType()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getProxyRecord
Description	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	`osid.type.Type`	`proxyRecordType`	the type of proxy record to retrieve
Return	`osid.proxy.records.ProxyRecord`		the proxy record
Errors	NULL_ARGUMENT		`proxyRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(proxyRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.