public interface StepOfficeSession extends OsidSession
This session provides methods to retrieve Step
to
Office
workflows. A Step
may appear in multiple
Office
objects. Each office may have its own authorizations
governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupStepOfficeMappings()
Tests if this user can perform lookups of step/office mappings.
|
IdList |
getOfficeIdsByStep(Id stepId)
Gets the
Office Ids mapped to a
Step. |
OfficeList |
getOfficesByStep(Id stepId)
Gets the
Offices mapped to a Step. |
StepList |
getStepesByOffice(Id officeId)
Gets the list of
Steps associated with a Office. |
IdList |
getStepIdsByOffice(Id officeId)
Gets the list of
Step Ids associated with a
Office. |
IdList |
getStepIdsByOffices(IdList officeIds)
Gets the list of
Step Ids corresponding to a list of
Offices. |
StepList |
getStepsByOffices(IdList officeIds)
Gets the list of
Steps corresponding to a list of
Offices. |
void |
useComparativeStepOfficeView()
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 |
usePlenaryStepOfficeView()
A complete view of the
Step and Office
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupStepOfficeMappings()
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 useComparativeStepOfficeView()
mandatory
- This method is must be implemented. void usePlenaryStepOfficeView()
Step
and Office
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. IdList getStepIdsByOffice(Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Step Ids
associated with a
Office.
officeId
- Id
of the Office
Ids
NotFoundException
- officeId
is not
foundNullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepList getStepesByOffice(Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Steps
associated with a Office.
officeId
- Id
of the Office
NotFoundException
- officeId
is not
foundNullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getStepIdsByOffices(IdList officeIds) throws OperationFailedException, PermissionDeniedException
Step Ids
corresponding to a list of
Offices.
officeIds
- list of office Ids
Ids
NullArgumentException
- officeIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepList getStepsByOffices(IdList officeIds) throws OperationFailedException, PermissionDeniedException
Steps
corresponding to a list of
Offices.
officeIds
- list of office Ids
NullArgumentException
- officeIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getOfficeIdsByStep(Id stepId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Office
Ids
mapped to a
Step.
stepId
- Id
of a Step
NotFoundException
- stepId
is not foundNullArgumentException
- stepId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OfficeList getOfficesByStep(Id stepId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Offices
mapped to a Step.
stepId
- Id
of a Step
NotFoundException
- stepId
is not foundNullArgumentException
- stepId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.