org.osid.proxy

Interface ProxyProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

ProxyManager, ProxyProxyManager

public interface ProxyProfile
extends OsidProfile

The ProxyProfile describes the interoperability among proxy services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getProxyConditionRecordTypes() Gets the supported ProxyCondition record interface types.
TypeList	getProxyRecordTypes() Gets the supported Proxy record interface types.
boolean	supportsProxy() Tests if a proxy session is supported.
boolean	supportsProxyConditionRecordType(Type proxyConditionRecordType) Tests if the given ProxyCondition record interface type is supported.
boolean	supportsProxyRecordType(Type proxyRecordType) Tests if the given Proxy record interface type is supported.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsProxy

boolean supportsProxy()

Tests if a proxy session is supported.

Returns:

true if proxy is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

getProxyRecordTypes

TypeList getProxyRecordTypes()

Gets the supported Proxy record interface types.

Specified by:

getProxyRecordTypes in interface OsidProfile

Returns:

a list containing the supported Proxy record types

Compliance:

mandatory - This method must be implemented.

supportsProxyRecordType

boolean supportsProxyRecordType(Type proxyRecordType)

Tests if the given Proxy record interface type is supported.

Specified by:

supportsProxyRecordType in interface OsidProfile

Parameters:

proxyRecordType - a Type indicating a Proxy record type

Returns:

true if the given type is supported, false otherwise

Throws:

NullArgumentException - proxyRecordType is null

Compliance:

mandatory - This method must be implemented.

getProxyConditionRecordTypes

TypeList getProxyConditionRecordTypes()

Gets the supported ProxyCondition record interface types.

Returns:

a list containing the supported ProxyCondition record types

Compliance:

mandatory - This method must be implemented.

supportsProxyConditionRecordType

boolean supportsProxyConditionRecordType(Type proxyConditionRecordType)

Tests if the given ProxyCondition record interface type is supported.

Parameters:

proxyConditionRecordType - a Type indicating a ProxyCondition record type

Returns:

true if the given type is supported, false otherwise

Throws:

NullArgumentException - proxyConditionRecordType is null

Compliance:

mandatory - This method must be implemented.