Interface IdProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

IdManager, IdProxyManager

public interface IdProfile
extends OsidProfile

The IdProfile describes the interoperability among id services.

Method Summary

Modifier and Type	Method	Description
boolean	supportsIdAdmin()	Tests if an Id administrative service is supported.
boolean	supportsIdBatch()	Tests for the availability of an Id batch service.
boolean	supportsIdIssue()	Tests if an Id issue service is supported.
boolean	supportsIdLookup()	Tests if Id lookup is supported.

Methods inherited from interface OsidProfile

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

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.
TypeList	getProxyRecordTypes()	Gets the proxy record Types 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.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

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

supportsIdLookup

boolean supportsIdLookup()

Tests if Id lookup is supported.

Returns:

true if Id lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIdIssue

boolean supportsIdIssue()

Tests if an Id issue service is supported.

Returns:

true if Id issuing is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIdAdmin

boolean supportsIdAdmin()

Tests if an Id administrative service is supported.

Returns:

true if Id administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIdBatch

boolean supportsIdBatch()

Tests for the availability of an Id batch service.

Returns:

true if an Id batch service is available, false otherwise

Compliance:

mandatory - This method must be implemented.