org.osid.provisioning.rules

Interface BrokerConstrainerEnablerRuleApplicationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface BrokerConstrainerEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply BrokerConstrainerEnablers to BrokerConstrainers. A BrokerConstrainer with multiple BrokerConstrainerEnablers means any positive rule evaluation across the enablers result in an effective BrokerConstrainer.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignBrokerConstrainerEnablerToBrokerConstrainer(Id brokerConstrainerEnablerId, Id brokerConstrainerId) Adds an existing BrokerConstrainerEnabler to a BrokerConstrainer.
boolean	canAssignBrokerConstrainerEnablers() Tests if this user can alter broker constrainer enabler/broker constrainer mappings.
boolean	canSequenceBrokerConstrainerEnablers() Tests if this user can order BrokerConstrainerEnablers.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	moveBrokerConstrainerEnablerAhead(Id brokerConstrainerEnablerId, Id brokerConstrainerId, Id referenceId) Reorders broker constrainer enablers for a broker constrainer by moving the specified broker constrainer enabler in front of a reference broker constrainer.
void	moveBrokerConstrainerEnablerBehind(Id brokerConstrainerEnablerId, Id brokerConstrainerId, Id referenceId) Reorders broker constrainer enablers for a broker constrainer by moving the specified broker constrainer enabler behind a reference broker constrainer.
void	orderBrokerConstrainerEnablers(Id[] brokerConstrainerEnablerIds, Id brokerConstrainerId) Reorders a set of broker constrainer enablers for a broker constrainer.
void	unassignBrokerConstrainerEnablerFromBrokerConstrainer(Id brokerConstrainerEnablerId, Id brokerConstrainerId) Removes a BrokerConstrainerEnabler from a BrokerConstrainer.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

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

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getDistributorId

Id getDistributorId()

Gets the Distributor Id associated with this session.

Returns:

the Distributor Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDistributor

Distributor getDistributor()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the Distributor associated with this session.

Returns:

the distributor

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignBrokerConstrainerEnablers

boolean canAssignBrokerConstrainerEnablers()

Tests if this user can alter broker constrainer enabler/broker constrainer mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignBrokerConstrainerEnablerToBrokerConstrainer

void assignBrokerConstrainerEnablerToBrokerConstrainer(Id brokerConstrainerEnablerId,
                                                     Id brokerConstrainerId)
                                                       throws AlreadyExistsException,
                                                              NotFoundException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

Adds an existing BrokerConstrainerEnabler to a BrokerConstrainer.

Parameters:

brokerConstrainerEnablerId - the Id of the BrokerConstrainerEnabler

brokerConstrainerId - the Id of the BrokerConstrainer

Throws:

AlreadyExistsException - brokerConstrainerEnablerId is already applied to brokerConstrainerId

NotFoundException - brokerConstrainerEnablerId or brokerConstrainerId not found

NullArgumentException - brokerConstrainerEnablerId or brokerConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignBrokerConstrainerEnablerFromBrokerConstrainer

void unassignBrokerConstrainerEnablerFromBrokerConstrainer(Id brokerConstrainerEnablerId,
                                                         Id brokerConstrainerId)
                                                           throws NotFoundException,
                                                                  OperationFailedException,
                                                                  PermissionDeniedException

Removes a BrokerConstrainerEnabler from a BrokerConstrainer.

Parameters:

brokerConstrainerEnablerId - the Id of the BrokerConstrainerEnabler

brokerConstrainerId - the Id of the BrokerConstrainer

Throws:

NotFoundException - brokerConstrainerEnablerId or brokerConstrainerId not found or brokerConstrainerEnablerId not applied to brokerConstrainerId

NullArgumentException - brokerConstrainerEnablerId or brokerConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceBrokerConstrainerEnablers

boolean canSequenceBrokerConstrainerEnablers()

Tests if this user can order BrokerConstrainerEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if BrokerConstrainerEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveBrokerConstrainerEnablerAhead

void moveBrokerConstrainerEnablerAhead(Id brokerConstrainerEnablerId,
                                     Id brokerConstrainerId,
                                     Id referenceId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Reorders broker constrainer enablers for a broker constrainer by moving the specified broker constrainer enabler in front of a reference broker constrainer.

Parameters:

brokerConstrainerEnablerId - the Id of a BrokerConstrainerEnabler

brokerConstrainerId - the Id of a BrokerConstrainer

referenceId - the reference broker constrainer enabler Id

Throws:

NotFoundException - brokerConstrainerEnablerId, brokerConstrainerId, or referenceId not found or, brokerConstrainerEnablerId or referenceId not related to brokerConstrainerId

NullArgumentException - brokerConstrainerEnablerId, brokerConstrainerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveBrokerConstrainerEnablerBehind

void moveBrokerConstrainerEnablerBehind(Id brokerConstrainerEnablerId,
                                      Id brokerConstrainerId,
                                      Id referenceId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Reorders broker constrainer enablers for a broker constrainer by moving the specified broker constrainer enabler behind a reference broker constrainer.

Parameters:

brokerConstrainerEnablerId - the Id of a BrokerConstrainerEnabler

brokerConstrainerId - the Id of a BrokerConstrainer

referenceId - the reference broker constrainer enabler Id

Throws:

NotFoundException - brokerConstrainerEnablerId, brokerConstrainerId, or referenceId not found or, brokerConstrainerEnablerId or referenceId not related to brokerConstrainerId

NullArgumentException - brokerConstrainerEnablerId, brokerConstrainerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderBrokerConstrainerEnablers

void orderBrokerConstrainerEnablers(Id[] brokerConstrainerEnablerIds,
                                  Id brokerConstrainerId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Reorders a set of broker constrainer enablers for a broker constrainer.

Parameters:

brokerConstrainerEnablerIds - the Ids for a set of BrokerConstrainerEnablers

brokerConstrainerId - the Id of a BrokerConstrainer

Throws:

NotFoundException - brokerConstrainerId not found or, a brokerConstrainerEnablerId not related to brokerConstrainerId

NullArgumentException - brokerConstrainerEnablerIds or brokerConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.