org.osid.provisioning.rules

Interface BrokerConstrainerAdminSession

All Superinterfaces:

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

public interface BrokerConstrainerAdminSession
extends OsidSession

This session creates and removes broker constrainers. The data for create and update is provided via the BrokerConstrainerForm.

Method Summary

Methods

Modifier and Type	Method and Description
void	aliasBrokerConstrainer(Id brokerConstrainerId, Id aliasId) Adds an Id to a BrokerConstrainer for the purpose of creating compatibility.
boolean	canCreateBrokerConstrainer() Tests if this user can create broker constrainers.
boolean	canCreateBrokerConstrainerWithRecordTypes(Type[] brokerConstrainerRecordTypes) Tests if this user can create a single BrokerConstrainer using the desired record types.
boolean	canDeleteBrokerConstrainers() Tests if this user can delete broker constrainers.
boolean	canManageBrokerConstrainerAliases() Tests if this user can manage Id aliases for broker constrainers.
boolean	canUpdateBrokerConstrainers() Tests if this user can update broker constrainers.
BrokerConstrainer	createBrokerConstrainer(BrokerConstrainerForm brokerConstrainerForm) Creates a new BrokerConstrainer.
void	deleteBrokerConstrainer(Id brokerConstrainerId) Deletes a BrokerConstrainer.
BrokerConstrainerForm	getBrokerConstrainerFormForCreate(Type[] brokerConstrainerRecordTypes) Gets the broker constrainer form for creating new broker constrainers.
BrokerConstrainerForm	getBrokerConstrainerFormForUpdate(Id brokerConstrainerId) Gets the broker constrainer form for updating an existing broker constrainer.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	updateBrokerConstrainer(BrokerConstrainerForm brokerConstrainerForm) Updates an existing broker constrainer.

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.

canCreateBrokerConstrainer

boolean canCreateBrokerConstrainer()

Tests if this user can create broker constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a BrokerConstrainer 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 BrokerConstrainer creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateBrokerConstrainerWithRecordTypes

boolean canCreateBrokerConstrainerWithRecordTypes(Type[] brokerConstrainerRecordTypes)

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

Parameters:

brokerConstrainerRecordTypes - array of broker constrainer record types

Returns:

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

Throws:

NullArgumentException - brokerConstrainerRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerFormForCreate

BrokerConstrainerForm getBrokerConstrainerFormForCreate(Type[] brokerConstrainerRecordTypes)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

brokerConstrainerRecordTypes - array of broker constrainer record types

Returns:

the broker constrainer form

Throws:

NullArgumentException - brokerConstrainerRecordTypes 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.

createBrokerConstrainer

BrokerConstrainer createBrokerConstrainer(BrokerConstrainerForm brokerConstrainerForm)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Creates a new BrokerConstrainer.

Parameters:

brokerConstrainerForm - the form for this BrokerConstrainer

Returns:

the new BrokerConstrainer

Throws:

IllegalStateException - brokerConstrainerForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - brokerConstrainerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - brokerConstrainerForm did not originate from getBrokerConstrainerFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateBrokerConstrainers

boolean canUpdateBrokerConstrainers()

Tests if this user can update broker constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a BrokerConstrainer 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 BrokerConstrainer modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerFormForUpdate

BrokerConstrainerForm getBrokerConstrainerFormForUpdate(Id brokerConstrainerId)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

brokerConstrainerId - the Id of the BrokerConstrainer

Returns:

the broker constrainer form

Throws:

NotFoundException - brokerConstrainerId is not found

NullArgumentException - brokerConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateBrokerConstrainer

void updateBrokerConstrainer(BrokerConstrainerForm brokerConstrainerForm)
                             throws OperationFailedException,
                                    PermissionDeniedException

Updates an existing broker constrainer.

Parameters:

brokerConstrainerForm - the form containing the elements to be updated

Throws:

IllegalStateException - brokerConstrainerForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - brokerConstrainerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - brokerConstrainerForm did not originate from getBrokerConstrainerFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteBrokerConstrainers

boolean canDeleteBrokerConstrainers()

Tests if this user can delete broker constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a BrokerConstrainer 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 BrokerConstrainer deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteBrokerConstrainer

void deleteBrokerConstrainer(Id brokerConstrainerId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Deletes a BrokerConstrainer.

Parameters:

brokerConstrainerId - the Id of the BrokerConstrainer to remove

Throws:

NotFoundException - brokerConstrainerId not found

NullArgumentException - brokerConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageBrokerConstrainerAliases

boolean canManageBrokerConstrainerAliases()

Tests if this user can manage Id aliases for broker constrainers. 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 BrokerConstrainer aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasBrokerConstrainer

void aliasBrokerConstrainer(Id brokerConstrainerId,
                          Id aliasId)
                            throws AlreadyExistsException,
                                   NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Adds an Id to a BrokerConstrainer for the purpose of creating compatibility. The primary Id of the BrokerConstrainer 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. it is reassigned to the given broker constrainer Id.

Parameters:

brokerConstrainerId - the Id of a BrokerConstrainer

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - brokerConstrainerId not found

NullArgumentException - brokerConstrainerId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.