org.osid.bidding.rules

Interface AuctionProcessorEnablerAdminSession

All Superinterfaces:

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

public interface AuctionProcessorEnablerAdminSession
extends OsidSession

This session creates and removes auction processor enablers. The data for create and update is provided via the AuctionProcessorEnablerForm.

Method Summary

Methods

Modifier and Type	Method and Description
void	aliasAuctionProcessorEnabler(Id auctionProcessorEnablerId, Id aliasId) Adds an Id to an AuctionProcessorEnabler for the purpose of creating compatibility.
boolean	canCreateAuctionProcessorEnabler() Tests if this user can create auction processor enablers.
boolean	canCreateAuctionProcessorEnablerWithRecordTypes(Type[] auctionProcessorEnablerRecordTypes) Tests if this user can create a single AuctionProcessorEnabler using the desired record types.
boolean	canDeleteAuctionProcessorEnablers() Tests if this user can delete auction processor enablers.
boolean	canManageAuctionProcessorEnablerAliases() Tests if this user can manage Id aliases for auction processor enablers.
boolean	canUpdateAuctionProcessorEnablers() Tests if this user can update auction processor enablers.
AuctionProcessorEnabler	createAuctionProcessorEnabler(AuctionProcessorEnablerForm auctionProcessorEnablerForm) Creates a new AuctionProcessorEnabler.
void	deleteAuctionProcessorEnabler(Id auctionProcessorEnablerId) Deletes an AuctionProcessorEnabler.
AuctionHouse	getAuctionHouse() Gets the AuctionHouse associated with this session.
Id	getAuctionHouseId() Gets the AuctionHouse Id associated with this session.
AuctionProcessorEnablerForm	getAuctionProcessorEnablerFormForCreate(Type[] auctionProcessorEnablerRecordTypes) Gets the auction processor enabler form for creating new auction processor enablers.
AuctionProcessorEnablerForm	getAuctionProcessorEnablerFormForUpdate(Id auctionProcessorEnablerId) Gets the auction processor enabler form for updating an existing auction processor enabler.
void	updateAuctionProcessorEnabler(AuctionProcessorEnablerForm auctionProcessorEnablerForm) Updates an existing auction processor 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

getAuctionHouseId

Id getAuctionHouseId()

Gets the AuctionHouse Id associated with this session.

Returns:

the AuctionHouse Id associated with this session

Compliance:

mandatory - This method must be implemented.

getAuctionHouse

AuctionHouse getAuctionHouse()
                             throws OperationFailedException,
                                    PermissionDeniedException

Gets the AuctionHouse associated with this session.

Returns:

the auction house

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateAuctionProcessorEnabler

boolean canCreateAuctionProcessorEnabler()

Tests if this user can create auction processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an AuctionProcessorEnabler 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 AuctionProcessorEnabler creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateAuctionProcessorEnablerWithRecordTypes

boolean canCreateAuctionProcessorEnablerWithRecordTypes(Type[] auctionProcessorEnablerRecordTypes)

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

Parameters:

auctionProcessorEnablerRecordTypes - array of auction processor enabler record types

Returns:

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

Throws:

NullArgumentException - auctionProcessorEnablerRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getAuctionProcessorEnablerFormForCreate

AuctionProcessorEnablerForm getAuctionProcessorEnablerFormForCreate(Type[] auctionProcessorEnablerRecordTypes)
                                                                    throws OperationFailedException,
                                                                           PermissionDeniedException

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

Parameters:

auctionProcessorEnablerRecordTypes - array of auction processor enabler record types

Returns:

the auction processor enabler form

Throws:

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

createAuctionProcessorEnabler

AuctionProcessorEnabler createAuctionProcessorEnabler(AuctionProcessorEnablerForm auctionProcessorEnablerForm)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Creates a new AuctionProcessorEnabler.

Parameters:

auctionProcessorEnablerForm - the form for this AuctionProcessorEnabler

Returns:

the new AuctionProcessorEnabler

Throws:

IllegalStateException - auctionProcessorEnablerForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - auctionProcessorEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - auctionProcessorEnablerForm did not originate from getAuctionProcessorEnablerFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateAuctionProcessorEnablers

boolean canUpdateAuctionProcessorEnablers()

Tests if this user can update auction processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an AuctionProcessorEnabler 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 AuctionProcessorEnabler modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getAuctionProcessorEnablerFormForUpdate

AuctionProcessorEnablerForm getAuctionProcessorEnablerFormForUpdate(Id auctionProcessorEnablerId)
                                                                    throws NotFoundException,
                                                                           OperationFailedException,
                                                                           PermissionDeniedException

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

Parameters:

auctionProcessorEnablerId - the Id of the AuctionProcessorEnabler

Returns:

the auction processor enabler form

Throws:

NotFoundException - auctionProcessorEnablerId is not found

NullArgumentException - auctionProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAuctionProcessorEnabler

void updateAuctionProcessorEnabler(AuctionProcessorEnablerForm auctionProcessorEnablerForm)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Updates an existing auction processor enabler.

Parameters:

auctionProcessorEnablerForm - the form containing the elements to be updated

Throws:

IllegalStateException - auctionProcessorEnablerForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - auctionProcessorEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - auctionProcessorEnablerForm did not originate from getAuctionProcessorEnablerFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteAuctionProcessorEnablers

boolean canDeleteAuctionProcessorEnablers()

Tests if this user can delete auction processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an AuctionProcessorEnabler 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 AuctionProcessorEnabler deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteAuctionProcessorEnabler

void deleteAuctionProcessorEnabler(Id auctionProcessorEnablerId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Deletes an AuctionProcessorEnabler.

Parameters:

auctionProcessorEnablerId - the Id of the AuctionProcessorEnabler to remove

Throws:

NotFoundException - auctionProcessorEnablerId not found

NullArgumentException - auctionProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageAuctionProcessorEnablerAliases

boolean canManageAuctionProcessorEnablerAliases()

Tests if this user can manage Id aliases for auction processor 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 AuctionProcessorEnabler aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasAuctionProcessorEnabler

void aliasAuctionProcessorEnabler(Id auctionProcessorEnablerId,
                                Id aliasId)
                                  throws AlreadyExistsException,
                                         NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

auctionProcessorEnablerId - the Id of an AuctionProcessorEnabler

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - auctionProcessorEnablerId not found

NullArgumentException - auctionProcessorEnablerId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.