public interface StepConstrainerRuleLookupSession extends OsidSession
This session provides methods to retrieve StepConstrainer
to Step
mappings. A Step
with
multiple StepConstrainers
means any positive rule
evaluation across the constrainers result in an accessible Step.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupStepConstrainerRules()
Tests if this user can perform lookups of step constrainer/step
mappings.
|
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
IdList |
getStepConstrainerIdsForStep(Id stepId)
Gets the
StepConstrainer Id associated with a
Step. |
StepConstrainerList |
getStepConstrainersForStep(Id stepId)
Gets the
StepConstrainer associated with a Step. |
IdList |
getStepIdsForStepConstrainer(Id stepConstrainerId)
Gets the
Step Ids mapped to a
StepConstrainer. |
StepList |
getStepsForStepConstrainer(Id stepConstrainerId)
Gets the
Steps mapped to a StepConstrainer. |
void |
useComparativeStepConstrainerRuleView()
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 |
usePlenaryStepConstrainerRuleView()
A complete view of the
StepConstrainer and Step
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOfficeId()
Office
Id
associated with this
session. Office Id
associated with this sessionmandatory
- This method must be implemented. Office getOffice() throws OperationFailedException, PermissionDeniedException
Office
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupStepConstrainerRules()
PERMISSION_DENIED.
This is intended as a hint to an application that may opt not
to offer lookup operations to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeStepConstrainerRuleView()
mandatory
- This method is must be implemented. void usePlenaryStepConstrainerRuleView()
StepConstrainer
and Step
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.mandatory
- This method is must be implemented. void useFederatedOfficeView()
mandatory
- This method is must be implemented. void useIsolatedOfficeView()
mandatory
- This method is must be implemented. IdList getStepConstrainerIdsForStep(Id stepId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepConstrainer Id
associated with a
Step.
stepId
- Id
of the Step
Ids
NotFoundException
- stepId
is not foundNullArgumentException
- stepId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepConstrainerList getStepConstrainersForStep(Id stepId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepConstrainer
associated with a Step.
stepId
- Id
of the Step
NotFoundException
- stepId
is not foundNullArgumentException
- stepId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getStepIdsForStepConstrainer(Id stepConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Step
Ids
mapped to a
StepConstrainer.
stepConstrainerId
- Id
of a
StepConstrainer
Ids
NotFoundException
- stepConstrainerId
is
not foundNullArgumentException
- stepConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepList getStepsForStepConstrainer(Id stepConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Steps
mapped to a StepConstrainer.
stepConstrainerId
- Id
of a
StepConstrainer
NotFoundException
- stepConstrainerId
is
not foundNullArgumentException
- stepConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.