DisplayTextBean

Name DisplayTextBean
Usage HandcarAuthorizationService HandcarHierarchyService HandcarIdService HandcarLearningService HandcarLoggingService HandcarRelationshipService
TypeBean RecordPropertyBean VaultBean FunctionBean QualifierBean AuthorizationBean HierarchyBean BrandingBean AuthorityBean NamespaceBean ObjectiveBankBean ObjectiveBean ObjectiveNodeBean ActivityBean AssetBean AssetContentBean GradeSystemBean GradeBean AssetBasedActivityBean ObjectiveBankNodeBean ProficiencyBean LogBean LogEntryBean FamilyBean RelationshipBean
Type Complex

Description

Bean for holding displayable text along with metadata on the format and
structure of that text so that it may be displayed properly.

The metadata includes the language type, script type and format type.

Convenience methods have been added to most objects that contain DisplayText fields
to allow the java application to simply set the text and the default values of english,
latin, plain text will be automatically applied.

OSID reference: DisplayText

Structure Definition

ShortName Name Type Description Required? Read only? Implementation Notes
languageTypeId Language Type Id String An id for a type describing the language of the text

A description of the type can be found via the type service

For example english, french, etc.

OSID reference: ISOMajorLanguageTypes		      
scriptTypeId Script Type Id String An id for a type describing the script used in encoding the text

For example: latin, Cyrillic, etc...

A description of the type can be found via the type service

OSID reference: ISOScriptTypes		      
formatTypeId Format Type Id String A id for a type describing the format used to store the text

For example: plain, latex, html, rtf

A description of the type can be found via the type service

OSID reference: FormatTypes		      
text Text String The actual text to be displayed      

JSON Structure

{
     "type" : "DisplayText",
     "languageTypeId" : "id",
     "scriptTypeId" : "id",
     "formatTypeId" : "id",
     "text" : "XXXX"
}