org.osid.workflow.rules

Interface StepProcessorEnablerAdminSession

All Superinterfaces:

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

public interface StepProcessorEnablerAdminSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	aliasStepProcessorEnabler(Id stepProcessorEnablerId, Id aliasId) Adds a Id to a StepProcessorEnabler for the purpose of creating compatibility.
boolean	canCreateStepProcessorEnabler() Tests if this user can create step processor enablers.
boolean	canCreateStepProcessorEnablerWithRecordTypes(Type[] stepProcessorEnablerRecordTypes) Tests if this user can create a single StepProcessorEnabler using the desired record types.
boolean	canDeleteStepProcessorEnablers() Tests if this user can delete step processor enablers.
boolean	canManageStepProcessorEnablerAliases() Tests if this user can manage Id aliases for step processor enablers.
boolean	canUpdateStepProcessorEnablers() Tests if this user can update step processor enablers.
StepProcessorEnabler	createStepProcessorEnabler(StepProcessorEnablerForm stepProcessorEnablerForm) Creates a new StepProcessorEnabler.
void	deleteStepProcessorEnabler(Id stepProcessorEnablerId) Deletes a StepProcessorEnabler.
Office	getOffice() Gets the Office associated with this session.
Id	getOfficeId() Gets the Office Id associated with this session.
StepProcessorEnablerForm	getStepProcessorEnablerFormForCreate(Type[] stepProcessorEnablerRecordTypes) Gets the step processor enabler form for creating new step processor enablers.
StepProcessorEnablerForm	getStepProcessorEnablerFormForUpdate(Id stepProcessorEnablerId) Gets the step processor enabler form for updating an existing step processor enabler.
void	updateStepProcessorEnabler(StepProcessorEnablerForm stepProcessorEnablerForm) Updates an existing step 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

getOfficeId

Id getOfficeId()

Gets the Office Id associated with this session.

Returns:

the Office Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOffice

Office getOffice()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the Office associated with this session.

Returns:

the office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateStepProcessorEnabler

boolean canCreateStepProcessorEnabler()

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

Compliance:

mandatory - This method must be implemented.

canCreateStepProcessorEnablerWithRecordTypes

boolean canCreateStepProcessorEnablerWithRecordTypes(Type[] stepProcessorEnablerRecordTypes)

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

Parameters:

stepProcessorEnablerRecordTypes - array of step processor enabler types

Returns:

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

Throws:

NullArgumentException - stepProcessorEnablerRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getStepProcessorEnablerFormForCreate

StepProcessorEnablerForm getStepProcessorEnablerFormForCreate(Type[] stepProcessorEnablerRecordTypes)
                                                              throws OperationFailedException,
                                                                     PermissionDeniedException

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

Parameters:

stepProcessorEnablerRecordTypes - array of step processor enabler types

Returns:

the step processor enabler form

Throws:

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

createStepProcessorEnabler

StepProcessorEnabler createStepProcessorEnabler(StepProcessorEnablerForm stepProcessorEnablerForm)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Creates a new StepProcessorEnabler.

Parameters:

stepProcessorEnablerForm - the form for this StepProcessorEnabler

Returns:

the new StepProcessorEnabler

Throws:

IllegalStateException - stepProcessorEnablerForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - stepProcessorEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - stepProcessorEnablerForm did not originate from getStepProcessorEnablerFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateStepProcessorEnablers

boolean canUpdateStepProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

getStepProcessorEnablerFormForUpdate

StepProcessorEnablerForm getStepProcessorEnablerFormForUpdate(Id stepProcessorEnablerId)
                                                              throws NotFoundException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

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

Parameters:

stepProcessorEnablerId - the Id of the StepProcessorEnabler

Returns:

the step processor enabler form

Throws:

NotFoundException - stepProcessorEnablerId is not found

NullArgumentException - stepProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateStepProcessorEnabler

void updateStepProcessorEnabler(StepProcessorEnablerForm stepProcessorEnablerForm)
                                throws OperationFailedException,
                                       PermissionDeniedException

Updates an existing step processor enabler.

Parameters:

stepProcessorEnablerForm - the form containing the elements to be updated

Throws:

IllegalStateException - stepProcessorEnablerForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - stepProcessorEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - stepProcessorEnablerForm did not originate from getStepProcessorEnablerFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteStepProcessorEnablers

boolean canDeleteStepProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

deleteStepProcessorEnabler

void deleteStepProcessorEnabler(Id stepProcessorEnablerId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Deletes a StepProcessorEnabler.

Parameters:

stepProcessorEnablerId - the Id of the StepProcessorEnabler to remove

Throws:

NotFoundException - stepProcessorEnablerId not found

NullArgumentException - stepProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageStepProcessorEnablerAliases

boolean canManageStepProcessorEnablerAliases()

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

Compliance:

mandatory - This method must be implemented.

aliasStepProcessorEnabler

void aliasStepProcessorEnabler(Id stepProcessorEnablerId,
                             Id aliasId)
                               throws AlreadyExistsException,
                                      NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

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

Parameters:

stepProcessorEnablerId - the Id of a StepProcessorEnabler

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - stepProcessorEnablerId not found

NullArgumentException - stepProcessorEnablerId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.