IRecordインタフェース

IRecordインタフェースの概要

名前空間

Hitachi.OpenTP1

継承関係

Hitachi.OpenTP1.IRecord

説明

IRecordインタフェースは,カスタムレコードが実装しなければならないレコード名,およびレコードの簡易説明のプロパティを規定します。

メソッドの一覧

名称説明
GetRecordName()レコード名の取得を行います。
GetRecordShortDescription()レコードの簡易説明の取得を行います。
SetRecordName(System.String)レコード名を設定します。
SetRecordShortDescription(System.String)レコードの簡易説明を設定します。

メソッドの詳細

GetRecordName

説明
レコード名の取得を行います。
宣言
【C#の場合】

public abstract string GetRecordName(
);

【Visual Basicの場合】

Public MustOverride Function GetRecordName( _
) As String

【J#の場合】

public abstract System.String GetRecordName(
);

パラメタ
なし
戻り値
なし
例外
なし
注意事項
設定しているレコード名を返します。

 

GetRecordShortDescription

説明
レコードの簡易説明の取得を行います。
宣言
【C#の場合】

public abstract string GetRecordShortDescription(
);

【Visual Basicの場合】

Public MustOverride Function GetRecordShortDescription( _
) As String

【J#の場合】

public abstract System.String GetRecordShortDescription(
);

パラメタ
なし
戻り値
なし
例外
なし
注意事項
レコードに設定されている簡易説明を返します。

 

SetRecordName

説明
レコード名を設定します。
宣言
【C#の場合】

public abstract void SetRecordName(
 string recordName
);

【Visual Basicの場合】

Public MustOverride Sub SetRecordName( _
 ByVal recordName As String _
)

【J#の場合】

public abstract void SetRecordName(
 System.String recordName
);

パラメタ
recordName
新たに設定するレコード名称。
戻り値
なし
例外
なし

 

SetRecordShortDescription

説明
レコードの簡易説明を設定します。
宣言
【C#の場合】

public abstract void SetRecordShortDescription(
 string recordShortDescription
);

【Visual Basicの場合】

Public MustOverride Sub SetRecordShortDescription( _
 ByVal recordShortDescription As String _
)

【J#の場合】

public abstract void SetRecordShortDescription(
 System.String recordShortDescription
);

パラメタ
recordShortDescription
新たに設定するレコードの簡易説明。
戻り値
なし
例外
なし