org.osid.offering.rules

Interface CanonicalUnitProcessorEnablerAdminSession

All Superinterfaces:

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

public interface CanonicalUnitProcessorEnablerAdminSession
extends OsidSession

This session creates and removes canonical unit processor enablers. The data for create and update is provided via the CanonicalUnitProcessorEnablerForm.

Method Summary

Methods

Modifier and Type	Method and Description
void	aliasCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId, Id aliasId) Adds an Id to a CanonicalUnitProcessorEnabler for the purpose of creating compatibility.
boolean	canCreateCanonicalUnitProcessorEnabler() Tests if this user can create canonical unit processor enablers.
boolean	canCreateCanonicalUnitProcessorEnablerWithRecordTypes(Type[] canonicalUnitProcessorEnablerRecordTypes) Tests if this user can create a single CanonicalUnitProcessorEnabler using the desired record types.
boolean	canDeleteCanonicalUnitProcessorEnablers() Tests if this user can delete canonical unit processor enablers.
boolean	canManageCanonicalUnitProcessorEnablerAliases() Tests if this user can manage Id aliases for canonical unit processor enablers.
boolean	canUpdateCanonicalUnitProcessorEnablers() Tests if this user can update canonical unit processor enablers.
CanonicalUnitProcessorEnabler	createCanonicalUnitProcessorEnabler(CanonicalUnitProcessorEnablerForm canonicalUnitProcessorEnablerForm) Creates a new CanonicalUnitProcessorEnabler.
void	deleteCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId) Deletes a CanonicalUnitProcessorEnabler.
CanonicalUnitProcessorEnablerForm	getCanonicalUnitProcessorEnablerFormForCreate(Type[] canonicalUnitProcessorEnablerRecordTypes) Gets the canonical unit processor enabler form for creating new canonical unit processor enablers.
CanonicalUnitProcessorEnablerForm	getCanonicalUnitProcessorEnablerFormForUpdate(Id canonicalUnitProcessorEnablerId) Gets the canonical unit processor enabler form for updating an existing canonical unit processor enabler.
Catalogue	getCatalogue() Gets the Catalogue associated with this session.
Id	getCatalogueId() Gets the Catalogue Id associated with this session.
void	updateCanonicalUnitProcessorEnabler(CanonicalUnitProcessorEnablerForm canonicalUnitProcessorEnablerForm) Updates an existing canonical unit 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

getCatalogueId

Id getCatalogueId()

Gets the Catalogue Id associated with this session.

Returns:

the Catalogue Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCatalogue

Catalogue getCatalogue()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Catalogue associated with this session.

Returns:

the catalogue

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateCanonicalUnitProcessorEnabler

boolean canCreateCanonicalUnitProcessorEnabler()

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

Compliance:

mandatory - This method must be implemented.

canCreateCanonicalUnitProcessorEnablerWithRecordTypes

boolean canCreateCanonicalUnitProcessorEnablerWithRecordTypes(Type[] canonicalUnitProcessorEnablerRecordTypes)

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

Parameters:

canonicalUnitProcessorEnablerRecordTypes - array of canonical unit processor enabler record types

Returns:

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

Throws:

NullArgumentException - canonicalUnitProcessorEnablerRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorEnablerFormForCreate

CanonicalUnitProcessorEnablerForm getCanonicalUnitProcessorEnablerFormForCreate(Type[] canonicalUnitProcessorEnablerRecordTypes)
                                                                                throws OperationFailedException,
                                                                                       PermissionDeniedException

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

Parameters:

canonicalUnitProcessorEnablerRecordTypes - array of canonical unit processor enabler record types

Returns:

the canonical unit processor enabler form

Throws:

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

createCanonicalUnitProcessorEnabler

CanonicalUnitProcessorEnabler createCanonicalUnitProcessorEnabler(CanonicalUnitProcessorEnablerForm canonicalUnitProcessorEnablerForm)
                                                                  throws OperationFailedException,
                                                                         PermissionDeniedException

Creates a new CanonicalUnitProcessorEnabler.

Parameters:

canonicalUnitProcessorEnablerForm - the form for this CanonicalUnitProcessorEnabler

Returns:

the new CanonicalUnitProcessorEnabler

Throws:

IllegalStateException - canonicalUnitProcessorEnablerForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - canonicalUnitProcessorEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - canonicalUnitProcessorEnablerForm did not originate from getCanonicalUnitProcessorEnablerFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateCanonicalUnitProcessorEnablers

boolean canUpdateCanonicalUnitProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorEnablerFormForUpdate

CanonicalUnitProcessorEnablerForm getCanonicalUnitProcessorEnablerFormForUpdate(Id canonicalUnitProcessorEnablerId)
                                                                                throws NotFoundException,
                                                                                       OperationFailedException,
                                                                                       PermissionDeniedException

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

Parameters:

canonicalUnitProcessorEnablerId - the Id of the CanonicalUnitProcessorEnabler

Returns:

the canonical unit processor enabler form

Throws:

NotFoundException - canonicalUnitProcessorEnablerId is not found

NullArgumentException - canonicalUnitProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateCanonicalUnitProcessorEnabler

void updateCanonicalUnitProcessorEnabler(CanonicalUnitProcessorEnablerForm canonicalUnitProcessorEnablerForm)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Updates an existing canonical unit processor enabler.

Parameters:

canonicalUnitProcessorEnablerForm - the form containing the elements to be updated

Throws:

IllegalStateException - canonicalUnitProcessorEnablerForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - canonicalUnitProcessorEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - canonicalUnitProcessorEnablerForm did not originate from getCanonicalUnitProcessorEnablerFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteCanonicalUnitProcessorEnablers

boolean canDeleteCanonicalUnitProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

deleteCanonicalUnitProcessorEnabler

void deleteCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Deletes a CanonicalUnitProcessorEnabler.

Parameters:

canonicalUnitProcessorEnablerId - the Id of the CanonicalUnitProcessorEnabler to remove

Throws:

NotFoundException - canonicalUnitProcessorEnablerId not found

NullArgumentException - canonicalUnitProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageCanonicalUnitProcessorEnablerAliases

boolean canManageCanonicalUnitProcessorEnablerAliases()

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

Compliance:

mandatory - This method must be implemented.

aliasCanonicalUnitProcessorEnabler

void aliasCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId,
                                      Id aliasId)
                                        throws AlreadyExistsException,
                                               NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

canonicalUnitProcessorEnablerId - the Id of a CanonicalUnitProcessorEnabler

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - canonicalUnitProcessorEnablerId not found

NullArgumentException - canonicalUnitProcessorEnablerId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.