Interface TextPressSession
- All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
This session provides methods to retrieve Text to Press
mappings. A Text 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 text/press mappings.getPressesByText(Id textId) Gets thePressesmapped to aText.getPressIdsByText(Id textId) Gets thePressIdsmapped to aText.getTextIdsByPress(Id pressId) Gets the list ofText Idsassociated with aPress.getTextIdsByPresses(IdList pressIds) Gets the list ofText Idscorresponding to a list ofPresses.getTextsByPress(Id pressId) Gets the list ofTextsassociated with aPress.getTextsByPresses(IdList pressIds) Gets the list ofTextcorresponding to a list ofPresses.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 theTextandPressreturns 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
-
canLookupTextPressMappings
boolean canLookupTextPressMappings()Tests if this user can perform lookups of text/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.
-
useComparativeTextPressView
void useComparativeTextPressView()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.
-
usePlenaryTextPressView
void usePlenaryTextPressView()A complete view of theTextandPressreturns 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.
-
getTextIdsByPress
IdList getTextIdsByPress(Id pressId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets the list ofText Idsassociated with aPress.- Parameters:
pressId-Idof thePress- Returns:
- list of related text
Ids - Throws:
NotFoundException-pressIdis not foundNullArgumentException-pressIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getTextsByPress
TextList getTextsByPress(Id pressId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets the list ofTextsassociated with aPress.- Parameters:
pressId-Idof thePress- Returns:
- list of related texts
- Throws:
NotFoundException-pressIdis not foundNullArgumentException-pressIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getTextIdsByPresses
IdList getTextIdsByPresses(IdList pressIds) throws OperationFailedException, PermissionDeniedException Gets the list ofText Idscorresponding to a list ofPresses.- Parameters:
pressIds- list of pressIds- Returns:
- list of text
Ids - Throws:
NullArgumentException-pressIdsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getTextsByPresses
TextList getTextsByPresses(IdList pressIds) throws OperationFailedException, PermissionDeniedException Gets the list ofTextcorresponding to a list ofPresses.- Parameters:
pressIds- list of pressIds- Returns:
- list of texts
- Throws:
NullArgumentException-pressIdsisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getPressIdsByText
IdList getPressIdsByText(Id textId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets thePressIdsmapped to aText.- Parameters:
textId-Idof aText- Returns:
- list of presses
- Throws:
NotFoundException-textIdis not foundNullArgumentException-textIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getPressesByText
PressList getPressesByText(Id textId) throws NotFoundException, OperationFailedException, PermissionDeniedException Gets thePressesmapped to aText.- Parameters:
textId-Idof aText- Returns:
- list of presses
- Throws:
NotFoundException-textIdis not foundNullArgumentException-textIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-