public interface JobProcessorEnablerLookupSession extends OsidSession
This session provides methods for retrieving
JobProcessorEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
JobProcessorEnablers
with the
JobProcessorEnablerAdminSession.
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 useFederatedFoundryView()
and
useIsolatedFoundryView()
behave as a radio group and one should be
selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupJobProcessorEnablers()
Tests if this user can perform
JobProcessorEnablers
lookups. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
JobProcessorEnabler |
getJobProcessorEnabler(Id jobProcessorEnablerId)
Gets the
JobProcessorEnabler specified by its
Id. |
JobProcessorEnablerList |
getJobProcessorEnablers()
Gets all
JobProcessorEnablers. |
JobProcessorEnablerList |
getJobProcessorEnablersByGenusType(Type jobProcessorEnablerGenusType)
Gets a
JobProcessorEnablerList corresponding to the
given job processor enabler genus Type which does not
include job processor enablers of genus types derived from the
specified Type. |
JobProcessorEnablerList |
getJobProcessorEnablersByIds(IdList jobProcessorEnablerIds)
Gets a
JobProcessorEnablerList corresponding to the
given IdList. |
JobProcessorEnablerList |
getJobProcessorEnablersByParentGenusType(Type jobProcessorEnablerGenusType)
Gets a
JobProcessorEnablerList corresponding to the
given job processor enabler genus Type and include any
additional job processor enablers with genus types derived from the
specified Type. |
JobProcessorEnablerList |
getJobProcessorEnablersByRecordType(Type jobProcessorEnablerRecordType)
Gets a
JobProcessorEnablerList containing the given job
processor enabler record Type. |
JobProcessorEnablerList |
getJobProcessorEnablersOnDate(DateTime from,
DateTime to)
Gets a
JobProcessorEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range for any agent. |
JobProcessorEnablerList |
getJobProcessorEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
JobProcessorEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range and evaluated against the given agent. |
void |
useActiveJobProcessorEnablerView()
Only active job processor enablers are returned by methods in this
session.
|
void |
useAnyStatusJobProcessorEnablerView()
All active and inactive job processor enablers are returned by methods
in this session.
|
void |
useComparativeJobProcessorEnablerView()
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 |
useFederatedFoundryView()
Federates the view for methods in this session.
|
void |
useIsolatedFoundryView()
Isolates the view for methods in this session.
|
void |
usePlenaryJobProcessorEnablerView()
A complete view of the
JobProcessorEnabler returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupJobProcessorEnablers()
JobProcessorEnablers
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 useComparativeJobProcessorEnablerView()
mandatory
- This method is must be implemented. void usePlenaryJobProcessorEnablerView()
JobProcessorEnabler
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 useFederatedFoundryView()
mandatory
- This method is must be implemented. void useIsolatedFoundryView()
mandatory
- This method is must be implemented. void useActiveJobProcessorEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusJobProcessorEnablerView()
mandatory
- This method is must be implemented. JobProcessorEnabler getJobProcessorEnabler(Id jobProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessorEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
JobProcessorEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a JobProcessorEnabler
and retained for
compatibility.
In active mode, job processor enablers are returned that are currently
active. In any status mode, active and inactive job processor enablers
are returned.jobProcessorEnablerId
- Id
of the
JobProcessorEnabler
NotFoundException
- jobProcessorEnablerId
not foundNullArgumentException
- jobProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. JobProcessorEnablerList getJobProcessorEnablersByIds(IdList jobProcessorEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessorEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
job processor enablers 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 JobProcessorEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, job processor enablers are returned that are currently
active. In any status mode, active and inactive job processor enablers
are returned.jobProcessorEnablerIds
- the list of Ids
to
retrieve JobProcessorEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- jobProcessorEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobProcessorEnablerList getJobProcessorEnablersByGenusType(Type jobProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
JobProcessorEnablerList
corresponding to the
given job processor enabler genus Type
which does not
include job processor enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
job processor enablers or an error results. Otherwise, the returned
list may contain only those job processor enablers that are accessible
through this session.
In active mode, job processor enablers are returned that are currently
active. In any status mode, active and inactive job processor enablers
are returned.jobProcessorEnablerGenusType
- a job processor enabler genus
type JobProcessorEnabler
listNullArgumentException
-
jobProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobProcessorEnablerList getJobProcessorEnablersByParentGenusType(Type jobProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
JobProcessorEnablerList
corresponding to the
given job processor enabler genus Type
and include any
additional job processor enablers with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
job processor enablers or an error results. Otherwise, the returned
list may contain only those job processor enablers that are accessible
through this session.
In active mode, job processor enablers are returned that are currently
active. In any status mode, active and inactive job processor enablers
are returned.jobProcessorEnablerGenusType
- a job processor enabler genus
type JobProcessorEnabler
listNullArgumentException
-
jobProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobProcessorEnablerList getJobProcessorEnablersByRecordType(Type jobProcessorEnablerRecordType) throws OperationFailedException, PermissionDeniedException
JobProcessorEnablerList
containing the given job
processor enabler record Type.
In plenary mode, the returned list contains all known
job processor enablers or an error results. Otherwise, the returned
list may contain only those job processor enablers that are accessible
through this session.
In active mode, job processor enablers are returned that are currently
active. In any status mode, active and inactive job processor enablers
are returned.jobProcessorEnablerRecordType
- a job processor enabler record
type JobProcessorEnabler
listNullArgumentException
-
jobProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobProcessorEnablerList getJobProcessorEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
JobProcessorEnablerList
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
job processor enablers or an error results. Otherwise, the returned
list may contain only those job processor enablers that are accessible
through this session.
In active mode, job processor enablers are returned that are currently
active. In any status mode, active and inactive job processor enablers
are returned.from
- a start dateto
- an end date JobProcessorEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobProcessorEnablerList getJobProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
JobProcessorEnablerList
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
job processor enablers or an error results. Otherwise, the returned
list may contain only those job processor enablers that are accessible
through this session.
In active mode, job processor enablers are returned that are currently
active. In any status mode, active and inactive job processor enablers
are returned.agentId
- an agent Id
from
- a start dateto
- an end date JobProcessorEnabler
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. JobProcessorEnablerList getJobProcessorEnablers() throws OperationFailedException, PermissionDeniedException
JobProcessorEnablers.
In plenary mode, the returned list contains all known job processor
enablers or an error results. Otherwise, the returned list may contain
only those job processor enablers that are accessible through this
session.
In active mode, job processor enablers are returned that are currently
active. In any status mode, active and inactive job processor enablers
are returned. JobProcessorEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.