org.osid.checklist.mason

Interface ChecklistMasonProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

ChecklistMasonManager, ChecklistMasonProxyManager

public interface ChecklistMasonProfile
extends OsidProfile

The checklist mason profile describes the interoperability among checklist mason services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getTodoProducerRecordTypes() Gets the supported TodoProducer record types.
TypeList	getTodoProducerSearchRecordTypes() Gets the supported TodoProducer search record types.
boolean	supportsTodoProducerAdmin() Tests if a todo producer administrative service is supported.
boolean	supportsTodoProducerChecklist() Tests if a todo producer checklist lookup service is supported.
boolean	supportsTodoProducerChecklistAssignment() Tests if a todo producer checklist service is supported.
boolean	supportsTodoProducerLookup() Tests if looking up todo producers is supported.
boolean	supportsTodoProducerNotification() Tests if a todo producer notification service is supported.
boolean	supportsTodoProducerQuery() Tests if querying todo producers is supported.
boolean	supportsTodoProducerRecordType(Type todoProducerRecordType) Tests if the given TodoProducer record type is supported.
boolean	supportsTodoProducerSearch() Tests if searching todo producers is supported.
boolean	supportsTodoProducerSearchRecordType(Type todoProducerSearchRecordType) Tests if the given TodoProducer search record type is supported.
boolean	supportsTodoProducerSmartChecklist() Tests if a todo producer checklist lookup service is supported.
boolean	supportsVisibleFederation() Tests if any broker federation is exposed.

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if any broker federation is exposed. Federation is exposed when a specific broker may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of brokers appears as a single broker.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTodoProducerLookup

boolean supportsTodoProducerLookup()

Tests if looking up todo producers is supported.

Returns:

true if todo producer lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTodoProducerQuery

boolean supportsTodoProducerQuery()

Tests if querying todo producers is supported.

Returns:

true if todo producer query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTodoProducerSearch

boolean supportsTodoProducerSearch()

Tests if searching todo producers is supported.

Returns:

true if todo producer search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTodoProducerAdmin

boolean supportsTodoProducerAdmin()

Tests if a todo producer administrative service is supported.

Returns:

true if todo producer administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTodoProducerNotification

boolean supportsTodoProducerNotification()

Tests if a todo producer notification service is supported.

Returns:

true if todo producer notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTodoProducerChecklist

boolean supportsTodoProducerChecklist()

Tests if a todo producer checklist lookup service is supported.

Returns:

true if a todo producer checklist lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTodoProducerChecklistAssignment

boolean supportsTodoProducerChecklistAssignment()

Tests if a todo producer checklist service is supported.

Returns:

true if todo producer checklist assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTodoProducerSmartChecklist

boolean supportsTodoProducerSmartChecklist()

Tests if a todo producer checklist lookup service is supported.

Returns:

true if a todo producer checklist service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getTodoProducerRecordTypes

TypeList getTodoProducerRecordTypes()

Gets the supported TodoProducer record types.

Returns:

a list containing the supported TodoProducer record types

Compliance:

mandatory - This method must be implemented.

supportsTodoProducerRecordType

boolean supportsTodoProducerRecordType(Type todoProducerRecordType)

Tests if the given TodoProducer record type is supported.

Parameters:

todoProducerRecordType - a Type indicating a TodoProducer record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - todoProducerRecordType is null

Compliance:

mandatory - This method must be implemented.

getTodoProducerSearchRecordTypes

TypeList getTodoProducerSearchRecordTypes()

Gets the supported TodoProducer search record types.

Returns:

a list containing the supported TodoProducer search record types

Compliance:

mandatory - This method must be implemented.

supportsTodoProducerSearchRecordType

boolean supportsTodoProducerSearchRecordType(Type todoProducerSearchRecordType)

Tests if the given TodoProducer search record type is supported.

Parameters:

todoProducerSearchRecordType - a Type indicating a TodoProducer search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - todoProducerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.