public interface AvailabilityLookupSession extends OsidSession
This session defines methods for retrieving availabilities.
This lookup session defines several views:
Availabilities
with the
AvailabilityAdminSession.
The methods useFederatedFoundryView()
and
useIsolatedFoundryView()
behave as a radio group and one should be
selected before invoking any lookup methods.
Availabilities may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the Availabilities.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupAvailabilities()
Tests if this user can perform
Availability lookups. |
AvailabilityList |
getAvailabilities()
Gets all availabilities.
|
AvailabilityList |
getAvailabilitiesByGenusType(Type availabilityGenusType)
Gets an
AvailabilityList corresponding to the given
availability genus Type which does not include
availabilities of types derived from the specified Type. |
AvailabilityList |
getAvailabilitiesByIds(IdList availabilityIds)
Gets an
AvailabilityList corresponding to the given
IdList. |
AvailabilityList |
getAvailabilitiesByParentGenusType(Type availabilityGenusType)
Gets an
AvailabilityList corresponding to the given
availability genus Type and include any additional
availabilities with genus types derived from the specified
Type. |
AvailabilityList |
getAvailabilitiesByRecordType(Type availabilityRecordType)
Gets an
AvailabilityList containing the given
availability record Type. |
AvailabilityList |
getAvailabilitiesForJob(Id jobId)
Gets a list of availabilities for a job.
|
AvailabilityList |
getAvailabilitiesForJobOnDate(Id jobId,
DateTime from,
DateTime to)
Gets a list of availabilities for a job and effective during the
entire given date range inclusive but not confined to the date range.
|
AvailabilityList |
getAvailabilitiesForResource(Id resourceId)
Gets a list of availabilities for a resource.
|
AvailabilityList |
getAvailabilitiesForResourceAndJob(Id resourceId,
Id jobId)
Gets a list of availabilities for a resource and job.
|
AvailabilityList |
getAvailabilitiesForResourceAndJobOnDate(Id resourceId,
Id jobId,
DateTime from,
DateTime to)
Gets a list of availabilities for a resource and job and effective
during the entire given date range inclusive but not confined to the
date range.
|
AvailabilityList |
getAvailabilitiesForResourceOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a list of availabilities for a resource and effective during the
entire given date range inclusive but not confined to the date range.
|
AvailabilityList |
getAvailabilitiesOnDate(DateTime from,
DateTime to)
Gets a list of availabilities effective during the entire given date
range inclusive but not confined to the date range.
|
Availability |
getAvailability(Id availabilityId)
Gets the
Availability specified by its Id. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
useAnyEffectiveAvailabilityView()
All availabilities of any effective dates are returned by methods in
this session.
|
void |
useComparativeAvailabilityView()
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 |
useEffectiveAvailabilityView()
Only availabilities whose effective dates are current are returned by
methods in this session.
|
void |
useFederatedFoundryView()
Federates the view for methods in this session.
|
void |
useIsolatedFoundryView()
Isolates the view for methods in this session.
|
void |
usePlenaryAvailabilityView()
A complete view of the
Availability 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 canLookupAvailabilities()
Availability
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 not offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeAvailabilityView()
mandatory
- This method is must be implemented. void usePlenaryAvailabilityView()
Availability
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 useEffectiveAvailabilityView()
mandatory
- This method is must be implemented. void useAnyEffectiveAvailabilityView()
mandatory
- This method is must be implemented. Availability getAvailability(Id availabilityId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Availability
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Availability
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an Availability
and retained for
compatibility.
In effective mode, availabilities are returned that are currently
effective. In any effective mode, effective availabilities and those
currently expired are returned.availabilityId
- the Id
of the
Availability
to retrieve Availability
NotFoundException
- no Availability
found with the given Id
NullArgumentException
- availabilityId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilitiesByIds(IdList availabilityIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AvailabilityList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
availabilities 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 Availabilities
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In effective mode, availabilities are returned that are currently
effective. In any effective mode, effective availabilities and those
currently expired are returned.availabilityIds
- the list of Ids
to retrieve Availability
listNotFoundException
- an Id
was not foundNullArgumentException
- availabilityIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilitiesByGenusType(Type availabilityGenusType) throws OperationFailedException, PermissionDeniedException
AvailabilityList
corresponding to the given
availability genus Type
which does not include
availabilities of types derived from the specified Type.
In plenary mode, the returned list contains all known
availabilities or an error results. Otherwise, the returned list may
contain only those availabilities that are accessible through this
session.
In effective mode, availabilities are returned that are currently
effective. In any effective mode, effective availabilities and those
currently expired are returned.availabilityGenusType
- an availability genus type Availability
listNullArgumentException
- availabilityGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilitiesByParentGenusType(Type availabilityGenusType) throws OperationFailedException, PermissionDeniedException
AvailabilityList
corresponding to the given
availability genus Type
and include any additional
availabilities with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
availabilities or an error results. Otherwise, the returned list may
contain only those availabilities that are accessible through this
session.
In effective mode, availabilities are returned that are currently
effective. In any effective mode, effective availabilities and those
currently expired are returned.availabilityGenusType
- an availability genus type Availability
listNullArgumentException
- availabilityGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilitiesByRecordType(Type availabilityRecordType) throws OperationFailedException, PermissionDeniedException
AvailabilityList
containing the given
availability record Type.
In plenary mode, the returned list contains all known availabilities
or an error results. Otherwise, the returned list may contain only
those availabilities that are accessible through this session.
In effective mode, availabilities are returned that are currently
effective. In any effective mode, effective availabilities and those
currently expired are returned.availabilityRecordType
- an availability record type Availability
listNullArgumentException
- availabilityRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilitiesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
availabilities or an error results. Otherwise, the returned list may
contain only those availabilities that are accessible through this
session.
In effective mode, availabilities are returned that are currently
effective. In any effective mode, effective availabilities and those
currently expired are returned.from
- start of date rangeto
- end of date range Availability
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilitiesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
Availability
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilitiesForResourceOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
availabilities or an error results. Otherwise, the returned list may
contain only those availabilities that are accessible through this
session.
In effective mode, availabilities are returned that are currently
effective. In any effective mode, effective availabilities and those
currently expired are returned.resourceId
- a resource Id
from
- start of date rangeto
- end of date range Availability
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilitiesForJob(Id jobId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
availabilities or an error results. Otherwise, the returned list may
contain only those availabilities that are accessible through this
session.
In effective mode, availabilities are returned that are currently
effective. In any effective mode, effective availabilities and those
currently expired are returned.jobId
- a job Id
Availability
listNullArgumentException
- jobId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilitiesForJobOnDate(Id jobId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
availabilities or an error results. Otherwise, the returned list may
contain only those availabilities that are accessible through this
session.
In effective mode, availabilities are returned that are currently
effective. In any effective mode, effective availabilities and those
currently expired are returned.jobId
- a job Id
from
- start of date rangeto
- end of date range Availability
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- jobId, from,
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilitiesForResourceAndJob(Id resourceId, Id jobId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
availabilities or an error results. Otherwise, the returned list may
contain only those availabilities that are accessible through this
session.
In effective mode, credits are returned that are currently effective.
In any effective mode, effective credits and those currently expired
are returned.resourceId
- a resource Id
jobId
- a job Id
Availability
listNullArgumentException
- resourceId
or
jobId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilitiesForResourceAndJobOnDate(Id resourceId, Id jobId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
availabilities or an error results. Otherwise, the returned list may
contain only those availabilities that are accessible through this
session.
In effective mode, availabilities are returned that are currently
effective. In any effective mode, effective availabilities and those
currently expired are returned.resourceId
- a resource Id
jobId
- a job Id
from
- start of date rangeto
- end of date range Availability
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, jobId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AvailabilityList getAvailabilities() throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all of the
availabilities, including duplicates, or an error results if an
Id
in the supplied list is not found or inaccessible.
Otherwise, inaccessible Availabilities
may be omitted
from the list and may present the elements in any order including
returning a unique set.
In effective mode, availabilities are returned that are currently
effective. In any effective mode, effective availabilities and those
currently expired are returned. Availability
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.