Text

All Superinterfaces:: Browsable, Extensible, Identifiable, OsidObject

public interface Text extends OsidObject

A Text.

Like all OsidObjects, Text is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Method Summary

Modifier and Type

Method

Description

TextRecord

getTextRecord(Type textRecordType)

Gets the text record corresponding to the given Text record Type.This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable
getProperties, getPropertiesByRecordType

Methods inherited from interface Extensible
getRecordTypes, hasRecordType

Methods inherited from interface Identifiable
getId, isCurrent

Methods inherited from interface OsidObject
getDescription, getDisplayName, getGenusType, isOfGenusType

Method Details
- getTextRecord
  
  TextRecord getTextRecord(Type textRecordType) throws OperationFailedException, PermissionDeniedException
  
  Gets the text record corresponding to the given Text record Type.This method is used to retrieve an object implementing the requested record. The textRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(textRecordType) is true.
  
  Parameters:
  
  textRecordType - the type of text record to retrieve
  
  Returns:
  
  the text record
  
  Throws:
  
  NullArgumentException - textRecordType is null
  
  OperationFailedException - unable to complete request
  
  PermissionDeniedException - authorization failure occurred
  
  UnsupportedException - hasRecordType(textRecordType) is false
  
  Compliance:
  mandatory - This method must be implemented.