public interface ProcessEnablerLookupSession extends OsidSession
This session provides methods for retrieving ProcessEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
ProcessEnablers
with the
ProcessEnablerAdminSession.
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 |
canLookupProcessEnablers()
Tests if this user can perform
ProcessEnablers lookups. |
Office |
getOffice()
Gets the
Office associated with this session. |
Id |
getOfficeId()
Gets the
Office Id associated with this
session. |
ProcessEnabler |
getProcessEnabler(Id processEnablerId)
Gets the
ProcessEnabler specified by its Id. |
ProcessEnablerList |
getProcessEnablers()
Gets all
ProcessEnablers. |
ProcessEnablerList |
getProcessEnablersByGenusType(Type processEnablerGenusType)
Gets a
ProcessEnablerList corresponding to the given
process enabler genus Type which does not include
process enabler of genus types derived from the specified Type. |
ProcessEnablerList |
getProcessEnablersByIds(IdList processEnablerIds)
Gets a
ProcessEnablerList corresponding to the given
IdList. |
ProcessEnablerList |
getProcessEnablersByParentGenusType(Type processEnablerGenusType)
Gets a
ProcessEnablerList corresponding to the given
process enabler genus Type and include any additional
process enabler with genus types derived from the specified
Type. |
ProcessEnablerList |
getProcessEnablersByRecordType(Type processEnablerRecordType)
Gets a
ProcessEnablerList containing the given process
enabler record Type. |
ProcessEnablerList |
getProcessEnablersOnDate(DateTime from,
DateTime to)
Gets a
ProcessEnablerList that are effective for the
entire given date range inclusive but not confined to the date range
for any agent. |
ProcessEnablerList |
getProcessEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
ProcessEnablerList that are effective for the
entire given date range inclusive but not confined to the date range
and evaluated against the given agent. |
void |
useActiveProcessEnablerView()
Only active process enablers are returned by methods in this session.
|
void |
useAnyStatusProcessEnablerView()
All active and inactive process enablers are returned by methods in
this session.
|
void |
useComparativeProcessEnablerView()
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 |
usePlenaryProcessEnablerView()
A complete view of the
ProcessEnabler 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 canLookupProcessEnablers()
ProcessEnablers
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 useComparativeProcessEnablerView()
mandatory
- This method is must be implemented. void usePlenaryProcessEnablerView()
ProcessEnabler
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 useActiveProcessEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusProcessEnablerView()
mandatory
- This method is must be implemented. ProcessEnabler getProcessEnabler(Id processEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProcessEnabler
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
ProcessEnabler
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a ProcessEnabler
and retained for
compatibility.
In active mode, process enablers are returned that are currently
active. In any status mode, active and inactive process enablers are
returned.processEnablerId
- Id
of the
ProcessEnabler
NotFoundException
- processEnablerId
not
foundNullArgumentException
- processEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ProcessEnablerList getProcessEnablersByIds(IdList processEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProcessEnablerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
process enabler specified in the Id
list, in the order
of the list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible ProcessEnablers
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In active mode, process enablers are returned that are currently
active. In any status mode, active and inactive process enablers are
returned.processEnablerIds
- the list of Ids
to retrieve ProcessEnabler
listNotFoundException
- an Id
was not foundNullArgumentException
- processEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProcessEnablerList getProcessEnablersByGenusType(Type processEnablerGenusType) throws OperationFailedException, PermissionDeniedException
ProcessEnablerList
corresponding to the given
process enabler genus Type
which does not include
process enabler of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
process enabler or an error results. Otherwise, the returned list may
contain only those process enabler that are accessible through this
session.
In active mode, process enablers are returned that are currently
active. In any status mode, active and inactive process enablers are
returned.processEnablerGenusType
- a process enabler genus type ProcessEnabler
listNullArgumentException
- processEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProcessEnablerList getProcessEnablersByParentGenusType(Type processEnablerGenusType) throws OperationFailedException, PermissionDeniedException
ProcessEnablerList
corresponding to the given
process enabler genus Type
and include any additional
process enabler with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
process enabler or an error results. Otherwise, the returned list may
contain only those process enabler that are accessible through this
session.
In active mode, process enablers are returned that are currently
active. In any status mode, active and inactive process enablers are
returned.processEnablerGenusType
- a process enabler genus type ProcessEnabler
listNullArgumentException
- processEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProcessEnablerList getProcessEnablersByRecordType(Type processEnablerRecordType) throws OperationFailedException, PermissionDeniedException
ProcessEnablerList
containing the given process
enabler record Type.
In plenary mode, the returned list contains all known
process enabler or an error results. Otherwise, the returned list may
contain only those process enabler that are accessible through this
session.
In active mode, process enablers are returned that are currently
active. In any status mode, active and inactive process enablers are
returned.processEnablerRecordType
- a process enabler record type ProcessEnabler
listNullArgumentException
- processEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProcessEnablerList getProcessEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ProcessEnablerList
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 process enablers
or an error results. Otherwise, the returned list may contain only
those process enablers that are accessible through this session.
In active mode, process enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive process enablers are returned.from
- a start dateto
- an end date ProcessEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProcessEnablerList getProcessEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ProcessEnablerList
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 process enablers
or an error results. Otherwise, the returned list may contain only
those process enablers that are accessible through this session.
In active mode, process enablers are returned that are currently
active in addition to being effective during the given date range. In
any status mode, active and inactive process enablers are returned.agentId
- an agent Id
from
- a start dateto
- an end date ProcessEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- agentId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProcessEnablerList getProcessEnablers() throws OperationFailedException, PermissionDeniedException
ProcessEnablers.
In plenary mode, the returned list contains all known process enabler
or an error results. Otherwise, the returned list may contain only
those process enabler that are accessible through this session.
In active mode, process enablers are returned that are currently
active. In any status mode, active and inactive process enablers are
returned. ProcessEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.