Interface RepositoryRulesManager

All Superinterfaces:
AutoCloseable, Closeable, OsidManager, 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 Details

    • 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 {@code supportsCompositionEnablerLookup()} is {@code 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 {@code supportsCompositionEnablerLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCompositionEnablerQuery()} is {@code 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 {@code supportsCompositionEnablerQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCompositionEnablerSearch()} is {@code 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 {@code supportsCompositionEnablerSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCompositionEnablerAdmin()} is {@code 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 {@code supportsCompositionEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCompositionEnablerNotification()} is {@code 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 {@code supportsCompositionEnablerNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCompositionEnablerRepository()} is {@code 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 {@code supportsCompositionEnablerRepositoryAssignment()} is {@code 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 {@code supportsCompositionEnablerSmartRepository()} is {@code 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 {@code supportsCompositionEnablerRuleLookup()} is {@code 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 {@code supportsCompositionEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCompositionEnablerRuleApplication()} is {@code 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 {@code supportsCompositionEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .