com.appiancorp.suiteapi.rules

Class FreeformRule

java.lang.Object

com.appiancorp.suiteapi.common.Identity

com.appiancorp.suiteapi.content.Content

com.appiancorp.suiteapi.rules.Rule

com.appiancorp.suiteapi.rules.FreeformRule

All Implemented Interfaces:

LocalId, ContentConstants, AppianTypeHolder, java.io.Serializable

public class FreeformRule
extends Rule

Represents a freeform rule, which has a set of parameters and an expression which is run whenever the rule is called. The expression can contain the parameters as well as constants, process variables, activity class parameters, and activity return variables that are expected to exist in context when the expression is run.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFINITION_KEY
static boolean	definition$TRANSIENT
static java.lang.String	EDITOR_LEGACY
static java.lang.String	EDITOR_SAIL
static java.lang.String	FUNCTION_CATEGORY_KEY
static java.lang.String	METADATA_EXPR_KEY
static java.lang.String	OFFLINE_ENABLED_KEY
static java.lang.String	OPAQUE_ID_KEY
static java.lang.String	PARAMETERS_KEY
static boolean	parameters$TRANSIENT
static boolean	params$TRANSIENT
static java.lang.String	PREFERRED_EDITOR_KEY
static java.lang.String	SUPPRESSIONS_KEY
static java.lang.String	WHITELISTED_FOR_K_KEY Deprecated. This attribute is no longer used

Fields inherited from class com.appiancorp.suiteapi.rules.Rule

multiple$TRANSIENT, returnType$TRANSIENT

Fields inherited from interface com.appiancorp.suiteapi.content.ContentConstants

