org.osid.workflow.rules

Interface StepConstrainerEnablerRuleLookupSession

All Superinterfaces:

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

public interface StepConstrainerEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve StepConstrainerEnabler to StepConstrainer mappings. a Step with multiple StepConstrainerEnablers means any positive rule evaluation across the enablers result in an effective StepConstrainer.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition
• isolated office view: All methods in this session operate, retrieve and pertain step constrainer enablers defined explicitly in the current office
• federated office view: All methods in this session operate, retrieve and pertain to all step constrainer enablers defined in this office and any other step constrainer enablers implicitly available in this office through office inheritence.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupStepConstrainerEnablerRules() Tests if this user can perform lookups of step constrainer enabler/step constrainer mappings.
Office	getOffice() Gets the Office associated with this session.
Id	getOfficeId() Gets the Office Id associated with this session.
IdList	getStepConstrainerEnablerIdsForStepConstrainer(Id stepConstrainerId) Gets the StepConstrainerEnabler Id associated with a StepConstrainer.
StepConstrainerEnablerList	getStepConstrainerEnablersForStepConstrainer(Id stepConstrainerId) Gets the StepConstrainerEnablers associated with a StepConstrainer.
IdList	getStepConstrainerIdsForStepConstrainerEnabler(Id stepConstrainerEnablerId) Gets the StepConstrainer Ids mapped to a StepConstrainerEnabler.
StepConstrainerList	getStepConstrainersForStepConstrainerEnabler(Id stepConstrainerEnablerId) Gets the StepConstrainers mapped to a StepConstrainerEnabler.
void	useComparativeStepConstrainerEnablerRuleView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedOfficeView() Federates the view for methods in this session.
void	useIsolatedOfficeView() Isolates the view for methods in this session.
void	usePlenaryStepConstrainerEnablerRuleView() A complete view of the StepConstrainerEnabler and StepConstrainer returns is desired.

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.

canLookupStepConstrainerEnablerRules

boolean canLookupStepConstrainerEnablerRules()

Tests if this user can perform lookups of step constrainer enabler/step constrainer mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeStepConstrainerEnablerRuleView

void useComparativeStepConstrainerEnablerRuleView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryStepConstrainerEnablerRuleView

void usePlenaryStepConstrainerEnablerRuleView()

A complete view of the StepConstrainerEnabler and StepConstrainer returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

useFederatedOfficeView

void useFederatedOfficeView()

Federates the view for methods in this session. A federated view will include step constrainer enablers in offices which are children of this office in the office hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedOfficeView

void useIsolatedOfficeView()

Isolates the view for methods in this session. An isolated view restricts lookups to this office only.

Compliance:

mandatory - This method is must be implemented.

getStepConstrainerEnablerIdsForStepConstrainer

IdList getStepConstrainerEnablerIdsForStepConstrainer(Id stepConstrainerId)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Gets the StepConstrainerEnabler Id associated with a StepConstrainer.

Parameters:

stepConstrainerId - Id of the StepConstrainer

Returns:

the step constrainer enabler Ids

Throws:

NotFoundException - stepConstrainerId is not found

NullArgumentException - stepConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepConstrainerEnablersForStepConstrainer

StepConstrainerEnablerList getStepConstrainerEnablersForStepConstrainer(Id stepConstrainerId)
                                                                        throws NotFoundException,
                                                                               OperationFailedException,
                                                                               PermissionDeniedException

Gets the StepConstrainerEnablers associated with a StepConstrainer.

Parameters:

stepConstrainerId - Id of the StepConstrainer

Returns:

the step constrainer enablers

Throws:

NotFoundException - stepConstrainerId is not found

NullArgumentException - stepConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepConstrainerIdsForStepConstrainerEnabler

IdList getStepConstrainerIdsForStepConstrainerEnabler(Id stepConstrainerEnablerId)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Gets the StepConstrainer Ids mapped to a StepConstrainerEnabler.

Parameters:

stepConstrainerEnablerId - Id of a StepConstrainerEnabler

Returns:

list of step constrainer Ids

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.

getStepConstrainersForStepConstrainerEnabler

StepConstrainerList getStepConstrainersForStepConstrainerEnabler(Id stepConstrainerEnablerId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException,
                                                                        PermissionDeniedException

Gets the StepConstrainers mapped to a StepConstrainerEnabler.

Parameters:

stepConstrainerEnablerId - Id of a StepConstrainerEnabler

Returns:

list of step constrainers

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.