public interface JobProcessorLookupSession extends OsidSession
This session provides methods for retrieving JobProcessors.
This session defines views that offer differing behaviors when retrieving multiple objects.
JobProcessors
with the JobProcessorAdminSession.
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 |
canLookupJobProcessors()
Tests if this user can perform
JobProcessors lookups. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
JobProcessor |
getJobProcessor(Id jobProcessorId)
Gets the
JobProcessor specified by its Id. |
JobProcessorList |
getJobProcessors()
Gets all
JobProcessors. |
JobProcessorList |
getJobProcessorsByGenusType(Type jobProcessorGenusType)
Gets a
JobProcessorList corresponding to the given job
processor genus Type which does not include job
processor of genus types derived from the specified Type. |
JobProcessorList |
getJobProcessorsByIds(IdList jobProcessorIds)
Gets a
JobProcessorList corresponding to the given
IdList. |
JobProcessorList |
getJobProcessorsByParentGenusType(Type jobProcessorGenusType)
Gets a
JobProcessorList corresponding to the given job
processor genus Type and include any additional job
processor with genus types derived from the specified Type. |
JobProcessorList |
getJobProcessorsByRecordType(Type jobProcessorRecordType)
Gets a
JobProcessorList containing the given job
processor record Type. |
void |
useActiveJobProcessorView()
Only active job processors are returned by methods in this session.
|
void |
useAnyStatusJobProcessorView()
All active and inactive job processors are returned by methods in this
session.
|
void |
useComparativeJobProcessorView()
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 |
usePlenaryJobProcessorView()
A complete view of the
JobProcessor 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 canLookupJobProcessors()
JobProcessors
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 useComparativeJobProcessorView()
mandatory
- This method is must be implemented. void usePlenaryJobProcessorView()
JobProcessor
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 useActiveJobProcessorView()
mandatory
- This method is must be implemented. void useAnyStatusJobProcessorView()
mandatory
- This method is must be implemented. JobProcessor getJobProcessor(Id jobProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessor
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
JobProcessor
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a JobProcessor
and retained for
compatibility.
In active mode, job processors are returned that are currently active.
In any status mode, active and inactive job processors are returned.jobProcessorId
- Id
of the JobProcessor
NotFoundException
- jobProcessorId
not
foundNullArgumentException
- jobProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. JobProcessorList getJobProcessorsByIds(IdList jobProcessorIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobProcessorList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
job processor 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 JobProcessors
may be omitted from the list
and may present the elements in any order including returning a unique
set.
In active mode, job processors are returned that are currently active.
In any status mode, active and inactive job processors are returned.jobProcessorIds
- the list of Ids
to retrieve JobProcessor
listNotFoundException
- an Id was
not foundNullArgumentException
- jobProcessorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobProcessorList getJobProcessorsByGenusType(Type jobProcessorGenusType) throws OperationFailedException, PermissionDeniedException
JobProcessorList
corresponding to the given job
processor genus Type
which does not include job
processor of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
job processor or an error results. Otherwise, the returned list may
contain only those job processor that are accessible through this
session.
In active mode, job processors are returned that are currently active.
In any status mode, active and inactive job processors are returned.jobProcessorGenusType
- a job processor genus type JobProcessor
listNullArgumentException
- jobProcessorGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobProcessorList getJobProcessorsByParentGenusType(Type jobProcessorGenusType) throws OperationFailedException, PermissionDeniedException
JobProcessorList
corresponding to the given job
processor genus Type
and include any additional job
processor with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
job processor or an error results. Otherwise, the returned list may
contain only those job processor that are accessible through this
session.
In active mode, job processors are returned that are currently active.
In any status mode, active and inactive job processors are returned.jobProcessorGenusType
- a job processor genus type JobProcessor
listNullArgumentException
- jobProcessorGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobProcessorList getJobProcessorsByRecordType(Type jobProcessorRecordType) throws OperationFailedException, PermissionDeniedException
JobProcessorList
containing the given job
processor record Type.
In plenary mode, the returned list contains all known
job processor or an error results. Otherwise, the returned list may
contain only those job processor that are accessible through this
session.
In active mode, job processors are returned that are currently active.
In any status mode, active and inactive job processors are returned.jobProcessorRecordType
- a job processor record type JobProcessor
listNullArgumentException
- jobProcessorRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobProcessorList getJobProcessors() throws OperationFailedException, PermissionDeniedException
JobProcessors.
In plenary mode, the returned list contains all known job processor or
an error results. Otherwise, the returned list may contain only those
job processor that are accessible through this session.
In active mode, job processors are returned that are currently active.
In any status mode, active and inactive job processors are returned. JobProcessor
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.