org.osid.repository.rules

Interface RepositoryRulesManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, RepositoryRulesProfile, Sourceable

public interface RepositoryRulesManager
extends OsidManager, RepositoryRulesProfile

The repository rules manager provides access to repository rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• CompositionEnablerLookupSession: a session to retrieve composition enablers
• CompositionEnablerQuerySession: a session to query for composition enablers
• CompositionEnablerSearchSession: a session to search for composition enablers
• CompositionEnablerAdminSession: a session to create and delete composition enablers
• CompositionEnablerNotificationSession: a session to receive notifications pertaining to composition enabler changes
• CompositionEnablerRepositorySession: a session to look up composition enabler repository mappings
• CompositionEnablerRepositoryAssignmentSession: a session to manage composition enabler to repository mappings
• CompositionEnablerSmartRepositorySession: a session to manage dynamic repositories of composition enablers
• CompositionEnablerRuleLookupSession: a session to look up composition enabler to composition mappings
• CompositionEnablerRuleApplicationSession: a session to apply composition enablers to compositions

Method Summary

Methods

Modifier and Type	Method and Description
CompositionEnablerAdminSession	getCompositionEnablerAdminSession() Gets the OsidSession associated with the composition enabler administration service.
CompositionEnablerAdminSession	getCompositionEnablerAdminSessionForRepository(Id repositoryId) Gets the OsidSession associated with the composition enabler administration service for the given repository.
CompositionEnablerLookupSession	getCompositionEnablerLookupSession() Gets the OsidSession associated with the composition enabler lookup service.
CompositionEnablerLookupSession	getCompositionEnablerLookupSessionForRepository(Id repositoryId) Gets the OsidSession associated with the composition enabler lookup service for the given repository.
CompositionEnablerNotificationSession	getCompositionEnablerNotificationSession(CompositionEnablerReceiver compositionEnablerReceiver) Gets the OsidSession associated with the composition enabler notification service.
CompositionEnablerNotificationSession	getCompositionEnablerNotificationSessionForRepository(CompositionEnablerReceiver compositionEnablerReceiver, Id repositoryId) Gets the OsidSession associated with the composition enabler notification service for the given repository.
CompositionEnablerQuerySession	getCompositionEnablerQuerySession() Gets the OsidSession associated with the composition enabler query service.
CompositionEnablerQuerySession	getCompositionEnablerQuerySessionForRepository(Id repositoryId) Gets the OsidSession associated with the composition enabler query service for the given repository.
CompositionEnablerRepositoryAssignmentSession	getCompositionEnablerRepositoryAssignmentSession() Gets the OsidSession associated with assigning composition enablers to repositories.
CompositionEnablerRepositorySession	getCompositionEnablerRepositorySession() Gets the OsidSession to lookup composition enabler repository mappings for composition enablers.
CompositionEnablerRuleApplicationSession	getCompositionEnablerRuleApplicationSession() Gets the OsidSession associated with the composition enabler assignment service to apply enablers to compositions.
CompositionEnablerRuleApplicationSession	getCompositionEnablerRuleApplicationSessionForRepository(Id repositoryId) Gets the OsidSession associated with the composition enabler assignment service for the given composition to apply enablers to compositions.
CompositionEnablerRuleLookupSession	getCompositionEnablerRuleLookupSession() Gets the OsidSession associated with the composition enabler mapping lookup service for looking up the rules applied to a composition.
CompositionEnablerRuleLookupSession	getCompositionEnablerRuleLookupSessionForRepository(Id repositoryId) Gets the OsidSession associated with the composition enabler mapping lookup service for the given composition for looking up rules applied to a composition.
CompositionEnablerSearchSession	getCompositionEnablerSearchSession() Gets the OsidSession associated with the composition enabler search service.
CompositionEnablerSearchSession	getCompositionEnablerSearchSessionForRepository(Id repositoryId) Gets the OsidSession associated with the composition enablers earch service for the given repository.
CompositionEnablerSmartRepositorySession	getCompositionEnablerSmartRepositorySession(Id repositoryId) Gets the OsidSession to manage composition enabler smart repositories.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.repository.rules.RepositoryRulesProfile

