public interface StepConstrainerLookupSession extends OsidSession
This session provides methods for retrieving StepConstrainers.
This session defines views that offer differing behaviors when retrieving multiple objects.
StepConstrainers
with the
StepConstrainerAdminSession.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. The
methods useFederatedOfficeView()
and
useIsolatedOfficeView()
behave as a radio group and one should be
selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupStepConstrainers()
Tests if this user can perform
StepConstrainers
lookups. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
StepConstrainer |
getStepConstrainer(Id stepConstrainerId)
Gets the
StepConstrainer specified by its Id. |
StepConstrainerList |
getStepConstrainers()
Gets all
StepConstrainers. |
StepConstrainerList |
getStepConstrainersByGenusType(Type stepConstrainerGenusType)
Gets a
StepConstrainerList corresponding to the given
step constrainer genus Type which does not include step
constrainer of genus types derived from the specified Type. |
StepConstrainerList |
getStepConstrainersByIds(IdList stepConstrainerIds)
Gets a
StepConstrainerList corresponding to the given
IdList. |
StepConstrainerList |
getStepConstrainersByParentGenusType(Type stepConstrainerGenusType)
Gets a
StepConstrainerList corresponding to the given
step constrainer genus Type and include any additional
step constrainer with genus types derived from the specified
Type. |
StepConstrainerList |
getStepConstrainersByRecordType(Type stepConstrainerRecordType)
Gets a
StepConstrainerList containing the given step
constrainer record Type. |
void |
useActiveStepConstrainerView()
Only active step constrainers are returned by methods in this session.
|
void |
useAnyStatusStepConstrainerView()
All active and inactive step constrainers are returned by methods in
this session.
|
void |
useComparativeStepConstrainerView()
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 |
useFederatedOfficeView()
Federates the view for methods in this session.
|
void |
useIsolatedOfficeView()
Isolates the view for methods in this session.
|
void |
usePlenaryStepConstrainerView()
A complete view of the
StepConstrainer returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOfficeId()
Office
Id
associated with this
session. Office Id
associated with this sessionmandatory
- This method must be implemented. Office getOffice() throws OperationFailedException, PermissionDeniedException
Office
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupStepConstrainers()
StepConstrainers
lookups. A return of true does not guarantee successful authorization.
A return of false indicates that it is known all methods in this
session will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer lookup
operations to unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeStepConstrainerView()
mandatory
- This method is must be implemented. void usePlenaryStepConstrainerView()
StepConstrainer
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. void useFederatedOfficeView()
mandatory
- This method is must be implemented. void useIsolatedOfficeView()
mandatory
- This method is must be implemented. void useActiveStepConstrainerView()
mandatory
- This method is must be implemented. void useAnyStatusStepConstrainerView()
mandatory
- This method is must be implemented. StepConstrainer getStepConstrainer(Id stepConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepConstrainer
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
StepConstrainer
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a StepConstrainer
and retained for
compatibility.
In active mode, step constrainers are returned that are currently
active. In any status mode, active and inactive step constrainers are
returned.stepConstrainerId
- Id
of the
StepConstrainer
NotFoundException
- stepConstrainerId
not foundNullArgumentException
- stepConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. StepConstrainerList getStepConstrainersByIds(IdList stepConstrainerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepConstrainerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
step constrainer specified in the Id
list, in the order
of the list, including duplicates, or an error results if a Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible StepConstrainers
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In active mode, step constrainers are returned that are currently
active. In any status mode, active and inactive step constrainers are
returned.stepConstrainerIds
- the list of Ids
to retrieve StepConstrainer
listNotFoundException
- a Id
was not foundNullArgumentException
- stepConstrainerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepConstrainerList getStepConstrainersByGenusType(Type stepConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
StepConstrainerList
corresponding to the given
step constrainer genus Type
which does not include step
constrainer of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
step constrainer or an error results. Otherwise, the returned list may
contain only those step constrainer that are accessible through this
session.
In active mode, step constrainers are returned that are currently
active. In any status mode, active and inactive step constrainers are
returned.stepConstrainerGenusType
- a step constrainer genus type StepConstrainer
listNullArgumentException
- stepConstrainerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepConstrainerList getStepConstrainersByParentGenusType(Type stepConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
StepConstrainerList
corresponding to the given
step constrainer genus Type
and include any additional
step constrainer with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
step constrainer or an error results. Otherwise, the returned list may
contain only those step constrainer that are accessible through this
session.
In active mode, step constrainers are returned that are currently
active. In any status mode, active and inactive step constrainers are
returned.stepConstrainerGenusType
- a step constrainer genus type StepConstrainer
listNullArgumentException
- stepConstrainerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepConstrainerList getStepConstrainersByRecordType(Type stepConstrainerRecordType) throws OperationFailedException, PermissionDeniedException
StepConstrainerList
containing the given step
constrainer record Type.
In plenary mode, the returned list contains all known
step constrainer or an error results. Otherwise, the returned list may
contain only those step constrainer that are accessible through this
session.
In active mode, step constrainers are returned that are currently
active. In any status mode, active and inactive step constrainers are
returned.stepConstrainerRecordType
- a step constrainer record type StepConstrainer
listNullArgumentException
-
stepConstrainerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepConstrainerList getStepConstrainers() throws OperationFailedException, PermissionDeniedException
StepConstrainers.
In plenary mode, the returned list contains all known step constrainer
or an error results. Otherwise, the returned list may contain only
those step constrainer that are accessible through this session.
In active mode, step constrainers are returned that are currently
active. In any status mode, active and inactive step constrainers are
returned. StepConstrainer
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.