OSID Logo
OSID Specifications
repository rules package
Version 3.1.0
Interfaceosid.repository.rules.RepositoryRulesManager
Implementsosid.OsidManager
osid.repository.rules.RepositoryRulesProfile
Used Byosid.repository.RepositoryManager
Description

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
MethodgetCompositionEnablerLookupSession
Description

Gets the OsidSession associated with the composition enabler lookup service.

Returnosid.repository.rules.CompositionEnablerLookupSession a CompositionEnablerLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerLookup() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerLookup() is true.
MethodgetCompositionEnablerLookupSessionForRepository
Description

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

Parametersosid.id.IdrepositoryId the Id of the Repository
Returnosid.repository.rules.CompositionEnablerLookupSession a CompositionEnablerLookupSession
ErrorsNOT_FOUND no Repository found by the given Id
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerLookup() and supportsVisibleFederation() are true.
MethodgetCompositionEnablerQuerySession
Description

Gets the OsidSession associated with the composition enabler query service.

Returnosid.repository.rules.CompositionEnablerQuerySession a CompositionEnablerQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerQuery() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerQuery() is true.
MethodgetCompositionEnablerQuerySessionForRepository
Description

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

Parametersosid.id.IdrepositoryId the Id of the Repository
Returnosid.repository.rules.CompositionEnablerQuerySession a CompositionEnablerQuerySession
ErrorsNOT_FOUND no Repository found by the given Id
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerQuery() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerQuery() and supportsVisibleFederation() are true.
MethodgetCompositionEnablerSearchSession
Description

Gets the OsidSession associated with the composition enabler search service.

Returnosid.repository.rules.CompositionEnablerSearchSession a CompositionEnablerSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerSearch() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerSearch() is true.
MethodgetCompositionEnablerSearchSessionForRepository
Description

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

Parametersosid.id.IdrepositoryId the Id of the Repository
Returnosid.repository.rules.CompositionEnablerSearchSession a CompositionEnablerSearchSession
ErrorsNOT_FOUND no Repository found by the given Id
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerSearch() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerSearch() and supportsVisibleFederation() are true.
MethodgetCompositionEnablerAdminSession
Description

Gets the OsidSession associated with the composition enabler administration service.

Returnosid.repository.rules.CompositionEnablerAdminSession a CompositionEnablerAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerAdmin() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerAdmin() is true.
MethodgetCompositionEnablerAdminSessionForRepository
Description

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

Parametersosid.id.IdrepositoryId the Id of the Repository
Returnosid.repository.rules.CompositionEnablerAdminSession a CompositionEnablerAdminSession
ErrorsNOT_FOUND no Repository found by the given Id
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetCompositionEnablerNotificationSession
Description

Gets the OsidSession associated with the composition enabler notification service.

Parametersosid.repository.rules.CompositionEnablerReceivercompositionEnablerReceiver the notification callback
Returnosid.repository.rules.CompositionEnablerNotificationSession a CompositionEnablerNotificationSession
ErrorsNULL_ARGUMENT compositionEnablerReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerNotification() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerNotification() is true.
MethodgetCompositionEnablerNotificationSessionForRepository
Description

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

Parametersosid.repository.rules.CompositionEnablerReceivercompositionEnablerReceiver the notification callback
osid.id.IdrepositoryId the Id of the Repository
Returnosid.repository.rules.CompositionEnablerNotificationSession a CompositionEnablerNotificationSession
ErrorsNOT_FOUND no repository found by the given Id
NULL_ARGUMENT compositionEnablerReceiver or repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerNotification() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerNotification() and supportsVisibleFederation() are true.
MethodgetCompositionEnablerRepositorySession
Description

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

Returnosid.repository.rules.CompositionEnablerRepositorySession a CompositionEnablerCompositionSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerRepository() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerRepository() is true.
MethodgetCompositionEnablerRepositoryAssignmentSession
Description

Gets the OsidSession associated with assigning composition enablers to repositories.

Returnosid.repository.rules.CompositionEnablerRepositoryAssignmentSession a CompositionEnablerRepositoryAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerCompositionAssignment() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerRepositoryAssignment() is true.
MethodgetCompositionEnablerSmartRepositorySession
Description

Gets the OsidSession to manage composition enabler smart repositories.

Parametersosid.id.IdrepositoryId the Id of the Repository
Returnosid.repository.rules.CompositionEnablerSmartRepositorySession a CompositionEnablerSmartRepositorySession
ErrorsNOT_FOUND no Repository found by the given Id
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerSmartRepository() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerSmartRepository() is true.
MethodgetCompositionEnablerRuleLookupSession
Description

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

Returnosid.repository.rules.CompositionEnablerRuleLookupSession a CompositionEnablerRuleLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerRuleLookup() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerRuleLookup() is true.
MethodgetCompositionEnablerRuleLookupSessionForRepository
Description

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

Parametersosid.id.IdrepositoryId the Id of the Repository
Returnosid.repository.rules.CompositionEnablerRuleLookupSession a CompositionEnablerRuleLookupSession
ErrorsNOT_FOUND no Repository found by the given Id
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerRuleLookup() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetCompositionEnablerRuleApplicationSession
Description

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

Returnosid.repository.rules.CompositionEnablerRuleApplicationSession a CompositionEnablerRuleApplicationSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerRuleApplication() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerRuleApplication() is true.
MethodgetCompositionEnablerRuleApplicationSessionForRepository
Description

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

Parametersosid.id.IdrepositoryId the Id of the Repository
Returnosid.repository.rules.CompositionEnablerRuleApplicationSession a CompositionEnablerRuleApplicationSession
ErrorsNOT_FOUND no Repository found by the given Id
NULL_ARGUMENT repositoryId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCompositionEnablerRuleApplication() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsCompositionEnablerRuleApplication() and supportsVisibleFederation() are true.