public interface StepConstrainerEnablerLookupSession extends OsidSession
This session provides methods for retrieving
StepConstrainerEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
StepConstrainerEnablers
with the StepConstrainerEnablerAdminSession.
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 |
canLookupStepConstrainerEnablers()
Tests if this user can perform
StepConstrainerEnablers
lookups. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
StepConstrainerEnabler |
getStepConstrainerEnabler(Id stepConstrainerEnablerId)
Gets the
StepConstrainerEnabler specified by its
Id. |
StepConstrainerEnablerList |
getStepConstrainerEnablers()
Gets all
StepConstrainerEnablers. |
StepConstrainerEnablerList |
getStepConstrainerEnablersByGenusType(Type stepConstrainerEnablerGenusType)
Gets a
StepConstrainerEnablerList corresponding to the
given step constrainer enabler genus Type which does
not include step constrainer enablers of genus types derived from the
specified Type. |
StepConstrainerEnablerList |
getStepConstrainerEnablersByIds(IdList stepConstrainerEnablerIds)
Gets a
StepConstrainerEnablerList corresponding to the
given IdList. |
StepConstrainerEnablerList |
getStepConstrainerEnablersByParentGenusType(Type stepConstrainerEnablerGenusType)
Gets a
StepConstrainerEnablerList corresponding to the
given step constrainer enabler genus Type and include
any additional step constrainer enablers with genus types derived from
the specified Type. |
StepConstrainerEnablerList |
getStepConstrainerEnablersByRecordType(Type stepConstrainerEnablerRecordType)
Gets a
StepConstrainerEnablerList containing the given
step constrainer enabler record Type. |
StepConstrainerEnablerList |
getStepConstrainerEnablersOnDate(DateTime from,
DateTime to)
Gets a
StepConstrainerEnablerList that are effective
for the entire given date range inclusive but not confined to the date
range for any agent. |
StepConstrainerEnablerList |
getStepConstrainerEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
StepConstrainerEnablerList that are effective
for the entire given date range inclusive but not confined to the date
range and evaluated against the given agent. |
void |
useActiveStepConstrainerEnablerView()
Only active step constrainer enablers are returned by methods in this
session.
|
void |
useAnyStatusStepConstrainerEnablerView()
All active and inactive step constrainer enablers are returned by
methods in this session.
|
void |
useComparativeStepConstrainerEnablerView()
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 |
usePlenaryStepConstrainerEnablerView()
A complete view of the
StepConstrainerEnabler 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 canLookupStepConstrainerEnablers()
StepConstrainerEnablers
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 useComparativeStepConstrainerEnablerView()
mandatory
- This method is must be implemented. void usePlenaryStepConstrainerEnablerView()
StepConstrainerEnabler
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 useActiveStepConstrainerEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusStepConstrainerEnablerView()
mandatory
- This method is must be implemented. StepConstrainerEnabler getStepConstrainerEnabler(Id stepConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepConstrainerEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
StepConstrainerEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a StepConstrainerEnabler
and retained
for compatibility.
In active mode, step constrainer enablers are returned that are
currently active. In any status mode, active and inactive step
constrainer enablers are returned.stepConstrainerEnablerId
- Id
of the
StepConstrainerEnabler
NotFoundException
- stepConstrainerEnablerId
not foundNullArgumentException
- stepConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. StepConstrainerEnablerList getStepConstrainerEnablersByIds(IdList stepConstrainerEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepConstrainerEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
step constrainer 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 StepConstrainerEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, step constrainer enablers are returned that are
currently active. In any status mode, active and inactive step
constrainer enablers are returned.stepConstrainerEnablerIds
- the list of Ids
to
retrieve StepConstrainerEnabler
listNotFoundException
- a Id
was not foundNullArgumentException
-
stepConstrainerEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepConstrainerEnablerList getStepConstrainerEnablersByGenusType(Type stepConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
StepConstrainerEnablerList
corresponding to the
given step constrainer enabler genus Type
which does
not include step constrainer enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
step constrainer enablers or an error results. Otherwise, the returned
list may contain only those step constrainer enablers that are
accessible through this session.
In active mode, step constrainer enablers are returned that are
currently active. In any status mode, active and inactive step
constrainer enablers are returned.stepConstrainerEnablerGenusType
- a step constrainer enabler
genus type StepConstrainerEnabler
listNullArgumentException
-
stepConstrainerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepConstrainerEnablerList getStepConstrainerEnablersByParentGenusType(Type stepConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
StepConstrainerEnablerList
corresponding to the
given step constrainer enabler genus Type
and include
any additional step constrainer enablers with genus types derived from
the specified Type.
In plenary mode, the returned list contains all known
step constrainer enablers or an error results. Otherwise, the returned
list may contain only those step constrainer enablers that are
accessible through this session.
In active mode, step constrainer enablers are returned that are
currently active. In any status mode, active and inactive step
constrainer enablers are returned.stepConstrainerEnablerGenusType
- a step constrainer enabler
genus type StepConstrainerEnabler
listNullArgumentException
-
stepConstrainerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepConstrainerEnablerList getStepConstrainerEnablersByRecordType(Type stepConstrainerEnablerRecordType) throws OperationFailedException, PermissionDeniedException
StepConstrainerEnablerList
containing the given
step constrainer enabler record Type.
In plenary mode, the returned list contains all known
step constrainer enablers or an error results. Otherwise, the returned
list may contain only those step constrainer enablers that are
accessible through this session.
In active mode, step constrainer enablers are returned that are
currently active. In any status mode, active and inactive step
constrainer enablers are returned.stepConstrainerEnablerRecordType
- a step constrainer enabler
record type StepConstrainerEnabler
listNullArgumentException
-
stepConstrainerEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepConstrainerEnablerList getStepConstrainerEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
StepConstrainerEnablerList
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 constrainer enablers or an error results. Otherwise, the returned
list may contain only those step constrainer enablers that are
accessible through this session.
In active mode, step constrainer enablers are returned that are
currently active. In any status mode, active and inactive step
constrainer enablers are returned.from
- a start dateto
- an end date StepConstrainerEnabler
listInvalidArgumentException
- from
is
greater tha to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. StepConstrainerEnablerList getStepConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
StepConstrainerEnablerList
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 constrainer enablers or an error results. Otherwise, the returned
list may contain only those step constrainer enablers that are
accessible through this session.
In active mode, step constrainer enablers are returned that are
currently active. In any status mode, active and inactive step
constrainer enablers are returned.agentId
- an agent Id
from
- a start dateto
- an end date StepConstrainerEnabler
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. StepConstrainerEnablerList getStepConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
StepConstrainerEnablers.
In plenary mode, the returned list contains all known step constrainer
enablers or an error results. Otherwise, the returned list may contain
only those step constrainer enablers that are accessible through this
session.
In active mode, step constrainer enablers are returned that are
currently active. In any status mode, active and inactive step
constrainer enablers are returned. StepConstrainerEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.