public interface EntryBusinessSession extends OsidSession
This session provides methods to retrieve Entry
to
Business
mappings. An Entry
may appear in
multiple Business
objects. Each catalog may have its own
authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupEntryBusinessMappings()
Tests if this user can perform lookups of entry/business mappings.
|
EntryList |
getActivitieByBusiness(Id businessId)
Gets the list of
Entry associated with a
Business. |
EntryList |
getActivitieByBusinesses(IdList businessIds)
Gets the list of
Entries corresponding to a list of
Business objects. |
BusinessList |
getBusinessesByEntry(Id entryId)
Gets the
Business objects mapped to an Entry. |
IdList |
getBusinessIdsByEntry(Id entryId)
Gets the
Business Ids mapped to an
Entry. |
IdList |
getEntryIdsByBusiness(Id businessId)
Gets the list of
Entry Ids associated with a
Business. |
IdList |
getEntryIdsByBusinesses(IdList businessIds)
Gets the list of
Entry Ids corresponding to a list of
Business objects. |
void |
useComparativeEntryBusinessView()
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 |
usePlenaryEntryBusinessView()
A complete view of the
Entry and Business
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupEntryBusinessMappings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeEntryBusinessView()
mandatory
- This method is must be implemented. void usePlenaryEntryBusinessView()
Entry
and Business
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. IdList getEntryIdsByBusiness(Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Entry Ids
associated with a
Business.
businessId
- Id
of the Business
Ids
NotFoundException
- businessId
is not
foundNullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EntryList getActivitieByBusiness(Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Entry
associated with a
Business.
businessId
- Id
of the Business
NotFoundException
- businessId
is not
foundNullArgumentException
- businessId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getEntryIdsByBusinesses(IdList businessIds) throws OperationFailedException, PermissionDeniedException
Entry Ids
corresponding to a list of
Business
objects.businessIds
- list of catalog Ids
Ids
NullArgumentException
- businessIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EntryList getActivitieByBusinesses(IdList businessIds) throws OperationFailedException, PermissionDeniedException
Entries
corresponding to a list of
Business
objects.businessIds
- list of catalog Ids
NullArgumentException
- businessIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBusinessIdsByEntry(Id entryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Business
Ids
mapped to an
Entry.
entryId
- Id
of an Entry
NotFoundException
- entryId
is not foundNullArgumentException
- entryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BusinessList getBusinessesByEntry(Id entryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Business
objects mapped to an Entry.
entryId
- Id
of an Entry
NotFoundException
- entryId
is not foundNullArgumentException
- entryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.