public interface JobConstrainerEnablerLookupSession extends OsidSession
This session provides methods for retrieving
JobConstrainerEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
JobConstrainerEnablers
with the
JobConstrainerEnablerAdminSession.
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 |
canLookupJobConstrainerEnablers()
Tests if this user can perform
JobConstrainerEnablers
lookups. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
JobConstrainerEnabler |
getJobConstrainerEnabler(Id jobConstrainerEnablerId)
Gets the
JobConstrainerEnabler specified by its
Id. |
JobConstrainerEnablerList |
getJobConstrainerEnablers()
Gets all
JobConstrainerEnablers. |
JobConstrainerEnablerList |
getJobConstrainerEnablersByGenusType(Type jobConstrainerEnablerGenusType)
Gets a
JobConstrainerEnablerList corresponding to the
given job constrainer enabler genus Type which does not
include job constrainer enablers of genus types derived from the
specified Type. |
JobConstrainerEnablerList |
getJobConstrainerEnablersByIds(IdList jobConstrainerEnablerIds)
Gets a
JobConstrainerEnablerList corresponding to the
given IdList. |
JobConstrainerEnablerList |
getJobConstrainerEnablersByParentGenusType(Type jobConstrainerEnablerGenusType)
Gets a
JobConstrainerEnablerList corresponding to the
given job constrainer enabler genus Type and include
any additional job constrainer enablers with genus types derived from
the specified Type. |
JobConstrainerEnablerList |
getJobConstrainerEnablersByRecordType(Type jobConstrainerEnablerRecordType)
Gets a
JobConstrainerEnablerList containing the given
job constrainer enabler record Type. |
JobConstrainerEnablerList |
getJobConstrainerEnablersOnDate(DateTime from,
DateTime to)
Gets a
JobConstrainerEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range for any agent. |
JobConstrainerEnablerList |
getJobConstrainerEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
JobConstrainerEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range and evaluated against the given agent. |
void |
useActiveJobConstrainerEnablerView()
Only active job constrainer enablers are returned by methods in this
session.
|
void |
useAnyStatusJobConstrainerEnablerView()
All active and inactive job constrainer enablers are returned by
methods in this session.
|
void |
useComparativeJobConstrainerEnablerView()
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 |
usePlenaryJobConstrainerEnablerView()
A complete view of the
JobConstrainerEnabler 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 canLookupJobConstrainerEnablers()
JobConstrainerEnablers
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 useComparativeJobConstrainerEnablerView()
mandatory
- This method is must be implemented. void usePlenaryJobConstrainerEnablerView()
JobConstrainerEnabler
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 useActiveJobConstrainerEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusJobConstrainerEnablerView()
mandatory
- This method is must be implemented. JobConstrainerEnabler getJobConstrainerEnabler(Id jobConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobConstrainerEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
JobConstrainerEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a JobConstrainerEnabler
and retained
for compatibility.
In active mode, job constrainer enablers are returned that are
currently active. In any status mode, active and inactive job
constrainer enablers are returned.jobConstrainerEnablerId
- Id
of the
JobConstrainerEnabler
NotFoundException
- jobConstrainerEnablerId
not foundNullArgumentException
- jobConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. JobConstrainerEnablerList getJobConstrainerEnablersByIds(IdList jobConstrainerEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
JobConstrainerEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
job constrainer 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 JobConstrainerEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, job constrainer enablers are returned that are
currently active. In any status mode, active and inactive job
constrainer enablers are returned.jobConstrainerEnablerIds
- the list of Ids
to
retrieve JobConstrainerEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- jobConstrainerEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobConstrainerEnablerList getJobConstrainerEnablersByGenusType(Type jobConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
JobConstrainerEnablerList
corresponding to the
given job constrainer enabler genus Type
which does not
include job constrainer enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
job constrainer enablers or an error results. Otherwise, the returned
list may contain only those job constrainer enablers that are
accessible through this session.
In active mode, job constrainer enablers are returned that are
currently active. In any status mode, active and inactive job
constrainer enablers are returned.jobConstrainerEnablerGenusType
- a job constrainer enabler genus
type JobConstrainerEnabler
listNullArgumentException
-
jobConstrainerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobConstrainerEnablerList getJobConstrainerEnablersByParentGenusType(Type jobConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
JobConstrainerEnablerList
corresponding to the
given job constrainer enabler genus Type
and include
any additional job constrainer enablers with genus types derived from
the specified Type.
In plenary mode, the returned list contains all known
job constrainer enablers or an error results. Otherwise, the returned
list may contain only those job constrainer enablers that are
accessible through this session.
In active mode, job constrainer enablers are returned that are
currently active. In any status mode, active and inactive job
constrainer enablers are returned.jobConstrainerEnablerGenusType
- a job constrainer enabler genus
type JobConstrainerEnabler
listNullArgumentException
-
jobConstrainerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobConstrainerEnablerList getJobConstrainerEnablersByRecordType(Type jobConstrainerEnablerRecordType) throws OperationFailedException, PermissionDeniedException
JobConstrainerEnablerList
containing the given
job constrainer enabler record Type.
In plenary mode, the returned list contains all known
job constrainer enablers or an error results. Otherwise, the returned
list may contain only those job constrainer enablers that are
accessible through this session.
In active mode, job constrainer enablers are returned that are
currently active. In any status mode, active and inactive job
constrainer enablers are returned.jobConstrainerEnablerRecordType
- a job constrainer enabler
record type JobConstrainerEnabler
listNullArgumentException
-
jobConstrainerEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobConstrainerEnablerList getJobConstrainerEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
JobConstrainerEnablerList
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 constrainer enablers or an error results. Otherwise, the returned
list may contain only those job constrainer enablers that are
accessible through this session.
In active mode, job constrainer enablers are returned that are
currently active. In any status mode, active and inactive job
constrainer enablers are returned.from
- a start dateto
- an end date JobConstrainerEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobConstrainerEnablerList getJobConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
JobConstrainerEnablerList
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 constrainer enablers or an error results. Otherwise, the returned
list may contain only those job constrainer enablers that are
accessible through this session.
In active mode, job constrainer enablers are returned that are
currently active. In any status mode, active and inactive job
constrainer enablers are returned.agentId
- an agent Id
from
- a start dateto
- an end date JobConstrainerEnabler
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. JobConstrainerEnablerList getJobConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
JobConstrainerEnablers.
In plenary mode, the returned list contains all known job constrainer
enablers or an error results. Otherwise, the returned list may contain
only those job constrainer enablers that are accessible through this
session.
In active mode, job constrainer enablers are returned that are
currently active. In any status mode, active and inactive job
constrainer enablers are returned. JobConstrainerEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.