ACT_CREATE, ACT_DEACTIVATE, ACT_DELETE, AL_ADMIN, AL_EDITOR, AL_INVALID_ID, AL_NONE, AL_VIEWER, ALLOCATE_FSID, ALLOCATE_GLOBAL_PART, ALLOCATE_PART, APPLICATIONS_ROOT_DESCRIPTION, APPLICATIONS_ROOT_NAME, CHILDREN, COLUMN_ACTION_REQUESTED, COLUMN_ACTION_REQUESTER, COLUMN_ATTRIBUTES, COLUMN_CHANGES_REQUIRE_APPROVAL, COLUMN_CREATED_TIMESTAMP, COLUMN_CREATOR, COLUMN_DESCRIPTION, COLUMN_EXPIRATION_DAYS, COLUMN_EXPIRATION_TIMESTAMP, COLUMN_EXTENSION, COLUMN_FORUM, COLUMN_FSID, COLUMN_FSID_COUNT, COLUMN_ID, COLUMN_LOCKED_BY, COLUMN_LOG, COLUMN_LOG_NAME, COLUMN_METADATA_IDS, COLUMN_NAME, COLUMN_NONE, COLUMN_NUMBER_OF_VERSIONS, COLUMN_PARENT_ID, COLUMN_PARENT_NAME, COLUMN_PARENT_TYPE, COLUMN_PARTITION, COLUMN_PARTITION_NAME, COLUMN_SECURITY, COLUMN_SIZE, COLUMN_STATE, COLUMN_SUBTYPE, COLUMN_TYPE, COLUMN_UPDATED_TIMESTAMP, COLUMN_UUID, COLUMN_VERSION_ID, COLUMN_VERSIONS, COLUMN_VISIBILITY, COMMUNITY_ROOT, CONTENT_SECURITY_TYPE, CREATION_SECURITY_TYPE, FILTER_TYPE_ALL, GC_MOD_DRAFT, GC_MOD_LINKS, GC_MOD_NORMAL, GC_MOD_POPULATE_TYPES_OF_CHILDREN, GC_VERSIONS_AS_FOLDERS, I18N_PREFIX, IMPORT_INVALID_PRIVILEGE, IMPORT_NAME_EXISTS_WITHIN_PARENT, IMPORT_NAME_EXISTS_WITHIN_TYPE, IMPORT_NAME_WITH_UUID_EXISTS_WITHIN_PARENT, IMPORT_UUID_EXISTS_ELSEWHERE, IMPORT_VALID, INFINITY, KM_EXPIRATION_DURATION_CHECK, KM_SECURITY_COMMUNITY, KM_SECURITY_CONTENT_COMMUNITY, KM_SECURITY_CONTENT_FOLDER, KM_SECURITY_CONTENT_KC, KM_SECURITY_FOLDER, KM_SECURITY_KNOWLEDGE_CENTER, KNOWLEDGE_ROOT, KNOWLEDGE_ROOT_SYSTEM_ID, MIGRATION_FLAG, NEGATIVE_INFINITY, NO_CHILDREN, NO_EXPIRATION_TIMESTAMP, NO_FORUM, NO_REVIEW, QUERY_KEYWORDS, RESTRICTION_ROLE_MAP_ROLES, RM_AGGREGATE, RM_EXPLICIT, ROLE_ADMINISTRATORS, ROLE_AUTHORS, ROLE_DENY_ADMINISTRATORS, ROLE_DENY_AUTHORS, ROLE_DENY_READERS, ROLE_MAP_ROLES, ROLE_READERS, RULE_ENCODING, RULES_ROOT_DESCRIPTION, RULES_ROOT_NAME, RULES_ROOT_SYSTEM_ID, SEC_ALL_ADMIN, SEC_ALL_EDITOR, SEC_ALL_VIEWER, SEC_CREATOR_ADMIN, SEC_INH_ADMIN, SEC_INH_ADMIN_MASK, SEC_INH_ALL, SEC_INH_EDITOR, SEC_INH_VIEWER, SEC_PUBLIC, SECURITY_MANAGER_CONFIG, STATE_ACTIVE, STATE_ACTIVE_PENDING_APPROVAL, STATE_ACTIVE_PUBLISHED, STATE_ACTIVE_REJECTED, STATE_PENDING_APPROVAL, STATE_PUBLISHED, STATE_REJECTED, SUBTYPE_CONNECTED_SYSTEM, SUBTYPE_DATA_STORE_CONFIG, SUBTYPE_FOLDER_APPLICATIONS, SUBTYPE_FOLDER_CONNECTED_SYSTEMS, SUBTYPE_FOLDER_DATA_STORE_CONFIGS, SUBTYPE_FOLDER_KNOWLEDGE, SUBTYPE_FOLDER_MIGRATION_FLAGS, SUBTYPE_FOLDER_RULES, SUBTYPE_MIGRATION_FLAG, SUBTYPE_RULE_CONSTANT, SUBTYPE_RULE_DECISION, SUBTYPE_RULE_DECISION_TABLE, SUBTYPE_RULE_FREEFORM, SUBTYPE_RULE_INTERFACE, SUBTYPE_RULE_OUTBOUND_INTEGRATION, SUBTYPE_RULE_QUERY, SYSADMIN_GRP, SYSADMIN_UTYPE, SYSTEM_ASYNC_INSPECT_FOLDER_NAME, SYSTEM_FOLDER_COVER_PHOTOS_NAME, SYSTEM_FOLDER_OFFLINE_RULE_BUNDLES_NAME, SYSTEM_FOLDER_RECORD_TYPES_NAME, SYSTEM_FOLDER_TEMPO_ATTACHMENTS_ROOT_DESCRIPTION, SYSTEM_FOLDER_TEMPO_ATTACHMENTS_ROOT_NAME, SYSTEM_IX_FOLDER_NAME, SYSTEM_OBJECT_TEMPLATES_FOLDER_NAME, SYSTEM_OPENAPI_FOLDER_NAME, SYSTEM_PACKAGES_FOLDER_NAME, SYSTEM_RECORD_TYPE_NAME_PREFIX, SYSTEM_SYSRULES_DESIGNER_ROOT_DESCRIPTION, SYSTEM_SYSRULES_DESIGNER_ROOT_NAME, SYSTEM_SYSRULES_INTERNAL_ROOT_DESCRIPTION, SYSTEM_SYSRULES_INTERNAL_ROOT_NAME, TYPE_ALL, TYPE_ANY_KC, TYPE_APPLICATION, TYPE_COMMUNITY, TYPE_COMMUNITY_KC, TYPE_CONTAINER, TYPE_CONTENT, TYPE_CUSTOM, TYPE_DOCUMENT, TYPE_FOLDER, TYPE_IGNORE, TYPE_NON_CONTAINER, TYPE_NON_DOCUMENT, TYPE_PERSONAL_KC, TYPE_RULE, UNIQUE_FOR_ALL, UNIQUE_FOR_PARENT, UNIQUE_FOR_SYSTEM_RULES_LATEST_VERSION, UNIQUE_FOR_TYPE, UNIQUE_FOR_TYPE_AND_SUBTYPE_LATEST_VERSION, UNIQUE_FOR_TYPE_LATEST_VERSION, UNIQUE_NONE, UUID_ACTIVE_PROCESSES_REPORT, UUID_ACTIVE_TASKS_GROUP_MEMBERS_REPORT, UUID_ACTIVE_TASKS_GROUP_REPORT, UUID_ACTIVE_TASKS_REPORT, UUID_ALL_PROCESS_MODELS_REPORT, UUID_ALL_PROCESSES_REPORT, UUID_ALL_TASKS_REPORT, UUID_APPLICATIONS_HOME, UUID_APPLICATIONS_ROOT, UUID_ASYNC_INSPECT_FOLDER, UUID_CANCELED_PROCESSES_REPORT, UUID_COMMUNITY_ROOT, UUID_COMPLETED_PROCESSES_REPORT, UUID_COMPLETED_TASKS_REPORT, UUID_CURRENT_TASKS_PER_PROCESS_REPORT, UUID_DATA_STORE_CONFIGS_ROOT_FOLDER, UUID_DEFAULT_COMMUNITY, UUID_EMAIL_FOOTER_TEMPLATE, UUID_EMAIL_HEADER_TEMPLATE, UUID_EMAIL_TEMPLATE_FOLDER, UUID_FAVORITE_PROCESS_MODELS_REPORT, UUID_FAVORITE_PROCESSES_REPORT, UUID_FAVORITE_TASKS_REPORT, UUID_HIGH_PRIORITY_TASKS_REPORT, UUID_IX_FOLDER, UUID_LEADER_MESSAGE_PICTURES_FOLDER, UUID_MIGRATION_FLAGS_ROOT_FOLDER, UUID_MOST_ACTIVE_PROCESS_MODELS_REPORT, UUID_NAVIGATION_CONFIG, UUID_NODE_STATS_PER_PROCESS_MODEL_REPORT, UUID_NODE_STATS_PER_PROCESS_REPORT, UUID_OBJECT_TEMPLATES_FOLDER, UUID_OFFLINE_RULE_BUNDLES_FOLDER, UUID_OPENAPI_FOLDER, UUID_OVERDUE_TASKS_REPORT, UUID_PACKAGES_FOLDER, UUID_PAUSED_PROCESSES_REPORT, UUID_PERFORMANCE_INDICATOR_GREEN, UUID_PERFORMANCE_INDICATOR_RED, UUID_PERFORMANCE_INDICATOR_YELLOW, UUID_PRIORITY_ICONS_FOLDER, UUID_PROCESS_DETAILS_PER_PROCESS_MODEL_REPORT, UUID_PROCESS_INSTANCES_PER_MODEL_REPORT, UUID_PROCESS_MODEL_REPORT_FOLDER, UUID_PROCESS_OPTIMIZATION_REPORTS_FOLDER, UUID_PROCESS_REPORTS_FOLDER, UUID_PROCESSES_STARTED_BY_ME_REPORT, UUID_PROCESSES_WITH_PROBLEMS_REPORT, UUID_RULES_ROOT_FOLDER, UUID_RUNNING_PROCESSES_PER_MODEL_REPORT, UUID_STATISTICS_ACROSS_PROCESSES_REPORT, UUID_SUBPROCESSES_PER_PROCESS_REPORT, UUID_SUMMARY_REPORTS_FOLDER, UUID_SYSTEM_DOC_PRIORITY_HIGH, UUID_SYSTEM_DOC_PRIORITY_LOW, UUID_SYSTEM_DOC_PRIORITY_NORMAL, UUID_SYSTEM_FOLDER_TEMPO_ATTACHMENTS, UUID_SYSTEM_KNOWLEDGE_CENTER, UUID_SYSTEM_RECORD_TYPES_FOLDER, UUID_SYSTEM_REPORTS_FOLDER, UUID_SYSTEM_SYSRULES_DESIGNER_ROOT, UUID_SYSTEM_SYSRULES_FOLDER_DESIGNER, UUID_SYSTEM_SYSRULES_FOLDER_ENGINEERING, UUID_SYSTEM_SYSRULES_FOLDER_EVOLVED_PREVIOUS_VERSIONS, UUID_SYSTEM_SYSRULES_FOLDER_HOME, UUID_SYSTEM_SYSRULES_INTERNAL_ROOT, UUID_TASK_REPORTS_FOLDER, UUID_TASKS_DUE_TODAY_REPORT, UUID_TASKS_FOR_USER_REPORT, UUID_TASKS_PER_PROCESS_MODEL_REPORT, UUID_TEMPORARY_DOCS_FOLDER, UUID_TEMPORARY_DOCS_KC, UUID_USER_COVER_PHOTOS_FOLDER, UUID_USER_PICTURES_FOLDER, UUID_USER_THUMBNAILS_FOLDER, UUID_VERSIONS_PER_PROCESS_MODEL_REPORT, VERSION_CURRENT, VERSION_ORIGINAL, VIS_ADVERTISE, VIS_DEFAULT, VIS_HIERARCHY, VIS_INDEXABLE, VIS_QUOTA, VIS_SEARCHABLE, VIS_SYSTEM, VIS_UNLOGGED

