com.hcl.domino.richtext.records

Interface CDActionByForm

All Superinterfaces:

MemoryStructure, ResizableMemoryStructure, RichTextRecord<WSIG>

public interface CDActionByForm
extends RichTextRecord<WSIG>

Since:

1.0.15

Author:

Jesse Gallagher

Method Summary

Modifier and Type	Method and Description
default ByteBuffer	getActionData() Retrieves the action data as a ByteBuffer view of the underlying structure data.
default List<AssistFieldStruct>	getAssistFields() Retrieves the action data as a list of AssistFieldStruct objects.
int	getFieldCount()
default String	getFormName()
default byte[]	getFormNameData()
int	getFormNameLength()
WSIG	getHeader()
default CDActionByForm	setActionData(byte[] actionData) Sets the action data for this record.
default CDActionByForm	setAssistFields(Collection<AssistFieldStruct> assistFieldStructs) Sets the action data for this record.
CDActionByForm	setFieldCount(int fieldCount)
default CDActionByForm	setFormName(String formName)
CDActionByForm	setFormNameLength(int formNameLength)

Methods inherited from interface com.hcl.domino.richtext.records.RichTextRecord

getCDRecordLength, getData, getDataWithoutHeader, getPayloadLength, getRecordHeaderLength, getType, getTypeValue

Methods inherited from interface com.hcl.domino.richtext.structures.ResizableMemoryStructure

getVariableData, resize, resizeVariableData

Method Detail

getHeader

WSIG getHeader()

Specified by:

getHeader in interface RichTextRecord<WSIG>

getFieldCount

int getFieldCount()

setFieldCount

CDActionByForm setFieldCount(int fieldCount)

getFormNameLength

int getFormNameLength()

setFormNameLength

CDActionByForm setFormNameLength(int formNameLength)

getFormName

default String getFormName()

getFormNameData

default byte[] getFormNameData()

setFormName

default CDActionByForm setFormName(String formName)

getActionData

default ByteBuffer getActionData()

Retrieves the action data as a ByteBuffer view of the underlying structure data. This data consists of a series of AssistFieldStruct structures.

Returns:

a ByteBuffer constrained to the action data

getAssistFields

default List<AssistFieldStruct> getAssistFields()

Retrieves the action data as a list of AssistFieldStruct objects. These objects are views onto the underlying data, though the association will be broken if they are resized.

Returns:

a List of AssistFieldStruct objects

setActionData

default CDActionByForm setActionData(byte[] actionData)

Sets the action data for this record.

Note: when modifying this data manually, it is important to also call setFieldCount(int) to reflect the number of AssistFieldStruct structures present.

Parameters:

actionData - the new action data to set

Returns:

this record

setAssistFields

default CDActionByForm setAssistFields(Collection<AssistFieldStruct> assistFieldStructs)

Sets the action data for this record.

Parameters:

assistFieldStructs - a Collection of AssistFieldStructs to set

Returns:

this record