com.hcl.domino.richtext.records

Interface CDAction

All Superinterfaces:

MemoryStructure, ResizableMemoryStructure, RichTextRecord<LSIG>

public interface CDAction
extends RichTextRecord<LSIG>

Since:

1.0.15

Author:

Jesse Gallagher

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CDAction.Flag
static class	CDAction.Type

Method Summary

Modifier and Type	Method and Description
default byte[]	getActionData()
default String	getActionFormula() Retrieves the formula for this action as a string.
default int	getActionLength()
default String	getActionLotusScript() Retrieves the LotusScript for this action as a string.
CDAction.Type	getActionType()
default byte[]	getCompiledHideWhenFormula() Retrieves the compiled hide-when formula for this action as a byte array.
Set<CDAction.Flag>	getFlags()
LSIG	getHeader()
default String	getHideWhenFormula() Retrieves the hide-when formula for this action as a string.
int	getHideWhenFormulaLength()
int	getIconIndex()
int	getShareId()
default String	getTitle()
int	getTitleLength()
default CDAction	setActionData(byte[] actionData)
default CDAction	setActionFormula(String formula) Sets the action's code to the provided formula language string.
default CDAction	setActionLotusScript(String script) Sets the action's code to the provided LotusScript string.
CDAction	setActionType(CDAction.Type type) Sets the type for this action.
CDAction	setFlags(Collection<CDAction.Flag> flags)
default CDAction	setHideWhenFormula(String formula) Sets the action's hide-when formula to the provided string.
CDAction	setHideWhenFormulaLength(int formulaLength)
CDAction	setIconIndex(int iconIndex)
CDAction	setShareId(int shareId)
default CDAction	setTitle(String title)
CDAction	setTitleLength(int titleLength)

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

LSIG getHeader()

Specified by:

getHeader in interface RichTextRecord<LSIG>

getActionType

CDAction.Type getActionType()

setActionType

CDAction setActionType(CDAction.Type type)

Sets the type for this action.

This type is also set implicitly by setActionFormula(String) and setActionLotusScript(String). When setting the type explicitly, you are responsible for setting setActionData(byte[]) to an appropriate value.

Parameters:

type - the new type for the action

Returns:

this action

getIconIndex

int getIconIndex()

setIconIndex

CDAction setIconIndex(int iconIndex)

getFlags

Set<CDAction.Flag> getFlags()

setFlags

CDAction setFlags(Collection<CDAction.Flag> flags)

getTitleLength

int getTitleLength()

setTitleLength

CDAction setTitleLength(int titleLength)

getHideWhenFormulaLength

int getHideWhenFormulaLength()

setHideWhenFormulaLength

CDAction setHideWhenFormulaLength(int formulaLength)

getShareId

int getShareId()

setShareId

CDAction setShareId(int shareId)

getTitle

default String getTitle()

setTitle

default CDAction setTitle(String title)

getActionLength

default int getActionLength()

getActionData

default byte[] getActionData()

setActionData

default CDAction setActionData(byte[] actionData)

getActionFormula

default String getActionFormula()

Retrieves the formula for this action as a string.

Returns:

the decompiled formula for this action

Throws:

UnsupportedOperationException - if the action's type is not CDAction.Type.RUN_FORMULA

setActionFormula

default CDAction setActionFormula(String formula)

Sets the action's code to the provided formula language string. This method has the side effect of setting the action type to CDAction.Type.RUN_FORMULA.

Parameters:

formula - the formula-language string to set

Returns:

this action

getActionLotusScript

default String getActionLotusScript()

Retrieves the LotusScript for this action as a string.

Returns:

the LotusScript for this action

Throws:

UnsupportedOperationException - if the action's type is not CDAction.Type.RUN_SCRIPT

setActionLotusScript

default CDAction setActionLotusScript(String script)

Sets the action's code to the provided LotusScript string. This method has the side effect of setting the action type to CDAction.Type.RUN_SCRIPT.

Parameters:

script - the LotusScript string to set

Returns:

this action

getCompiledHideWhenFormula

default byte[] getCompiledHideWhenFormula()

Retrieves the compiled hide-when formula for this action as a byte array.

Returns:

the compiled hide-when formula for this action

setHideWhenFormula

default CDAction setHideWhenFormula(String formula)

Sets the action's hide-when formula to the provided string.

Parameters:

formula - the formula-language string to set

Returns:

this action

getHideWhenFormula

default String getHideWhenFormula()

Retrieves the hide-when formula for this action as a string.

Returns:

the decompiled hide-when formula for this action