public interface DeedLookupSession extends OsidSession
This session provides methods for retrieving Deed
objects. The Deed
represents a relationship between an
owner and a building.
This session defines views that offer differing behaviors when retrieving multiple objects.
DeedAdminSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupDeeds()
Tests if this user can perform
Deed lookups. |
Campus |
getCampus()
Gets the
Campus associated with this session. |
Id |
getCampusId()
Gets the
Campus Id associated with this
session. |
Deed |
getDeed(Id deedId)
Gets the
Deed specified by its Id. |
DeedList |
getDeeds()
Gets all
Deeds. |
DeedList |
getDeedsByGenusType(Type deedGenusType)
Gets a
DeedList corresponding to the given deed genus
Type which does not include deeds of genus types
derived from the specified Type. |
DeedList |
getDeedsByGenusTypeForBuilding(Id buildingId,
Type deedGenusType)
Gets a
DeedList containing the given building and genus
type . |
DeedList |
getDeedsByGenusTypeForBuildingAndOwner(Id buildingId,
Id resourceId,
Type deedGenusType)
Gets a
DeedList for the given buildin, owner, and genus
type . |
DeedList |
getDeedsByGenusTypeForBuildingAndOwnerOnDate(Id buildingId,
Id resourceId,
Type deedGenusType,
DateTime from,
DateTime to)
Gets a list of all deeds for a building and owner with a genus type
and effective during the entire given date range inclusive but not
confined to the date range.
|
DeedList |
getDeedsByGenusTypeForBuildingOnDate(Id buildingId,
Type deedGenusType,
DateTime from,
DateTime to)
Gets a list of all deeds for a building with a genus type and
effective during the entire given date range inclusive but not
confined to the date range.
|
DeedList |
getDeedsByGenusTypeForOwner(Id resourceId,
Type deedGenusType)
Gets a
DeedList containing the given owner and genus
type . |
DeedList |
getDeedsByGenusTypeForOwnerOnDate(Id resourceId,
Type deedGenusType,
DateTime from,
DateTime to)
Gets a list of all deeds for a resource owner with a genus type and
effective during the entire given date range inclusive but not
confined to the date range.
|
DeedList |
getDeedsByGenusTypeOnDate(Type deedGenusType,
DateTime from,
DateTime to)
Gets a list of all deeds with a genus type and effective during the
entire given date range inclusive but not confined to the date range.
|
DeedList |
getDeedsByIds(IdList deedIds)
Gets a
DeedList corresponding to the given
IdList. |
DeedList |
getDeedsByParentGenusType(Type deedGenusType)
Gets a
DeedList corresponding to the given deed genus
Type and include any additional deeds with genus types
derived from the specified Type. |
DeedList |
getDeedsByRecordType(Type deedRecordType)
Gets a
DeedList containing the given deed record
Type. |
DeedList |
getDeedsForBuilding(Id buildingId)
Gets a
DeedList containing the given building . |
DeedList |
getDeedsForBuildingAndOwner(Id buildingId,
Id resourceId)
Gets a
DeedList for the given building and owner. |
DeedList |
getDeedsForBuildingAndOwnerOnDate(Id buildingId,
Id resourceId,
DateTime from,
DateTime to)
Gets a list of all deeds for a building and owner resource effective
during the entire given date range inclusive but not confined to the
date range.
|
DeedList |
getDeedsForBuildingOnDate(Id buildingId,
DateTime from,
DateTime to)
Gets a list of all deeds for a building effective during the entire
given date range inclusive but not confined to the date range.
|
DeedList |
getDeedsForOwner(Id resourceId)
Gets a
DeedList containing the given owner resource. |
DeedList |
getDeedsForOwnerOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a list of all deeds for an owner resource effective during the
entire given date range inclusive but not confined to the date range.
|
DeedList |
getDeedsOnDate(DateTime from,
DateTime to)
Gets a list of all deeds effective during the entire given date range
inclusive but not confined to the date range.
|
void |
useAnyEffectiveDeedView()
Deeds of any effective dates are returned by all methods in this
session.
|
void |
useComparativeDeedView()
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 |
useEffectiveDeedView()
Only deeds 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 |
usePlenaryDeedView()
A complete view of the
Deed 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 canLookupDeeds()
Deed
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 useComparativeDeedView()
mandatory
- This method is must be implemented. void usePlenaryDeedView()
Deed
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 useEffectiveDeedView()
mandatory
- This method is must be implemented. void useAnyEffectiveDeedView()
mandatory
- This method is must be implemented. Deed getDeed(Id deedId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Deed
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Deed
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to a
Deed
and retained for compatibility.
In effective mode, deeds are returned that are currently effective. In
any effective mode, effective deeds and those currently expired are
returned.deedId
- Id
of the Deed
NotFoundException
- deedId
not foundNullArgumentException
- deedId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. DeedList getDeedsByIds(IdList deedIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
DeedList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
deeds 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 Deeds
may be omitted from the list and may
present the elements in any order including returning a unique set.
In effective mode, deeds are returned that are currently effective. In
any effective mode, effective deeds and those currently expired are
returned.deedIds
- the list of Ids
to retrieve Deed
listNotFoundException
- an Id was
not foundNullArgumentException
- deedIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsByGenusType(Type deedGenusType) throws OperationFailedException, PermissionDeniedException
DeedList
corresponding to the given deed genus
Type
which does not include deeds of genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
deeds or an error results. Otherwise, the returned list may contain
only those deeds that are accessible through this session.
In effective mode, deeds are returned that are currently effective. In
any effective mode, effective deeds and those currently expired are
returned.deedGenusType
- a deed genus type Deed
listNullArgumentException
- deedGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsByParentGenusType(Type deedGenusType) throws OperationFailedException, PermissionDeniedException
DeedList
corresponding to the given deed genus
Type
and include any additional deeds with genus types
derived from the specified Type.
In plenary mode, the returned list contains all known
deeds or an error results. Otherwise, the returned list may contain
only those deeds that are accessible through this session.
In effective mode, deeds are returned that are currently effective. In
any effective mode, effective deeds and those currently expired are
returned.deedGenusType
- a deed genus type Deed
listNullArgumentException
- deedGenusType
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsByRecordType(Type deedRecordType) throws OperationFailedException, PermissionDeniedException
DeedList
containing the given deed record
Type.
In plenary mode, the returned list contains all known
deeds or an error results. Otherwise, the returned list may contain
only those deeds that are accessible through this session.
In effective mode, deeds are returned that are currently effective. In
any effective mode, effective deeds and those currently expired are
returned.deedRecordType
- a deed record type Deed
listNullArgumentException
- deedRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
from
- start of date rangeto
- end of date range Deed
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsByGenusTypeOnDate(Type deedGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
deedGenusType
- a deed genus typefrom
- start of date rangeto
- end of date range Deed
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- deedGenusType, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsForBuilding(Id buildingId) throws OperationFailedException, PermissionDeniedException
DeedList
containing the given building .
In plenary mode, the returned list contains all known
deeds or an error results. Otherwise, the returned list may contain
only those deeds that are accessible through this session.
In effective mode, deeds are returned that are currently effective. In
any effective mode, effective deeds and those currently expired are
returned.buildingId
- a building Id
Deed
listNullArgumentException
- buildingId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsByGenusTypeForBuilding(Id buildingId, Type deedGenusType) throws OperationFailedException, PermissionDeniedException
DeedList
containing the given building and genus
type .
In plenary mode, the returned list contains all known
deeds or an error results. Otherwise, the returned list may contain
only those deeds that are accessible through this session.
In effective mode, deeds are returned that are currently effective. In
any effective mode, effective deeds and those currently expired are
returned.buildingId
- a building Id
deedGenusType
- a deed genus type Deed
listNullArgumentException
- buildingId
or
deedGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsForBuildingOnDate(Id buildingId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
buildingId
- a building Id
from
- start of date rangeto
- end of date range Deed
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- buildingId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsByGenusTypeForBuildingOnDate(Id buildingId, Type deedGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
buildingId
- a building Id
deedGenusType
- a deed genus typefrom
- start of date rangeto
- end of date range Deed
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- buildingId,
deedGenusType, from
or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsForOwner(Id resourceId) throws OperationFailedException, PermissionDeniedException
DeedList
containing the given owner resource.
In plenary mode, the returned list contains all known
deeds or an error results. Otherwise, the returned list may contain
only those deeds that are accessible through this session.
In effective mode, deeds are returned that are currently effective. In
any effective mode, effective deeds and those currently expired are
returned.resourceId
- a resource Id
Deed
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsByGenusTypeForOwner(Id resourceId, Type deedGenusType) throws OperationFailedException, PermissionDeniedException
DeedList
containing the given owner and genus
type .
In plenary mode, the returned list contains all known
deeds or an error results. Otherwise, the returned list may contain
only those deeds that are accessible through this session.
In effective mode, deeds are returned that are currently effective. In
any effective mode, effective deeds and those currently expired are
returned.resourceId
- a resource Id
deedGenusType
- a deed genus type Deed
listNullArgumentException
- resourceId
or
deedGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsForOwnerOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
from
- start of date rangeto
- end of date range Deed
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. DeedList getDeedsByGenusTypeForOwnerOnDate(Id resourceId, Type deedGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
resourceId
- a resource Id
deedGenusType
- a deed genus typefrom
- start of date rangeto
- end of date range Deed
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId,
deedGenusType, from
or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsForBuildingAndOwner(Id buildingId, Id resourceId) throws OperationFailedException, PermissionDeniedException
DeedList
for the given building and owner.
In plenary mode, the returned list contains all known
deeds or an error results. Otherwise, the returned list may contain
only those deeds that are accessible through this session.
In effective mode, deeds are returned that are currently effective. In
any effective mode, effective deeds and those currently expired are
returned.buildingId
- a building Id
resourceId
- a resource Id
Deed
listNullArgumentException
- buildingId
or
resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsByGenusTypeForBuildingAndOwner(Id buildingId, Id resourceId, Type deedGenusType) throws OperationFailedException, PermissionDeniedException
DeedList
for the given buildin, owner, and genus
type .
In plenary mode, the returned list contains all known
deeds or an error results. Otherwise, the returned list may contain
only those deeds that are accessible through this session.
In effective mode, deeds are returned that are currently effective. In
any effective mode, effective deeds and those currently expired are
returned.buildingId
- a building Id
resourceId
- a resource Id
deedGenusType
- a deed genus type Deed
listNullArgumentException
- buildingId, resourceId,
or deedGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsForBuildingAndOwnerOnDate(Id buildingId, Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
buildingId
- a building Id
resourceId
- a resource Id
from
- start of date rangeto
- end of date range Deed
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- buildingId, resourceId,
from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeedsByGenusTypeForBuildingAndOwnerOnDate(Id buildingId, Id resourceId, Type deedGenusType, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
buildingId
- a building Id
resourceId
- a resource Id
deedGenusType
- a deed genus typefrom
- start of date rangeto
- end of date range Deed
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- buildingId, resourceId,
deedGenusType, from,
or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeedList getDeeds() throws OperationFailedException, PermissionDeniedException
Deeds.
In plenary mode, the returned list contains all known deeds or an
error results. Otherwise, the returned list may contain only those
deeds that are accessible through this session.
In effective mode, deeds are returned that are currently effective. In
any effective mode, effective deeds and those currently expired are
returned. Deeds
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.