public interface StepProcessorEnablerOfficeSession extends OsidSession
This session provides methods to retrieve StepProcessorEnabler
to Office
mappings. a StepProcessorEnabler
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 |
canLookupStepProcessorEnablerOfficeMappings()
Tests if this user can perform lookups of step processor
enabler/office mappings.
|
IdList |
getOfficeIdsByStepProcessorEnabler(Id stepProcessorEnablerId)
Gets the
Office Ids mapped to a
StepProcessorEnabler. |
OfficeList |
getOfficesByStepProcessorEnabler(Id stepProcessorEnablerId)
Gets the
Offices mapped to a
StepProcessorEnabler. |
IdList |
getStepProcessorEnablerIdsByOffice(Id officeId)
Gets the list of
StepProcessorEnablerIds associated
with an Office. |
IdList |
getStepProcessorEnablerIdsByOffices(IdList officeIds)
Gets the list of
StepProcessorEnabler Ids corresponding
to a list of Offices. |
StepProcessorEnablerList |
getStepProcessorEnablersByOffice(Id officeId)
Gets the list of step processor enablers associated with an
Office. |
StepProcessorEnablerList |
getStepProcessorEnablersByOffices(IdList officeIds)
Gets the list of step processor enablers corresponding to a list of
Offices. |
void |
useComparativeStepProcessorEnablerOfficeView()
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 |
usePlenaryStepProcessorEnablerOfficeView()
A complete view of the
StepProcessorEnabler and
Office returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupStepProcessorEnablerOfficeMappings()
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 useComparativeStepProcessorEnablerOfficeView()
mandatory
- This method is must be implemented. void usePlenaryStepProcessorEnablerOfficeView()
StepProcessorEnabler
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 getStepProcessorEnablerIdsByOffice(Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepProcessorEnablerIds
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. StepProcessorEnablerList getStepProcessorEnablersByOffice(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 getStepProcessorEnablerIdsByOffices(IdList officeIds) throws OperationFailedException, PermissionDeniedException
StepProcessorEnabler 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. StepProcessorEnablerList getStepProcessorEnablersByOffices(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 getOfficeIdsByStepProcessorEnabler(Id stepProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Office
Ids
mapped to a
StepProcessorEnabler.
stepProcessorEnablerId
- Id
of a
StepProcessorEnabler
NotFoundException
- stepProcessorEnablerId
is not foundNullArgumentException
- stepProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OfficeList getOfficesByStepProcessorEnabler(Id stepProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Offices
mapped to a
StepProcessorEnabler.
stepProcessorEnablerId
- Id
of a
StepProcessorEnabler
NotFoundException
- stepProcessorEnablerId
is not foundNullArgumentException
- stepProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.