org.osid.workflow.rules

Interface StepConstrainerEnablerAdminSession

All Superinterfaces:

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

public interface StepConstrainerEnablerAdminSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	aliasStepConstrainerEnabler(Id stepConstrainerEnablerId, Id aliasId) Adds a Id to a StepConstrainerEnabler for the purpose of creating compatibility.
boolean	canCreateStepConstrainerEnabler() Tests if this user can create step constrainer enablers.
boolean	canCreateStepConstrainerEnablerWithRecordTypes(Type[] stepConstrainerEnablerRecordTypes) Tests if this user can create a single StepConstrainerEnabler using the desired record types.
boolean	canDeleteStepConstrainerEnablers() Tests if this user can delete step constrainer enablers.
boolean	canManageStepConstrainerEnablerAliases() Tests if this user can manage Id aliases for step constrainer enablers.
boolean	canUpdateStepConstrainerEnablers() Tests if this user can update step constrainer enablers.
StepConstrainerEnabler	createStepConstrainerEnabler(StepConstrainerEnablerForm stepConstrainerEnablerForm) Creates a new StepConstrainerEnabler.
void	deleteStepConstrainerEnabler(Id stepConstrainerEnablerId) Deletes a StepConstrainerEnabler.
Office	getOffice() Gets the Office associated with this session.
Id	getOfficeId() Gets the Office Id associated with this session.
StepConstrainerEnablerForm	getStepConstrainerEnablerFormForCreate(Type[] stepConstrainerEnablerRecordTypes) Gets the step constrainer enabler form for creating new step constrainer enablers.
StepConstrainerEnablerForm	getStepConstrainerEnablerFormForUpdate(Id stepConstrainerEnablerId) Gets the step constrainer enabler form for updating an existing step constrainer enabler.
void	updateStepConstrainerEnabler(StepConstrainerEnablerForm stepConstrainerEnablerForm) Updates an existing step 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

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.

canCreateStepConstrainerEnabler

boolean canCreateStepConstrainerEnabler()

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

Compliance:

mandatory - This method must be implemented.

canCreateStepConstrainerEnablerWithRecordTypes

boolean canCreateStepConstrainerEnablerWithRecordTypes(Type[] stepConstrainerEnablerRecordTypes)

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

Parameters:

stepConstrainerEnablerRecordTypes - array of step constrainer enabler record types

Returns:

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

Throws:

NullArgumentException - stepConstrainerEnablerRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getStepConstrainerEnablerFormForCreate

StepConstrainerEnablerForm getStepConstrainerEnablerFormForCreate(Type[] stepConstrainerEnablerRecordTypes)
                                                                  throws OperationFailedException,
                                                                         PermissionDeniedException

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

Parameters:

stepConstrainerEnablerRecordTypes - array of step constrainer enabler record types

Returns:

the step constrainer enabler form

Throws:

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

createStepConstrainerEnabler

StepConstrainerEnabler createStepConstrainerEnabler(StepConstrainerEnablerForm stepConstrainerEnablerForm)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Creates a new StepConstrainerEnabler.

Parameters:

stepConstrainerEnablerForm - the form for this StepConstrainerEnabler

Returns:

the new StepConstrainerEnabler

Throws:

IllegalStateException - stepConstrainerEnablerForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - stepConstrainerEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - stepConstrainerEnablerForm did not originate from getStepConstrainerEnablerFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateStepConstrainerEnablers

boolean canUpdateStepConstrainerEnablers()

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

Compliance:

mandatory - This method must be implemented.

getStepConstrainerEnablerFormForUpdate

StepConstrainerEnablerForm getStepConstrainerEnablerFormForUpdate(Id stepConstrainerEnablerId)
                                                                  throws NotFoundException,
                                                                         OperationFailedException,
                                                                         PermissionDeniedException

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

Parameters:

stepConstrainerEnablerId - the Id of the StepConstrainerEnabler

Returns:

the step constrainer enabler form

Throws:

NotFoundException - stepConstrainerEnablerId is not found

NullArgumentException - stepConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateStepConstrainerEnabler

void updateStepConstrainerEnabler(StepConstrainerEnablerForm stepConstrainerEnablerForm)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Updates an existing step constrainer enabler.

Parameters:

stepConstrainerEnablerForm - the form containing the elements to be updated

Throws:

IllegalStateException - stepConstrainerEnablerForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - stepConstrainerEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - stepConstrainerEnablerForm did not originate from getStepConstrainerEnablerFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteStepConstrainerEnablers

boolean canDeleteStepConstrainerEnablers()

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

Compliance:

mandatory - This method must be implemented.

deleteStepConstrainerEnabler

void deleteStepConstrainerEnabler(Id stepConstrainerEnablerId)
                                  throws NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Deletes a StepConstrainerEnabler.

Parameters:

stepConstrainerEnablerId - the Id of the StepConstrainerEnabler to remove

Throws:

NotFoundException - stepConstrainerEnablerId not found

NullArgumentException - stepConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageStepConstrainerEnablerAliases

boolean canManageStepConstrainerEnablerAliases()

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

Compliance:

mandatory - This method must be implemented.

aliasStepConstrainerEnabler

void aliasStepConstrainerEnabler(Id stepConstrainerEnablerId,
                               Id aliasId)
                                 throws AlreadyExistsException,
                                        NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

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

Parameters:

stepConstrainerEnablerId - the Id of a StepConstrainerEnabler

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - stepConstrainerEnablerId not found

NullArgumentException - stepConstrainerEnablerId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.