Constructor Summary

Constructors

Modifier	Constructor and Description
	FreeformRule() Constructs a new freeform rule object.
protected	FreeformRule(int subtype)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefinition() Gets the definition (the expression to run) using the format for retrieval.
java.lang.String	getFunctionCategory() Returns the function category under which the rule will appear in the expression editor.
java.lang.String	getIcon()
java.lang.Boolean	getOfflineEnabled() Returns the offline attribute for an interface freeform rule.
java.lang.String	getOpaqueId()
TypedVariable[]	getParameters() Deprecated. use getParams() instead
NamedTypedValue[]	getParams() Gets the parameters to this freeform rule as an array of NamedTypedValue.
java.lang.String	getPreferredEditor()
java.lang.String	getSuppressions() Returns the suppressions keys added by developers on out-of-the-box system rules.
java.lang.Boolean	isWhitelistedForK() Deprecated. This attribute is no longer used
void	setDefinition(java.lang.String definition) Sets the definition (the expression to run) using the format for storage.
void	setOfflineEnabled(java.lang.Boolean isOfflineEnabled) Sets the offline enabled attribute for an interface freeform rule.
void	setParameters(TypedVariable[] tvs) Deprecated. use setParams(NamedTypedValue[]) instead
void	setParams(NamedTypedValue[] ntvs) Sets the parameters to this freeform rule.
void	setWhitelistedForK(java.lang.Boolean isWhitelistedForKExecution) Deprecated. This attribute is no longer used.

