Interface RelationshipBatchProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

RelationshipBatchManager, RelationshipBatchProxyManager

public interface RelationshipBatchProfile
extends OsidProfile

The RelationshipBatchProfile describes the interoperability among relationship batch services.

Method Summary

Modifier and Type	Method	Description
boolean	supportsFamilyBatchAdmin()	Tests if bulk administration of family is available.
boolean	supportsRelationshipBatchAdmin()	Tests if bulk administration of relationships is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.

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

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if federation is visible.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRelationshipBatchAdmin

boolean supportsRelationshipBatchAdmin()

Tests if bulk administration of relationships is available.

Returns:

true if a relationship bulk administrative service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFamilyBatchAdmin

boolean supportsFamilyBatchAdmin()

Tests if bulk administration of family is available.

Returns:

true if a family bulk administrative service is available, false otherwise

Compliance:

mandatory - This method must be implemented.