public interface LeaseLookupSession extends OsidSession
This session provides methods for retrieving Lease
objects. The Lease
represents a relationship to a room.
This session defines views that offer differing behaviors when retrieving multiple objects.
LeaseAdminSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupLeases()
Tests if this user can perform
Lease lookups. |
Campus |
getCampus()
Gets the
Campus associated with this session. |
Id |
getCampusId()
Gets the
Campus Id associated with this
session. |
Lease |
getLease(Id leaseId)
Gets the
Lease specified by its Id. |
LeaseList |
getLeases()
Gets all
Leases. |
LeaseList |
getLeasesByGenusType(Type leaseGenusType)
Gets a
LeaseList corresponding to the given lease genus
Type which does not include leases of genus types
derived from the specified Type. |
LeaseList |
getLeasesByGenusTypeForRoom(Id roomId,
Type leaseGenusType)
Gets a list of all leases for a room and a lease genus type
. |
LeaseList |
getLeasesByGenusTypeForRoomAndTenant(Id roomId,
Id resourceId,
Type leaseGenusType)
Gets a list of all leases for a room, resource, and of a lease genus
type.
|
LeaseList |
getLeasesByGenusTypeForRoomAndTenantOnDate(Id roomId,
Id resourceId,
Type leaseGenusType,
DateTime from,
DateTime to)
Gets a list of all leases for a room, tenant, and of a lease genus
type effective during the entire given date range inclusive but not
confined to the date range.
|
LeaseList |
getLeasesByGenusTypeForRoomOnDate(Id roomId,
Type leaseGenusType,
DateTime from,
DateTime to)
Gets a list of all leases for a room and of a lease genus type
effective during the entire given date range inclusive but not
confined to the date range.
|
LeaseList |
getLeasesByGenusTypeForTenant(Id resourceId,
Type leaseGenusType)
Gets a list of all leases corresponding to a tenant
Id
and of a lease genus type. |
LeaseList |
getLeasesByGenusTypeForTenantOnDate(Id resourceId,
Type leaseGenusType,
DateTime from,
DateTime to)
Gets a list of all leases for a tenant and of a lease genus type
effective during the entire given date range inclusive but not
confined to the date range.
|
LeaseList |
getLeasesByGenusTypeOnDate(Type leaseGenusType,
DateTime from,
DateTime to)
Gets a list of all leases of a genus type effective during the entire
given date range inclusive but not confined to the date range.
|
LeaseList |
getLeasesByIds(IdList leaseIds)
Gets a
LeaseList corresponding to the given
IdList. |
LeaseList |
getLeasesByParentGenusType(Type leaseGenusType)
Gets a
LeaseList corresponding to the given lease genus
Type and include any additional leases with genus types
derived from the specified Type. |
LeaseList |
getLeasesByRecordType(Type leaseRecordType)
Gets a
LeaseList containing the given lease record
Type. |
LeaseList |
getLeasesForRoom(Id roomId)
Gets a list of all leases corresponding to a room
Id. |
LeaseList |
getLeasesForRoomAndTenant(Id roomId,
Id resourceId)
Gets a list of all leases corresponding to a room and tenant.
|
LeaseList |
getLeasesForRoomAndTenantOnDate(Id roomId,
Id resourceId,
DateTime from,
DateTime to)
Gets a list of all leases for a room and tenant effective during the
entire given date range inclusive but not confined to the date range.
|
LeaseList |
getLeasesForRoomOnDate(Id roomId,
DateTime from,
DateTime to)
Gets a list of all leases for a room effective during the entire given
date range inclusive but not confined to the date range.
|
LeaseList |
getLeasesForTenant(Id resourceId)
Gets a list of all leases for a tenant corresponding to a room
Id. |
LeaseList |
getLeasesForTenantOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a list of all leases for a tenant effective during the entire
given date range inclusive but not confined to the date range.
|
LeaseList |
getLeasesOnDate(DateTime from,
DateTime to)
Gets a list of all leases effective during the entire given date range
inclusive but not confined to the date range.
|
void |
useAnyEffectiveLeaseView()
Leases of any effective dates are returned by all methods in this
session.
|
void |
useComparativeLeaseView()
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 |
useEffectiveLeaseView()
Only leases whose effective dates are current are returned by methods
in this session
|
void |
useFederatedCampusView()
Federates the view for methods in this session.
|
void |
useIsolatedCampusView()
Isolates the view for methods in this session.
|
void |
usePlenaryLeaseView()
A complete view of the
Lease returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCampusId()
Campus
Id
associated with this
session. Campus Id
associated with this sessionmandatory
- This method must be implemented. Campus getCampus() throws OperationFailedException, PermissionDeniedException
Campus
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupLeases()
Lease
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 useComparativeLeaseView()
mandatory
- This method is must be implemented. void usePlenaryLeaseView()
Lease
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 useFederatedCampusView()
mandatory
- This method is must be implemented. void useIsolatedCampusView()
mandatory
- This method is must be implemented. void useEffectiveLeaseView()
mandatory
- This method is must be implemented. void useAnyEffectiveLeaseView()
mandatory
- This method is must be implemented. Lease getLease(Id leaseId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Lease
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Lease
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Lease
and retained for compatibility.
In effective mode, leases are returned that are currently effective.
In any effective mode, effective leases and those currently expired
are returned.leaseId
- Id
of the Lease
NotFoundException
- leaseId
not foundNullArgumentException
- leaseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. LeaseList getLeasesByIds(IdList leaseIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
LeaseList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
leases 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 Leases
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In effective mode, leases are returned that are currently effective.
In any effective mode, effective leases and those currently expired
are returned.leaseIds
- the list of Ids
to retrieve Lease
listNotFoundException
- an Id was
not foundNullArgumentException
- leaseIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesByGenusType(Type leaseGenusType) throws OperationFailedException, PermissionDeniedException
LeaseList
corresponding to the given lease genus
Type
which does not include leases of genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
leases or an error results. Otherwise, the returned list may contain
only those leases that are accessible through this session.
In effective mode, leases are returned that are currently effective.
In any effective mode, effective leases and those currently expired
are returned.leaseGenusType
- a lease genus type Lease
listNullArgumentException
- leaseGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesByParentGenusType(Type leaseGenusType) throws OperationFailedException, PermissionDeniedException
LeaseList
corresponding to the given lease genus
Type
and include any additional leases with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
leases or an error results. Otherwise, the returned list may contain
only those leases that are accessible through this session.
In effective mode, leases are returned that are currently effective.
In any effective mode, effective leases and those currently expired
are returned.leaseGenusType
- a lease genus type Lease
listNullArgumentException
- leaseGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesByRecordType(Type leaseRecordType) throws OperationFailedException, PermissionDeniedException
LeaseList
containing the given lease record
Type.
In plenary mode, the returned list contains all known
leases or an error results. Otherwise, the returned list may contain
only those leases that are accessible through this session.
In effective mode, leases are returned that are currently effective.
In any effective mode, effective leases and those currently expired
are returned.leaseRecordType
- a lease record type Lease
listNullArgumentException
- leaseRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
from
- start of date rangeto
- end of date range LeaseList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesByGenusTypeOnDate(Type leaseGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
leaseGenusType
- a lease genus typefrom
- start of date rangeto
- end of date range LeaseList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- leaseGenusType, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesForRoom(Id roomId) throws OperationFailedException, PermissionDeniedException
Id.
In plenary mode, the returned list contains all known leases or an
error results. Otherwise, the returned list may contain only those
leases that are accessible through this session.
In effective mode, leases are returned that are currently effective.
In any effective mode, effective leases and those currently expired
are returned.roomId
- the Id
of the room LeaseList
NullArgumentException
- roomId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesByGenusTypeForRoom(Id roomId, Type leaseGenusType) throws OperationFailedException, PermissionDeniedException
.
In plenary mode, the returned list contains all known leases or an
error results. Otherwise, the returned list may contain only those
leases that are accessible through this session.
In effective mode, leases are returned that are currently effective.
In any effective mode, effective leases and those currently expired
are returned.roomId
- a room Id
leaseGenusType
- a lease genus type LeaseList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- roomId
or
leaseGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesForRoomOnDate(Id roomId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
roomId
- a room Id
from
- start of date rangeto
- end of date range LeaseList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- roomId, from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesByGenusTypeForRoomOnDate(Id roomId, Type leaseGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
roomId
- a room Id
leaseGenusType
- a lease genus typefrom
- start of date rangeto
- end of date range LeaseList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- roomId, leaseGenusType,
from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesForTenant(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
In plenary mode, the returned list contains all known leases or an
error results. Otherwise, the returned list may contain only those
leases that are accessible through this session.
In effective mode, leases are returned that are currently effective.
In any effective mode, effective leases and those currently expired
are returned.resourceId
- a resource Id
LeaseList
NullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesByGenusTypeForTenant(Id resourceId, Type leaseGenusType) throws OperationFailedException, PermissionDeniedException
Id
and of a lease genus type.
In plenary mode, the returned list contains all known leases or an
error results. Otherwise, the returned list may contain only those
leases that are accessible through this session.
In effective mode, leases are returned that are currently effective.
In any effective mode, effective leases and those currently expired
are returned.resourceId
- a resourceId Id
leaseGenusType
- a lease genus type LeaseList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- resourceId
or
leaseGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesForTenantOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
leases or an error results. Otherwise, the returned list may contain
only those leases that are accessible through this session.
In effective mode, leases are returned that are currently effective.
In any effective mode, effective leases and those currently expired
are returned.resourceId
- a resource Id
from
- start of date rangeto
- end of date range LeaseList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesByGenusTypeForTenantOnDate(Id resourceId, Type leaseGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
leaseGenusType
- a lease genus typefrom
- start of date rangeto
- end of date range LeaseList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId,
leaseGenusType, from,
or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesForRoomAndTenant(Id roomId, Id resourceId) throws OperationFailedException, PermissionDeniedException
roomId
- the Id
of the roomresourceId
- a tenant Id
LeaseList
NullArgumentException
- roomId
or
resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesByGenusTypeForRoomAndTenant(Id roomId, Id resourceId, Type leaseGenusType) throws OperationFailedException, PermissionDeniedException
roomId
- a room Id
resourceId
- a tenant Id
leaseGenusType
- a lease genus type LeaseList
InvalidArgumentException
- to
is less
than from
NullArgumentException
- roomId, resourceId,
or leaseGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesForRoomAndTenantOnDate(Id roomId, Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
leases or an error results. Otherwise, the returned list may contain
only those leases that are accessible through this session.
In effective mode, leases are returned that are currently effective.
In any effective mode, effective leases and those currently expired
are returned.roomId
- a room Id
resourceId
- a resource Id
from
- start of date rangeto
- end of date range LeaseList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- roomId, resourceId,
from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeasesByGenusTypeForRoomAndTenantOnDate(Id roomId, Id resourceId, Type leaseGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
roomId
- a room Id
resourceId
- a resource Id
leaseGenusType
- a lease genus typefrom
- start of date rangeto
- end of date range LeaseList
InvalidArgumentException
- from
is
greater than to
NullArgumentException
- roomId, resourceId,
leaseGenusType, from,
or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LeaseList getLeases() throws OperationFailedException, PermissionDeniedException
Leases.
In plenary mode, the returned list contains all known leases or an
error results. Otherwise, the returned list may contain only those
leases that are accessible through this session.
In effective mode, leases are returned that are currently effective.
In any effective mode, effective leases and those currently expired
are returned. Leases
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.