Methods inherited from class com.appiancorp.suiteapi.rules.Rule

getMultiple, getReturnType, setMultiple, setMultiple, setMultiple, setReturnType, setReturnType

Methods inherited from class com.appiancorp.suiteapi.content.Content

addSecurity, addSecurity, addVisibility, addVisibility, fillInAppianTypes, getActionRequested, getActionRequester, getAttributes, getChangesRequireApproval, getCreatedTimestamp, getCreator, getCurrentContentId, getDepth, getDescription, getDisplayName, getExpirationTimestamp, getFavorite, getForum, getLatestVersionId, getLockedAt, getLockedBy, getLockedByUsername, getLog, getLogName, getNumberOfVersions, getOriginalContentId, getParent, getParentName, getParentType, getPartition, getPartitionName, getPendingApprovalCount, getRoleSet, getSecurity, getSize, getState, getSubtype, getType, getTypesOfChildren, getUpdatedTimestamp, getUsersPendingAccess, getUuid, getVersionId, getVersions, getVisibility, hasChildrenOfType, removeSecurity, removeSecurity, removeVisibility, removeVisibility, securityContains, securityContains, setActionRequested, setActionRequester, setAttributes, setChangesRequireApproval, setCreatedTimestamp, setCreator, setCurrentContentId, setDepth, setDescription, setExpirationTimestamp, setFavorite, setForum, setLatestVersionId, setLockedAt, setLockedBy, setLockedByUsername, setLog, setLogName, setNumberOfVersions, setOriginalContentId, setParent, setParentName, setParentType, setPartition, setPartitionName, setPendingApprovalCount, setRoleSet, setSecurity, setSecurity, setSize, setState, setSubtype, setSubtype, setType, setTypesOfChildren, setUpdatedTimestamp, setUsersPendingAccess, setUuid, setVersionId, setVersions, setVisibility, setVisibility, toString, visibilityContains, visibilityContains

