Interface IdiomPressSession
- All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
This session provides methods to retrieve Idiom to
Press mappings. An Idiom may appear in multiple Press
objects. Each press may have its own authorizations governing who is
allowed to look at it.
This lookup session defines several views:
- comparative view: elements may be silently omitted or re-ordered
- plenary view: provides a complete result set or is an error condition
-
Method Summary
Modifier and TypeMethodDescriptionbooleanTests if this user can perform lookups of idiom/press mappings.getIdiomIdsByPress(Id pressId) Gets the list ofIdiom Idsassociated with aPress.getIdiomIdsByPresses(IdList pressIds) Gets the list ofIdiom Idscorresponding to a list ofPresses.getIdiomsByPress(Id pressId) Gets the list ofIdiomsassociated with aPress.getIdiomsByPresses(IdList pressIds) Gets the list ofIdiomcorresponding to a list ofPresses.getPressesByIdiom(Id idiomId) Gets thePressesmapped to anIdiom.getPressIdsByIdiom(Id idiomId) Gets thePressIdsmapped to anIdiom.voidThe returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.voidA complete view of theIdiomandPressreturns is desired.Methods inherited from interface OsidSession
closeMethods inherited from interface OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionsModifier and TypeMethodDescriptionGets the agent authenticated to this session.Gets theIdof the agent authenticated to this session.Gets the rate of the service clock.getDate()Gets the service date which may be the current date or the effective date in which this session exists.Gets the effective agent in use by this session.Gets theIdof the effective agent in use by this session.Gets theDisplayTextformatTypepreference in effect for this session.Gets the locale indicating the localization preferences in effect for this session.booleanTests if an agent is authenticated to this session.Starts a new transaction for this sesson.booleanTests for the availability of transactions.
-
Method Details
-
canLookupIdiomPressMappings
boolean canLookupIdiomPressMappings()Tests if this user can perform lookups of idiom/press mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in aPERMISSION_DENIED. This is intended as a hint to an press that may opt not to offer lookup operations to unauthorized users.- Returns:
falseif looking up mappings is not authorized,trueotherwise- Compliance:
mandatory- This method must be implemented.
-
useComparativeIdiomPressView
void useComparativeIdiomPressView()The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.- Compliance:
mandatory- This method is must be implemented.
-
usePlenaryIdiomPressView
void usePlenaryIdiomPressView()A complete view of theIdiomandPressreturns 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.- Compliance:
mandatory- This method is must be implemented.
-
getIdiomIdsByPress
IdList getIdiomIdsByPress(Id pressId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets the list ofIdiom Idsassociated with aPress.- Parameters:
pressId-Idof thePress- Returns:
- list of related idiom
Ids - Throws:
NotFoundException-pressIdis not foundNullArgumentException-pressIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getIdiomsByPress
IdiomList getIdiomsByPress(Id pressId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets the list ofIdiomsassociated with aPress.- Parameters:
pressId-Idof thePress- Returns:
- list of related idioms
- Throws:
NotFoundException-pressIdis not foundNullArgumentException-pressIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getIdiomIdsByPresses
IdList getIdiomIdsByPresses(IdList pressIds) throws OperationFailedException, PermissionDeniedException Gets the list ofIdiom Idscorresponding to a list ofPresses.- Parameters:
pressIds- list of pressIds- Returns:
- list of idiom
Ids - Throws:
NullArgumentException-pressIdsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getIdiomsByPresses
IdiomList getIdiomsByPresses(IdList pressIds) throws OperationFailedException, PermissionDeniedException Gets the list ofIdiomcorresponding to a list ofPresses.- Parameters:
pressIds- list of pressIds- Returns:
- list of idioms
- Throws:
NullArgumentException-pressIdsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getPressIdsByIdiom
IdList getPressIdsByIdiom(Id idiomId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets thePressIdsmapped to anIdiom.- Parameters:
idiomId-Idof anIdiom- Returns:
- list of presses
- Throws:
NotFoundException-idiomIdis not foundNullArgumentException-idiomIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getPressesByIdiom
PressList getPressesByIdiom(Id idiomId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets thePressesmapped to anIdiom.- Parameters:
idiomId-Idof anIdiom- Returns:
- list of presses
- Throws:
NotFoundException-idiomIdis not foundNullArgumentException-idiomIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-