getCompositionEnablerRecordTypes, getCompositionEnablerSearchRecordTypes, supportsCompositionEnablerAdmin, supportsCompositionEnablerLookup, supportsCompositionEnablerNotification, supportsCompositionEnablerQuery, supportsCompositionEnablerRecordType, supportsCompositionEnablerRepository, supportsCompositionEnablerRepositoryAssignment, supportsCompositionEnablerRuleApplication, supportsCompositionEnablerRuleLookup, supportsCompositionEnablerSearch, supportsCompositionEnablerSearchRecordType, supportsCompositionEnablerSmartRepository, supportsVisibleFederation

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

getCompositionEnablerLookupSession

CompositionEnablerLookupSession getCompositionEnablerLookupSession()
                                                                   throws OperationFailedException

Gets the OsidSession associated with the composition enabler lookup service.

Returns:

a CompositionEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerLookup() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerLookup() is true.

getCompositionEnablerLookupSessionForRepository

CompositionEnablerLookupSession getCompositionEnablerLookupSessionForRepository(Id repositoryId)
                                                                                throws NotFoundException,
                                                                                       OperationFailedException

Gets the OsidSession associated with the composition enabler lookup service for the given repository.

Parameters:

repositoryId - the Id of the Repository

Returns:

a CompositionEnablerLookupSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerLookup() and supportsVisibleFederation() are true.

getCompositionEnablerQuerySession

CompositionEnablerQuerySession getCompositionEnablerQuerySession()
                                                                 throws OperationFailedException

Gets the OsidSession associated with the composition enabler query service.

Returns:

a CompositionEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerQuery() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerQuery() is true.

getCompositionEnablerQuerySessionForRepository

CompositionEnablerQuerySession getCompositionEnablerQuerySessionForRepository(Id repositoryId)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

Gets the OsidSession associated with the composition enabler query service for the given repository.

Parameters:

repositoryId - the Id of the Repository

Returns:

a CompositionEnablerQuerySession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerQuery() and supportsVisibleFederation() are true.

getCompositionEnablerSearchSession

CompositionEnablerSearchSession getCompositionEnablerSearchSession()
                                                                   throws OperationFailedException

Gets the OsidSession associated with the composition enabler search service.

Returns:

a CompositionEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerSearch() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerSearch() is true.

getCompositionEnablerSearchSessionForRepository

CompositionEnablerSearchSession getCompositionEnablerSearchSessionForRepository(Id repositoryId)
                                                                                throws NotFoundException,
                                                                                       OperationFailedException

Gets the OsidSession associated with the composition enablers earch service for the given repository.

Parameters:

repositoryId - the Id of the Repository

Returns:

a CompositionEnablerSearchSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerSearch() and supportsVisibleFederation() are true.

getCompositionEnablerAdminSession

CompositionEnablerAdminSession getCompositionEnablerAdminSession()
                                                                 throws OperationFailedException

Gets the OsidSession associated with the composition enabler administration service.

Returns:

a CompositionEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerAdmin() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerAdmin() is true.

getCompositionEnablerAdminSessionForRepository

CompositionEnablerAdminSession getCompositionEnablerAdminSessionForRepository(Id repositoryId)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

Gets the OsidSession associated with the composition enabler administration service for the given repository.

Parameters:

repositoryId - the Id of the Repository

Returns:

a CompositionEnablerAdminSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerAdmin() and supportsVisibleFederation() are true.

getCompositionEnablerNotificationSession

CompositionEnablerNotificationSession getCompositionEnablerNotificationSession(CompositionEnablerReceiver compositionEnablerReceiver)
                                                                               throws OperationFailedException

