org.osid.repository.rules

Interface RepositoryRulesProxyManager

All Superinterfaces:

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

public interface RepositoryRulesProxyManager
extends OsidProxyManager, RepositoryRulesProfile

The repository rules proxy manager provides access to repository rules sessions and provides interoperability tests for various aspects of this service. Methods in this manager pass a Proxy for passing information from server environments. 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(Proxy proxy) Gets the OsidSession associated with the composition enabler administration service.
CompositionEnablerAdminSession	getCompositionEnablerAdminSessionForRepository(Id repositoryId, Proxy proxy) Gets the OsidSession associated with the composition enabler administration service for the given repository.
CompositionEnablerLookupSession	getCompositionEnablerLookupSession(Proxy proxy) Gets the OsidSession associated with the composition enabler lookup service.
CompositionEnablerLookupSession	getCompositionEnablerLookupSessionForRepository(Id repositoryId, Proxy proxy) Gets the OsidSession associated with the composition enabler lookup service for the given repository.
CompositionEnablerNotificationSession	getCompositionEnablerNotificationSession(CompositionEnablerReceiver compositionEnablerReceiver, Proxy proxy) Gets the OsidSession associated with the composition enabler notification service.
CompositionEnablerNotificationSession	getCompositionEnablerNotificationSessionForRepository(CompositionEnablerReceiver compositionEnablerReceiver, Id repositoryId, Proxy proxy) Gets the OsidSession associated with the composition enabler notification service for the given repository.
CompositionEnablerQuerySession	getCompositionEnablerQuerySession(Proxy proxy) Gets the OsidSession associated with the composition enabler query service.
CompositionEnablerQuerySession	getCompositionEnablerQuerySessionForRepository(Id repositoryId, Proxy proxy) Gets the OsidSession associated with the composition enabler query service for the given repository.
CompositionEnablerRepositoryAssignmentSession	getCompositionEnablerRepositoryAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning composition enablers to repositories.
CompositionEnablerRepositorySession	getCompositionEnablerRepositorySession(Proxy proxy) Gets the OsidSession to lookup composition enabler/composition mappings for composition enablers.
CompositionEnablerRuleApplicationSession	getCompositionEnablerRuleApplicationSession(Proxy proxy) Gets the OsidSession associated with the composition enabler assignment service to apply enablers to compositions.
CompositionEnablerRuleApplicationSession	getCompositionEnablerRuleApplicationSessionForRepository(Id repositoryId, Proxy proxy) Gets the OsidSession associated with the composition enabler assignment service for the given composition to apply enablers to compositions.
CompositionEnablerRuleLookupSession	getCompositionEnablerRuleLookupSession(Proxy proxy) Gets the OsidSession associated with the composition enabler mapping lookup service for looking up the rules applied to the composition.
CompositionEnablerRuleLookupSession	getCompositionEnablerRuleLookupSessionForRepository(Id repositoryId, Proxy proxy) 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(Proxy proxy) Gets the OsidSession associated with the composition enabler search service.
CompositionEnablerSearchSession	getCompositionEnablerSearchSessionForRepository(Id repositoryId, Proxy proxy) Gets the OsidSession associated with the composition enablers earch service for the given repository.
CompositionEnablerSmartRepositorySession	getCompositionEnablerSmartRepositorySession(Id repositoryId, Proxy proxy) Gets the OsidSession to manage composition enabler smart repositories.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the composition enabler lookup service.

Parameters:

proxy - a proxy

Returns:

a CompositionEnablerLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                                              Proxy proxy)
                                                                                throws NotFoundException,
                                                                                       OperationFailedException

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

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

a CompositionEnablerLookupSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the composition enabler query service.

Parameters:

proxy - a proxy

Returns:

a CompositionEnablerQuerySession

Throws:

NullArgumentException - proxy is null

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,
                                                                            Proxy proxy)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

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

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

a CompositionEnablerQuerySession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the composition enabler search service.

Parameters:

proxy - a proxy

Returns:

a CompositionEnablerSearchSession

Throws:

NullArgumentException - proxy is null

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,
                                                                              Proxy proxy)
                                                                                throws NotFoundException,
                                                                                       OperationFailedException

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

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

a CompositionEnablerSearchSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the composition enabler administration service.

Parameters:

proxy - a proxy

Returns:

a CompositionEnablerAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                            Proxy proxy)
                                                                              throws NotFoundException,
                                                                                     OperationFailedException

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

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

a CompositionEnablerAdminSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId or proxy 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,
                                                                             Proxy proxy)
                                                                               throws OperationFailedException

Gets the OsidSession associated with the composition enabler notification service.

Parameters:

compositionEnablerReceiver - the notification callback

proxy - a proxy

Returns:

a CompositionEnablerNotificationSession

Throws:

NullArgumentException - compositionEnablerReceiver or proxy 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,
                                                                                          Proxy proxy)
                                                                                            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

proxy - a proxy

Returns:

a CompositionEnablerNotificationSession

Throws:

NotFoundException - no repository found by the given Id

NullArgumentException - compositionEnablerReceiver, repositoryId, or proxy 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(Proxy proxy)
                                                                           throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a CompositionEnablerRepositorySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompositionEnablerRepository() is false

Compliance:

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

getCompositionEnablerRepositoryAssignmentSession

CompositionEnablerRepositoryAssignmentSession getCompositionEnablerRepositoryAssignmentSession(Proxy proxy)
                                                                                               throws OperationFailedException

Gets the OsidSession associated with assigning composition enablers to repositories.

Parameters:

proxy - a proxy

Returns:

a CompositionEnablerRepositoryAssignmentSession

Throws:

NullArgumentException - proxy is null

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,
                                                                                   Proxy proxy)
                                                                                     throws NotFoundException,
                                                                                            OperationFailedException

Gets the OsidSession to manage composition enabler smart repositories.

Parameters:

repositoryId - the Id of the Repository

proxy - a proxy

Returns:

a CompositionEnablerSmartRepositorySession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                                                           throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a CompositionEnablerRuleLookupSession

Throws:

NullArgumentException - proxy is null

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,
                                                                                      Proxy proxy)
                                                                                        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

proxy - a proxy

Returns:

a CompositionEnablerRuleLookupSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId or proxy 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(Proxy proxy)
                                                                                     throws OperationFailedException

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

Parameters:

proxy - a proxy

Returns:

a CompositionEnablerRuleApplicationSession

Throws:

NullArgumentException - proxy is null

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,
                                                                                                Proxy proxy)
                                                                                                  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

proxy - a proxy

Returns:

a CompositionEnablerRuleApplicationSession

Throws:

NotFoundException - no Repository found by the given Id

NullArgumentException - repositoryId or proxy 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.