Interface PersonnelBatchProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

PersonnelBatchManager, PersonnelBatchProxyManager

public interface PersonnelBatchProfile
extends OsidProfile

The PersonnelBatchProfile describes the interoperability among batch personnel services.

Method Summary

Modifier and Type	Method	Description
boolean	supportsAppointmentBatchAdmin()	Tests if bulk administration of appointments is available.
boolean	supportsOrganizationBatchAdmin()	Tests if bulk administration of organizations is available.
boolean	supportsPersonBatchAdmin()	Tests if bulk administration of persons is available.
boolean	supportsPositionBatchAdmin()	Tests if bulk administration of positions is available.
boolean	supportsRealmBatchAdmin()	Tests if bulk administration of realms 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.

supportsPersonBatchAdmin

boolean supportsPersonBatchAdmin()

Tests if bulk administration of persons is available.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsOrganizationBatchAdmin

boolean supportsOrganizationBatchAdmin()

Tests if bulk administration of organizations is available.

Returns:

true if an organization bulk administrative service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPositionBatchAdmin

boolean supportsPositionBatchAdmin()

Tests if bulk administration of positions is available.

Returns:

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

Compliance:

mandatory - This method must be implemented.

supportsAppointmentBatchAdmin

boolean supportsAppointmentBatchAdmin()

Tests if bulk administration of appointments is available.

Returns:

true if an appointment bulk administrative service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsRealmBatchAdmin

boolean supportsRealmBatchAdmin()

Tests if bulk administration of realms is available.

Returns:

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

Compliance:

mandatory - This method must be implemented.