Methods inherited from class com.appiancorp.suiteapi.common.Identity

equals, getId, getName, hashCode, setId, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PARAMETERS_KEY

public static final java.lang.String PARAMETERS_KEY

See Also:

Constant Field Values

DEFINITION_KEY

public static final java.lang.String DEFINITION_KEY

See Also:

Constant Field Values

PREFERRED_EDITOR_KEY

public static final java.lang.String PREFERRED_EDITOR_KEY

See Also:

Constant Field Values

EDITOR_LEGACY

public static final java.lang.String EDITOR_LEGACY

See Also:

Constant Field Values

EDITOR_SAIL

public static final java.lang.String EDITOR_SAIL

See Also:

Constant Field Values

OPAQUE_ID_KEY

public static final java.lang.String OPAQUE_ID_KEY

See Also:

Constant Field Values

FUNCTION_CATEGORY_KEY

public static final java.lang.String FUNCTION_CATEGORY_KEY

See Also:

Constant Field Values

OFFLINE_ENABLED_KEY

public static final java.lang.String OFFLINE_ENABLED_KEY

See Also:

Constant Field Values

METADATA_EXPR_KEY

public static final java.lang.String METADATA_EXPR_KEY

See Also:

Constant Field Values

SUPPRESSIONS_KEY

public static final java.lang.String SUPPRESSIONS_KEY

See Also:

Constant Field Values

WHITELISTED_FOR_K_KEY

@Deprecated
public static final java.lang.String WHITELISTED_FOR_K_KEY

Deprecated. This attribute is no longer used

See Also:

Constant Field Values

parameters$TRANSIENT

public static final boolean parameters$TRANSIENT

See Also:

Constant Field Values

definition$TRANSIENT

public static final boolean definition$TRANSIENT

See Also:

Constant Field Values

params$TRANSIENT

public static final boolean params$TRANSIENT

See Also:

Constant Field Values

Constructor Detail

FreeformRule

public FreeformRule()

Constructs a new freeform rule object.

FreeformRule

