public interface StepConstrainerEnablerOfficeSession extends OsidSession
This session provides methods to retrieve StepConstrainerEnabler
to Office
mappings. a StepConstrainerEnabler
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 |
canLookupStepConstrainerEnablerOfficeMappings()
Tests if this user can perform lookups of step constrainer
enabler/office mappings.
|
IdList |
getOfficeIdsByStepConstrainerEnabler(Id stepConstrainerEnablerId)
Gets the
Office Ids mapped to a
StepConstrainerEnabler. |
OfficeList |
getOfficesByStepConstrainerEnabler(Id stepConstrainerEnablerId)
Gets the
Offices mapped to a
StepConstrainerEnabler. |
IdList |
getStepConstrainerEnablerIdsByOffice(Id officeId)
Gets the list of
StepConstrainerEnablerIds associated
with an Office. |
IdList |
getStepConstrainerEnablerIdsByOffices(IdList officeIds)
Gets the list of
StepConstrainerEnabler Ids
corresponding to a list of Offices. |
StepConstrainerEnablerList |
getStepConstrainerEnablersByOffice(Id officeId)
Gets the list of step constrainer enablers associated with an
Office. |
StepConstrainerEnablerList |
getStepConstrainerEnablersByOffices(IdList officeIds)
Gets the list of step constrainer enablers corresponding to a list of
Offices. |
void |
useComparativeStepConstrainerEnablerOfficeView()
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 |
usePlenaryStepConstrainerEnablerOfficeView()
A complete view of the
StepConstrainerEnabler and
Office returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupStepConstrainerEnablerOfficeMappings()
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 useComparativeStepConstrainerEnablerOfficeView()
mandatory
- This method is must be implemented. void usePlenaryStepConstrainerEnablerOfficeView()
StepConstrainerEnabler
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 getStepConstrainerEnablerIdsByOffice(Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepConstrainerEnablerIds
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. StepConstrainerEnablerList getStepConstrainerEnablersByOffice(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 getStepConstrainerEnablerIdsByOffices(IdList officeIds) throws OperationFailedException, PermissionDeniedException
StepConstrainerEnabler 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. StepConstrainerEnablerList getStepConstrainerEnablersByOffices(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 getOfficeIdsByStepConstrainerEnabler(Id stepConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Office
Ids
mapped to a
StepConstrainerEnabler.
stepConstrainerEnablerId
- Id
of a
StepConstrainerEnabler
NotFoundException
- stepConstrainerEnablerId
is not foundNullArgumentException
- stepConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. OfficeList getOfficesByStepConstrainerEnabler(Id stepConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Offices
mapped to a
StepConstrainerEnabler.
stepConstrainerEnablerId
- Id
of a
StepConstrainerEnabler
NotFoundException
- stepConstrainerEnablerId
is not foundNullArgumentException
- stepConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.