RecordPropertyBean

Name RecordPropertyBean
Usage HandcarAuthorizationService
ExtensionRecordBean
Type Complex

Description

An extended property of an object based on the record types the object supports.

This holds any "extra" fields not explicitly in the contract.

It is sort of like a key-value pair where the key is the recordType + displayName and the value is the value.


OSID reference: Browsable

Structure Definition

ShortName Name Type Description Required? Read only? Implementation Notes
displayName Display Name DisplayTextBean The display name or KEY to identify the property.

This identifies the extra property being returned.

OSID reference: Property		      
description Description DisplayTextBean Get the description of the property.

This normally (but does not have to) remain the same for each instance of the display name found.

If left null on updates then it is set to the display name.

It can be used as help text to better describe the value when displaying it.

OSID reference: Property		      
recordTypeId Record Type Id String The type of the record used to extend the object to which this record property is attached.

A description of this type maybe obtained by searching the type service.

OSID reference: Property		   Read only  
value Value String The value of the property in string format.

It may be a number or date but translated to a string.

OSID reference: Property		      
displayLabel Display Label DisplayTextBean The label to be used to prefix this value when displaying it. Often it is the same as (or similar to) the displayName.

This normally (but does not have to) remain the same for each instance of the display name found.

If left null on updates then it is set to the display name.

OSID reference: Property		      
associatedId Associated Id String The id of the object to which this extra information applies.

This could be any object that has extra information

This is not updatable		 Required Read only  

JSON Structure

{
     "type" : "RecordProperty",
     "displayName" :  {
          "languageTypeId" : "id",
          "scriptTypeId" : "id",
          "formatTypeId" : "id",
          "text" : "XXXX"
          },
     "description" :  {
          "languageTypeId" : "id",
          "scriptTypeId" : "id",
          "formatTypeId" : "id",
          "text" : "XXXX"
          },
     "recordTypeId" : "id",
     "value" : "XXXX",
     "displayLabel" :  {
          "languageTypeId" : "id",
          "scriptTypeId" : "id",
          "formatTypeId" : "id",
          "text" : "XXXX"
          },
     "associatedId" : "id"
}