org.osid.provisioning.rules

Interface BrokerConstrainerEnablerAdminSession

All Superinterfaces:

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

public interface BrokerConstrainerEnablerAdminSession
extends OsidSession

This session creates and removes broker constrainer enablers. The data for create and update is provided via the BrokerConstrainerEnablerForm.

Method Summary

Methods

Modifier and Type	Method and Description
void	aliasBrokerConstrainerEnabler(Id brokerConstrainerEnablerId, Id aliasId) Adds an Id to a BrokerConstrainerEnabler for the purpose of creating compatibility.
boolean	canCreateBrokerConstrainerEnabler() Tests if this user can create broker constrainer enablers.
boolean	canCreateBrokerConstrainerEnablerWithRecordTypes(Type[] brokerConstrainerEnablerRecordTypes) Tests if this user can create a single BrokerConstrainerEnabler using the desired record types.
boolean	canDeleteBrokerConstrainerEnablers() Tests if this user can delete broker constrainer enablers.
boolean	canManageBrokerConstrainerEnablerAliases() Tests if this user can manage Id aliases for broker constrainer enablers.
boolean	canUpdateBrokerConstrainerEnablers() Tests if this user can update broker constrainer enablers.
BrokerConstrainerEnabler	createBrokerConstrainerEnabler(BrokerConstrainerEnablerForm brokerConstrainerEnablerForm) Creates a new BrokerConstrainerEnabler.
void	deleteBrokerConstrainerEnabler(Id brokerConstrainerEnablerId) Deletes a BrokerConstrainerEnabler.
BrokerConstrainerEnablerForm	getBrokerConstrainerEnablerFormForCreate(Type[] brokerConstrainerEnablerRecordTypes) Gets the broker constrainer enabler form for creating new broker constrainer enablers.
BrokerConstrainerEnablerForm	getBrokerConstrainerEnablerFormForUpdate(Id brokerConstrainerEnablerId) Gets the broker constrainer enabler form for updating an existing broker constrainer enabler.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	updateBrokerConstrainerEnabler(BrokerConstrainerEnablerForm brokerConstrainerEnablerForm) Updates an existing broker constrainer enabler.

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.

canCreateBrokerConstrainerEnabler

boolean canCreateBrokerConstrainerEnabler()

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

Returns:

false if BrokerConstrainerEnabler creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateBrokerConstrainerEnablerWithRecordTypes

boolean canCreateBrokerConstrainerEnablerWithRecordTypes(Type[] brokerConstrainerEnablerRecordTypes)

Tests if this user can create a single BrokerConstrainerEnabler using the desired record types. While ProvisioningRulesManager.getBrokerConstrainerEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific BrokerConstrainerEnabler. Providing an empty array tests if a BrokerConstrainerEnabler can be created with no records.

Parameters:

brokerConstrainerEnablerRecordTypes - array of broker constrainer enabler record types

Returns:

true if BrokerConstrainerEnabler creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - brokerConstrainerEnablerRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerEnablerFormForCreate

BrokerConstrainerEnablerForm getBrokerConstrainerEnablerFormForCreate(Type[] brokerConstrainerEnablerRecordTypes)
                                                                      throws OperationFailedException,
                                                                             PermissionDeniedException

Gets the broker constrainer enabler form for creating new broker constrainer enablers. A new form should be requested for each create transaction.

Parameters:

brokerConstrainerEnablerRecordTypes - array of broker constrainer enabler record types

Returns:

the broker constrainer enabler form

Throws:

NullArgumentException - brokerConstrainerEnablerRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createBrokerConstrainerEnabler

BrokerConstrainerEnabler createBrokerConstrainerEnabler(BrokerConstrainerEnablerForm brokerConstrainerEnablerForm)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Creates a new BrokerConstrainerEnabler.

Parameters:

brokerConstrainerEnablerForm - the form for this BrokerConstrainerEnabler

Returns:

the new BrokerConstrainerEnabler

Throws:

IllegalStateException - brokerConstrainerEnablerForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - brokerConstrainerEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - brokerConstrainerEnablerForm did not originate from getBrokerConstrainerEnablerFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateBrokerConstrainerEnablers

boolean canUpdateBrokerConstrainerEnablers()

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

Returns:

false if BrokerConstrainerEnabler modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerEnablerFormForUpdate

BrokerConstrainerEnablerForm getBrokerConstrainerEnablerFormForUpdate(Id brokerConstrainerEnablerId)
                                                                      throws NotFoundException,
                                                                             OperationFailedException,
                                                                             PermissionDeniedException

Gets the broker constrainer enabler form for updating an existing broker constrainer enabler. A new broker constrainer enabler form should be requested for each update transaction.

Parameters:

brokerConstrainerEnablerId - the Id of the BrokerConstrainerEnabler

Returns:

the broker constrainer enabler form

Throws:

NotFoundException - brokerConstrainerEnablerId is not found

NullArgumentException - brokerConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateBrokerConstrainerEnabler

void updateBrokerConstrainerEnabler(BrokerConstrainerEnablerForm brokerConstrainerEnablerForm)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Updates an existing broker constrainer enabler.

Parameters:

brokerConstrainerEnablerForm - the form containing the elements to be updated

Throws:

IllegalStateException - brokerConstrainerEnablerForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - brokerConstrainerEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - brokerConstrainerEnablerForm did not originate from getBrokerConstrainerEnablerFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteBrokerConstrainerEnablers

boolean canDeleteBrokerConstrainerEnablers()

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

Returns:

false if BrokerConstrainerEnabler deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteBrokerConstrainerEnabler

void deleteBrokerConstrainerEnabler(Id brokerConstrainerEnablerId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Deletes a BrokerConstrainerEnabler.

Parameters:

brokerConstrainerEnablerId - the Id of the BrokerConstrainerEnabler to remove

Throws:

NotFoundException - brokerConstrainerEnablerId not found

NullArgumentException - brokerConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageBrokerConstrainerEnablerAliases

boolean canManageBrokerConstrainerEnablerAliases()

Tests if this user can manage Id aliases for broker constrainer enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:

false if BrokerConstrainerEnabler aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasBrokerConstrainerEnabler

void aliasBrokerConstrainerEnabler(Id brokerConstrainerEnablerId,
                                 Id aliasId)
                                   throws AlreadyExistsException,
                                          NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Adds an Id to a BrokerConstrainerEnabler for the purpose of creating compatibility. The primary Id of the BrokerConstrainerEnabler is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another broker constrainer enabler. it is reassigned to the given broker constrainer enabler Id.

Parameters:

brokerConstrainerEnablerId - the Id of a BrokerConstrainerEnabler

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - brokerConstrainerEnablerId not found

NullArgumentException - brokerConstrainerEnablerId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.