public interface StepProcessorEnablerLookupSession extends OsidSession
This session provides methods for retrieving
StepProcessorEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
StepProcessorEnablers
with the
StepProcessorEnablerAdminSession.
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 |
canLookupStepProcessorEnablers()
Tests if this user can perform
StepProcessorEnablers
lookups. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
StepProcessorEnabler |
getStepProcessorEnabler(Id stepProcessorEnablerId)
Gets the
StepProcessorEnabler specified by its
Id. |
StepProcessorEnablerList |
getStepProcessorEnablers()
Gets all
StepProcessorEnablers. |
StepProcessorEnablerList |
getStepProcessorEnablersByGenusType(Type stepProcessorEnablerGenusType)
Gets a
StepProcessorEnablerList corresponding to the
given step processor enabler genus Type which does not
include step processor enablers of genus types derived from the
specified Type. |
StepProcessorEnablerList |
getStepProcessorEnablersByIds(IdList stepProcessorEnablerIds)
Gets a
StepProcessorEnablerList corresponding to the
given IdList. |
StepProcessorEnablerList |
getStepProcessorEnablersByParentGenusType(Type stepProcessorEnablerGenusType)
Gets a
StepProcessorEnablerList corresponding to the
given step processor enabler genus Type and include any
additional step processor enablers with genus types derived from the
specified Type. |
StepProcessorEnablerList |
getStepProcessorEnablersByRecordType(Type stepProcessorEnablerRecordType)
Gets a
StepProcessorEnablerList containing the given
step processor enabler record Type. |
StepProcessorEnablerList |
getStepProcessorEnablersOnDate(DateTime from,
DateTime to)
Gets a
StepProcessorEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range for any agent. |
StepProcessorEnablerList |
getStepProcessorEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
StepProcessorEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range and evaluated against the given agent. |
void |
useActiveStepProcessorEnablerView()
Only active step processor enablers are returned by methods in this
session.
|
void |
useAnyStatusStepProcessorEnablerView()
All active and inactive step processor enablers are returned by
methods in this session.
|
void |
useComparativeStepProcessorEnablerView()
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 |
usePlenaryStepProcessorEnablerView()
A complete view of the
StepProcessorEnabler 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 canLookupStepProcessorEnablers()
StepProcessorEnablers
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 useComparativeStepProcessorEnablerView()
mandatory
- This method is must be implemented. void usePlenaryStepProcessorEnablerView()
StepProcessorEnabler
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 useActiveStepProcessorEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusStepProcessorEnablerView()
mandatory
- This method is must be implemented. StepProcessorEnabler getStepProcessorEnabler(Id stepProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepProcessorEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
StepProcessorEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a StepProcessorEnabler
and retained for
compatibility.
In active mode, step processor enablers are returned that are
currently active. In any status mode, active and inactive step
processors enablers are returned.stepProcessorEnablerId
- Id
of the
StepProcessorEnabler
NotFoundException
- stepProcessorEnablerId
not foundNullArgumentException
- stepProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. StepProcessorEnablerList getStepProcessorEnablersByIds(IdList stepProcessorEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepProcessorEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
step processor enablers 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 StepProcessorEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, step processor enablers are returned that are
currently active. In any status mode, active and inactive step
processors enablers are returned.stepProcessorEnablerIds
- the list of Ids
to
retrieve StepProcessorEnabler
listNotFoundException
- a Id
was not foundNullArgumentException
- stepProcessorEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepProcessorEnablerList getStepProcessorEnablersByGenusType(Type stepProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
StepProcessorEnablerList
corresponding to the
given step processor enabler genus Type
which does not
include step processor enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
step processor enablers or an error results. Otherwise, the returned
list may contain only those step processor enablers that are
accessible through this session.
In active mode, step processor enablers are returned that are
currently active. In any status mode, active and inactive step
processors enablers are returned.stepProcessorEnablerGenusType
- a step processor enabler genus
type StepProcessorEnabler
listNullArgumentException
-
stepProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepProcessorEnablerList getStepProcessorEnablersByParentGenusType(Type stepProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
StepProcessorEnablerList
corresponding to the
given step processor enabler genus Type
and include any
additional step processor enablers with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
step processor enablers or an error results. Otherwise, the returned
list may contain only those step processor enablers that are
accessible through this session.
In active mode, step processor enablers are returned that are
currently active. In any status mode, active and inactive step
processors enablers are returned.stepProcessorEnablerGenusType
- a step processor enabler genus
type StepProcessorEnabler
listNullArgumentException
-
stepProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepProcessorEnablerList getStepProcessorEnablersByRecordType(Type stepProcessorEnablerRecordType) throws OperationFailedException, PermissionDeniedException
StepProcessorEnablerList
containing the given
step processor enabler record Type.
In plenary mode, the returned list contains all known
step processor enablers or an error results. Otherwise, the returned
list may contain only those step processor enablers that are
accessible through this session.
In active mode, step processor enablers are returned that are
currently active. In any status mode, active and inactive step
processors enablers are returned.stepProcessorEnablerRecordType
- a step processor enabler record
type StepProcessorEnabler
listNullArgumentException
-
stepProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepProcessorEnablerList getStepProcessorEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
StepProcessorEnablerList
that are effective for
the entire given date range inclusive but not confined to the date
range for any agent.
In plenary mode, the returned list contains all known
step processor enablers or an error results. Otherwise, the returned
list may contain only those step processor enablers that are
accessible through this session.
In active mode, step processor enablers are returned that are
currently active. In any status mode, active and inactive step
processors enablers are returned.from
- a start dateto
- an end date StepProcessorEnabler
listInvalidArgumentException
- from
is
greater tha to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepProcessorEnablerList getStepProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
StepProcessorEnablerList
that are effective for
the entire given date range inclusive but not confined to the date
range and evaluated against the given agent.
In plenary mode, the returned list contains all known
step processor enablers or an error results. Otherwise, the returned
list may contain only those step processor enablers that are
accessible through this session.
In active mode, step processor enablers are returned that are
currently active. In any status mode, active and inactive step
processors enablers are returned.agentId
- an agent Id
from
- a start dateto
- an end date StepProcessorEnabler
listInvalidArgumentException
- from
is
greater tha to
NullArgumentException
- agentId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepProcessorEnablerList getStepProcessorEnablers() throws OperationFailedException, PermissionDeniedException
StepProcessorEnablers.
In plenary mode, the returned list contains all known step processor
enablers or an error results. Otherwise, the returned list may contain
only those step processor enablers that are accessible through this
session.
In active mode, step processor enablers are returned that are
currently active. In any status mode, active and inactive step
processors enablers are returned. StepProcessorEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.