Gets the OsidSession associated with the composition enabler notification service.

Parameters:

compositionEnablerReceiver - the notification callback

Returns:

a CompositionEnablerNotificationSession

Throws:

NullArgumentException - compositionEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerNotification() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerNotification() is true.

getCompositionEnablerNotificationSessionForRepository

CompositionEnablerNotificationSession getCompositionEnablerNotificationSessionForRepository(CompositionEnablerReceiver compositionEnablerReceiver,
                                                                                          Id repositoryId)
                                                                                            throws NotFoundException,
                                                                                                   OperationFailedException

Gets the OsidSession associated with the composition enabler notification service for the given repository.

Parameters:

compositionEnablerReceiver - the notification callback

repositoryId - the Id of the Repository

Returns:

a CompositionEnablerNotificationSession

Throws:

NotFoundException - no repository found by the given Id

NullArgumentException - compositionEnablerReceiver or repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerNotification() and supportsVisibleFederation() are true.

getCompositionEnablerRepositorySession

CompositionEnablerRepositorySession getCompositionEnablerRepositorySession()
                                                                           throws OperationFailedException

Gets the OsidSession to lookup composition enabler repository mappings for composition enablers.

Returns:

a CompositionEnablerCompositionSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerRepository() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerRepository() is true.

getCompositionEnablerRepositoryAssignmentSession

CompositionEnablerRepositoryAssignmentSession getCompositionEnablerRepositoryAssignmentSession()
                                                                                               throws OperationFailedException

Gets the OsidSession associated with assigning composition enablers to repositories.

Returns:

a CompositionEnablerRepositoryAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerCompositionAssignment() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerRepositoryAssignment() is true.

getCompositionEnablerSmartRepositorySession

CompositionEnablerSmartRepositorySession getCompositionEnablerSmartRepositorySession(Id repositoryId)
                                                                                     throws NotFoundException,
                                                                                            OperationFailedException

Gets the OsidSession to manage composition enabler smart repositories.

Parameters:

repositoryId - the Id of the Repository

Returns:

a CompositionEnablerSmartRepositorySession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerSmartRepository() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerSmartRepository() is true.

getCompositionEnablerRuleLookupSession

CompositionEnablerRuleLookupSession getCompositionEnablerRuleLookupSession()
                                                                           throws OperationFailedException

Gets the OsidSession associated with the composition enabler mapping lookup service for looking up the rules applied to a composition.

Returns:

a CompositionEnablerRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerRuleLookup() is true.

getCompositionEnablerRuleLookupSessionForRepository

CompositionEnablerRuleLookupSession getCompositionEnablerRuleLookupSessionForRepository(Id repositoryId)
                                                                                        throws NotFoundException,
                                                                                               OperationFailedException

Gets the OsidSession associated with the composition enabler mapping lookup service for the given composition for looking up rules applied to a composition.

Parameters:

repositoryId - the Id of the Repository

Returns:

a CompositionEnablerRuleLookupSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerRuleLookup() and supportsVisibleFederation() are true.

getCompositionEnablerRuleApplicationSession

CompositionEnablerRuleApplicationSession getCompositionEnablerRuleApplicationSession()
                                                                                     throws OperationFailedException

Gets the OsidSession associated with the composition enabler assignment service to apply enablers to compositions.

Returns:

a CompositionEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerRuleApplication() is true.

getCompositionEnablerRuleApplicationSessionForRepository

CompositionEnablerRuleApplicationSession getCompositionEnablerRuleApplicationSessionForRepository(Id repositoryId)
                                                                                                  throws NotFoundException,
                                                                                                         OperationFailedException

Gets the OsidSession associated with the composition enabler assignment service for the given composition to apply enablers to compositions.

Parameters:

repositoryId - the Id of the Repository

Returns:

a CompositionEnablerRuleApplicationSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCompositionEnablerRuleApplication() and supportsVisibleFederation() are true.