protected FreeformRule(int subtype)

Method Detail

getParams

public NamedTypedValue[] getParams()

Gets the parameters to this freeform rule as an array of NamedTypedValue. This is not stored as a full-fledged field, but instead is stored as an attribute. This call delegates to #getParameters()).

Returns:

the parameters

See Also:

Content.getAttributes()

setParams

public void setParams(NamedTypedValue[] ntvs)

Sets the parameters to this freeform rule. This call delegates to {@link #setParameters(TypedVariable[]).

Parameters:

ntvs - the parameters

See Also:

getParams(), com.appiancorp.suiteapi.content.Content#setAttributes()

getParameters

@Deprecated
public TypedVariable[] getParameters()

Deprecated. use getParams() instead

Gets the parameters to this freeform rule. This is not stored as a full-fledged field, but instead is stored as an attribute.

Returns:

the parameters

See Also:

setParameters(TypedVariable[]), Content.getAttributes()

setParameters

@Deprecated
public void setParameters(TypedVariable[] tvs)

Deprecated. use setParams(NamedTypedValue[]) instead

Sets the parameters to this freeform rule. This is not stored as a full-fledged field, but instead is stored as an attribute. This field can be updated in the database.

Parameters:

tvs - the parameters

See Also:

getParameters(), Content.getAttributes()

getDefinition

public java.lang.String getDefinition()

Gets the definition (the expression to run) using the format for retrieval.

See Also:

TypeTransformation.TYPE_ID_TO_TYPE_NAMESPACE_CURRENT_IF_LATEST_VERSION_MODE_ON_FOR_RULES

getPreferredEditor

public java.lang.String getPreferredEditor()

getOfflineEnabled

public java.lang.Boolean getOfflineEnabled()

Returns the offline attribute for an interface freeform rule. This attribute indicates whether the rule is enabled for offline mobile use. If the offline enabled atrribute has not been set, this method returns false.

Returns:

whether or not the rule is enabled for offline use.

See Also:

Content.getAttributes()

setOfflineEnabled

public void setOfflineEnabled(java.lang.Boolean isOfflineEnabled)

Sets the offline enabled attribute for an interface freeform rule. This attribute indicates whether the rule is enabled for offline mobile use.

Parameters:

isOfflineEnabled - the offline setting

See Also:

Content.getAttributes()

isWhitelistedForK

@Deprecated
public java.lang.Boolean isWhitelistedForK()

Deprecated. This attribute is no longer used

Gets the whitelistedForK attribute for a freeform rule. This attribute only applies to system rules.

setWhitelistedForK

@Deprecated
public void setWhitelistedForK(java.lang.Boolean isWhitelistedForKExecution)

Deprecated. This attribute is no longer used.

Sets the whitelistedForK attribute for a freeform rule. This attribute only applies to system rules.

Parameters:

isWhitelistedForKExecution - does this system rule run in-engine?

getFunctionCategory

@Nullable
public java.lang.String getFunctionCategory()

Returns the function category under which the rule will appear in the expression editor. Only out-of-the-box system rules are assigned a category. Rules created by designers do not appear in function categories, but instead appear under their folder in the Rules tab of the expression editor.

getSuppressions

@Nullable
public java.lang.String getSuppressions()

Returns the suppressions keys added by developers on out-of-the-box system rules. Rules created by designers do not have suppressions. The suppressions keys are comma-separated. See SysRuleStandardsTestHelper for the list of valid keys.

setDefinition

public void setDefinition(java.lang.String definition)

Sets the definition (the expression to run) using the format for storage.

See Also:

TypeTransformation.TYPE_NAMESPACE_TO_TYPE_ID_FALLING_BACK_TO_LATEST_DEACTIVATED_VERSION

getIcon

public java.lang.String getIcon()

Specified by:

getIcon in class Rule

getOpaqueId

@Transient
public java.lang.String getOpaqueId()