public interface StepConstrainerOfficeSession extends OsidSession
This session provides methods to retrieve StepConstrainer
to Office
mappings. a StepConstrainer
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 |
canLookupStepConstrainerOfficeMappings()
Tests if this user can perform lookups of step constrainer/office
mappings.
|
IdList |
getOfficeIdsByStepConstrainer(Id stepConstrainerId)
Gets the
Office Ids mapped to a
StepConstrainer. |
OfficeList |
getOfficesByStepConstrainer(Id stepConstrainerId)
Gets the
Offices mapped to a StepConstrainer. |
IdList |
getStepConstrainerIdsByOffice(Id officeId)
Gets the list of
StepConstrainerIds associated with an
Office. |
IdList |
getStepConstrainerIdsByOffices(IdList officeIds)
Gets the list of
StepConstrainer Ids corresponding to a
list of Offices. |
StepConstrainerList |
getStepConstrainersByOffice(Id officeId)
Gets the list of step constrainer associated with an
Office. |
StepConstrainerList |
getStepConstrainersByOffices(IdList officeIds)
Gets the list of step constrainer corresponding to a list of
Offices. |
void |
useComparativeStepConstrainerOfficeView()
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 |
usePlenaryStepConstrainerOfficeView()
A complete view of the
StepConstrainer and
Office returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupStepConstrainerOfficeMappings()
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 useComparativeStepConstrainerOfficeView()
mandatory
- This method is must be implemented. void usePlenaryStepConstrainerOfficeView()
StepConstrainer
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 getStepConstrainerIdsByOffice(Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepConstrainerIds
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. StepConstrainerList getStepConstrainersByOffice(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 getStepConstrainerIdsByOffices(IdList officeIds) throws OperationFailedException, PermissionDeniedException
StepConstrainer 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. StepConstrainerList getStepConstrainersByOffices(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 getOfficeIdsByStepConstrainer(Id stepConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Office
Ids
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. OfficeList getOfficesByStepConstrainer(Id stepConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Offices
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.