public interface StepProcessorOfficeSession extends OsidSession
This session provides methods to retrieve StepProcessor
to Office
mappings. a StepProcessor
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 |
canLookupStepProcessorOfficeMappings()
Tests if this user can perform lookups of step processor/office
mappings.
|
IdList |
getOfficeIdsByStepProcessor(Id stepProcessorId)
Gets the
Office Ids mapped to a
StepProcessor. |
OfficeList |
getOfficesByStepProcessor(Id stepProcessorId)
Gets the
Offices mapped to a StepProcessor. |
IdList |
getStepProcessorIdsByOffice(Id officeId)
Gets the list of
StepProcessorIds associated with an
Office. |
IdList |
getStepProcessorIdsByOffices(IdList officeIds)
Gets the list of
StepProcessor Ids corresponding to a
list of Offices. |
StepProcessorList |
getStepProcessorsByOffice(Id officeId)
Gets the list of step processors associated with an
Office. |
StepProcessorList |
getStepProcessorsByOffices(IdList officeIds)
Gets the list of step processor corresponding to a list of
Offices. |
void |
useComparativeStepProcessorOfficeView()
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 |
usePlenaryStepProcessorOfficeView()
A complete view of the
StepProcessor and Office
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupStepProcessorOfficeMappings()
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 useComparativeStepProcessorOfficeView()
mandatory
- This method is must be implemented. void usePlenaryStepProcessorOfficeView()
StepProcessor
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 getStepProcessorIdsByOffice(Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepProcessorIds
associated with an
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. StepProcessorList getStepProcessorsByOffice(Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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 getStepProcessorIdsByOffices(IdList officeIds) throws OperationFailedException, PermissionDeniedException
StepProcessor 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. StepProcessorList getStepProcessorsByOffices(IdList officeIds) throws OperationFailedException, PermissionDeniedException
Offices.
officeIds
- list of office Ids
NullArgumentException
- officeIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getOfficeIdsByStepProcessor(Id stepProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Office
Ids
mapped to a
StepProcessor.
stepProcessorId
- Id
of a StepProcessor
NotFoundException
- stepProcessorId
is
not foundNullArgumentException
- stepProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OfficeList getOfficesByStepProcessor(Id stepProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Offices
mapped to a StepProcessor.
stepProcessorId
- Id
of a StepProcessor
NotFoundException
- stepProcessorId
is
not foundNullArgumentException
- stepProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.