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

Modifier and Type	Method	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 OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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.