Interface RepositoryRulesProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface RepositoryRulesProfile

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

Modifier and Type	Method	Description
TypeList	getCompositionEnablerRecordTypes()	Gets the supported CompositionEnabler record types.
TypeList	getCompositionEnablerSearchRecordTypes()	Gets the supported CompositionEnabler search record types.
boolean	supportsCompositionEnablerAdmin()	Tests if a composition enabler administrative service is supported.
boolean	supportsCompositionEnablerLookup()	Tests if looking up composition enablers is supported.
boolean	supportsCompositionEnablerNotification()	Tests if a composition enabler notification service is supported.
boolean	supportsCompositionEnablerQuery()	Tests if querying composition enablers is supported.
boolean	supportsCompositionEnablerRecordType(Type compositionEnablerRecordType)	Tests if the given CompositionEnabler record type is supported.
boolean	supportsCompositionEnablerRepository()	Tests if a composition enabler repository lookup service is supported.
boolean	supportsCompositionEnablerRepositoryAssignment()	Tests if a composition enabler repository service is supported.
boolean	supportsCompositionEnablerRuleApplication()	Tests if a composition enabler rule application service is supported.
boolean	supportsCompositionEnablerRuleLookup()	Tests if a composition enabler rule lookup service is supported.
boolean	supportsCompositionEnablerSearch()	Tests if searching composition enablers is supported.
boolean	supportsCompositionEnablerSearchRecordType(Type compositionEnablerSearchRecordType)	Tests if the given CompositionEnabler search record type is supported.
boolean	supportsCompositionEnablerSmartRepository()	Tests if a composition enabler repository lookup service is supported.
boolean	supportsVisibleFederation()	Tests if any broker federation is exposed.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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