public interface PostBusinessSession extends OsidSession
This session provides methods to retrieve Post
to
Business
mappings. A Post
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 |
canLookupPostBusinessMappings()
Tests if this user can perform lookups of post/business mappings.
|
BusinessList |
getBusinessesByPost(Id postId)
Gets the
Business objects mapped to a Post. |
IdList |
getBusinessIdsByPost(Id postId)
Gets the
Business Ids mapped to a
Post. |
IdList |
getPostIdsByBusiness(Id businessId)
Gets the list of
Post Ids associated with a
Business. |
IdList |
getPostIdsByBusinesses(IdList businessIds)
Gets the list of
Post Ids corresponding to a list of
Business objects. |
PostList |
getPostsByBusiness(Id businessId)
Gets the list of
Posts associated with a
Business. |
PostList |
getPostsByBusinesses(IdList businessIds)
Gets the list of
Posts corresponding to a list of
Business objects. |
void |
useComparativePostBusinessView()
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 |
usePlenaryPostBusinessView()
A complete view of the
Post and Business
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupPostBusinessMappings()
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 useComparativePostBusinessView()
mandatory
- This method is must be implemented. void usePlenaryPostBusinessView()
Post
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 getPostIdsByBusiness(Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Post 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. PostList getPostsByBusiness(Id businessId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Posts
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 getPostIdsByBusinesses(IdList businessIds) throws OperationFailedException, PermissionDeniedException
Post Ids
corresponding to a list of
Business
objects.businessIds
- list of business Ids
Ids
NullArgumentException
- businessIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PostList getPostsByBusinesses(IdList businessIds) throws OperationFailedException, PermissionDeniedException
Posts
corresponding to a list of
Business
objects.businessIds
- list of business Ids
NullArgumentException
- businessIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getBusinessIdsByPost(Id postId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Business
Ids
mapped to a
Post.
postId
- Id
of a Post
NotFoundException
- postId
is not foundNullArgumentException
- postId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BusinessList getBusinessesByPost(Id postId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Business
objects mapped to a Post.
postId
- Id
of a Post
NotFoundException
- postId
is not foundNullArgumentException
- postId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.