Package com.appiancorp.suiteapi.process
Class TypedVariable
java.lang.Object
com.appiancorp.suiteapi.type.TypedValue
com.appiancorp.suiteapi.type.NamedTypedValue
com.appiancorp.suiteapi.process.TypedVariable
- All Implemented Interfaces:
com.appiancorp.core.expr.portable.PortableNamedTypedValue
,com.appiancorp.core.expr.portable.PortableNamedTypedValueWithChildren
,com.appiancorp.core.expr.portable.PortableTypedValue
,DeepCloneable
,JSONable
,JSONCacheable
,XMLable
,AppianTypeHolder
,TypedVariableTypes
,AppianType
,com.appiancorp.type.HasTypeRef
,com.appiancorp.type.NamedType
,Serializable
,Cloneable
- Direct Known Subclasses:
ActivityClassParameterSchema
,GenericTypedVariable
,Mapping
,ProcessVariable
@Deprecated
public class TypedVariable
extends NamedTypedValue
implements XMLable, AppianTypeHolder, Serializable, TypedVariableTypes, DeepCloneable, com.appiancorp.core.expr.portable.PortableNamedTypedValueWithChildren
Deprecated.
Base class for the parameters and variables in the system. Generally,
a typed variable is a binding between a key and a value, with the additional
attribute of a type giving context to the value. The key is really the name
of the value, and the type tells clients how the value object should be
interpreted. A GROUP and a DOCUMENT, for example, both have values that are
numbers (Long primary keys). The type can be compared to one of the constants
in this class to determine the proper semantics of the value. A lot of
utility methods are included in this class to help validate types and manage
the relationships among typed variables.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final boolean
Deprecated.Fields inherited from class com.appiancorp.suiteapi.type.NamedTypedValue
QNAME
Fields inherited from class com.appiancorp.suiteapi.type.TypedValue
ALWAYS, AT_DESIGNER_DISCRETION, clearPasswordOnTransport, NEVER, TO_STRING_STYLE
Fields inherited from interface com.appiancorp.suiteapi.type.AppianType
ADMINISTERED_PROPERTY, ALIAS, APPLICATION, ARRAY, ATTACHMENT, BEAN, BIG_RATIONAL, BINARY, BOOLEAN, CHART_COLOR, COMMUNITY, CONNECTED_SYSTEM, CONTENT_COMMUNITY, CONTENT_CONSTANT, CONTENT_CUSTOM, CONTENT_DOCUMENT, CONTENT_FOLDER, CONTENT_FREEFORM_RULE, CONTENT_ITEM, CONTENT_KNOWLEDGE_CENTER, CONTENT_RULE, CURRENCY, DATA_SOURCE, DATA_STORE, DATA_STORE_ENTITY, DATATYPE, DATE, DECISION, DECISION_TABLE, DECRYPTED_TEXT, DEFERRED, DICTIONARY, DISCUSSION_THREAD, DOCUMENT, DOCUMENT_OR_FOLDER, DOUBLE, EMAIL_ADDRESS, EMAIL_RECIPIENT, EMBEDDED_SAIL_THEME_ID, ENCRYPTED_TEXT, EVENT, EXPRESSION, EXTERNAL_REFERENCE, EXTERNAL_REFERENCE_WITH_INDICES, EXTERNAL_SYSTEM_ID, FIXED, FOLDER, FORUM, GROUP, GROUP_TYPE, ID_REFERENCE, INITIAL_CUSTOM_TYPE, INTEGER, INTEGER_KEY, INTERFACE, INTERVAL_D_S, KNOWLEDGE_CENTER, LINKS_CHANNEL_FOLDER, LIST, LIST_OF_ADMINISTERED_PROPERTY, LIST_OF_APPLICATION, LIST_OF_ATTACHMENT, LIST_OF_BEAN, LIST_OF_BIG_RATIONAL, LIST_OF_BINARY, LIST_OF_BOOLEAN, LIST_OF_CHART_COLOR, LIST_OF_COMMUNITY, LIST_OF_CONNECTED_SYSTEM, LIST_OF_CONTENT_COMMUNITY, LIST_OF_CONTENT_CONSTANT, LIST_OF_CONTENT_CUSTOM, LIST_OF_CONTENT_DOCUMENT, LIST_OF_CONTENT_FOLDER, LIST_OF_CONTENT_FREEFORM_RULE, LIST_OF_CONTENT_ITEM, LIST_OF_CONTENT_KNOWLEDGE_CENTER, LIST_OF_CONTENT_RULE, LIST_OF_CURRENCY, LIST_OF_DATA_SOURCE, LIST_OF_DATA_STORE, LIST_OF_DATA_STORE_ENTITY, LIST_OF_DATATYPE, LIST_OF_DATE, LIST_OF_DECISION, LIST_OF_DECISION_TABLE, LIST_OF_DECRYPTED_TEXT, LIST_OF_DEFERRED, LIST_OF_DICTIONARY, LIST_OF_DISCUSSION_THREAD, LIST_OF_DOCUMENT, LIST_OF_DOCUMENT_OR_FOLDER, LIST_OF_DOUBLE, LIST_OF_EMAIL_ADDRESS, LIST_OF_EMAIL_RECIPIENT, LIST_OF_EMBEDDED_SAIL_THEME_ID, LIST_OF_ENCRYPTED_TEXT, LIST_OF_EVENT, LIST_OF_EXPRESSION, LIST_OF_EXTERNAL_REFERENCE, LIST_OF_EXTERNAL_REFERENCE_WITH_INDICES, LIST_OF_EXTERNAL_SYSTEM_ID, LIST_OF_FIXED, LIST_OF_FOLDER, LIST_OF_FORUM, LIST_OF_GROUP, LIST_OF_GROUP_TYPE, LIST_OF_ID_REFERENCE, LIST_OF_INTEGER, LIST_OF_INTEGER_KEY, LIST_OF_INTERFACE, LIST_OF_INTERVAL_D_S, LIST_OF_KNOWLEDGE_CENTER, LIST_OF_LINKS_CHANNEL_FOLDER, LIST_OF_MAP, LIST_OF_MESSAGE, LIST_OF_NOTE, LIST_OF_NULL, LIST_OF_OUTBOUND_INTEGRATION, LIST_OF_PAGE, LIST_OF_PASSWORD, LIST_OF_PORTLET, LIST_OF_PROCESS, LIST_OF_PROCESS_ERROR, LIST_OF_PROCESS_MODEL, LIST_OF_PROCESS_MODEL_FOLDER, LIST_OF_QUERY_RULE, LIST_OF_QUICK_APP, LIST_OF_RANGE, LIST_OF_RECORD, LIST_OF_RECORD_REFERENCE, LIST_OF_RECORD_TYPE_ID, LIST_OF_RICH_TEXT, LIST_OF_RULE_FOLDER, LIST_OF_SAFE_URI, LIST_OF_SITE, LIST_OF_STRING, LIST_OF_STRING_KEY, LIST_OF_TASK, LIST_OF_TASK_REPORT, LIST_OF_TEMPO_FEED, LIST_OF_TEMPO_REPORT, LIST_OF_TIME, LIST_OF_TIMESTAMP, LIST_OF_TYPE, LIST_OF_UNIFORM_FOLDER, LIST_OF_UNION, LIST_OF_USER_OR_GROUP, LIST_OF_USERNAME, LIST_OF_VARIANT, LIST_OF_WEB_API, MAP, MESSAGE, NOTE, NULL, OUTBOUND_INTEGRATION, PAGE, PASSWORD, PORTLET, PROCESS, PROCESS_ERROR, PROCESS_MODEL, PROCESS_MODEL_FOLDER, QUERY_RULE, QUICK_APP, RANGE, RECORD, RECORD_REFERENCE, RECORD_TYPE_ID, RICH_TEXT, RULE_FOLDER, SAFE_URI, SITE, STRING, STRING_KEY, TASK, TASK_REPORT, TEMPO_FEED, TEMPO_REPORT, TIME, TIMESTAMP, TYPE, UI_CONTAINER, UNIFORM_FOLDER, UNION, USER_OR_GROUP, USERNAME, VARIANT, WEB_API
Fields inherited from interface com.appiancorp.type.HasTypeRef
selectTypeId
Fields inherited from interface com.appiancorp.suiteapi.common.JSONable
hiddenAttributes$TRANSIENT
Fields inherited from interface com.appiancorp.type.NamedType
selectName
Fields inherited from interface com.appiancorp.suiteapi.process.TypedVariableTypes
CONSTANT, CONTENT, CUSTOM_CONTENT_ITEM, DATETIME, DURATION, FREEFORM_RULE, LONG, PEOPLE, PROCESSMODEL_FOLDER, RULE, TEMPLATE, USER
Fields inherited from interface com.appiancorp.suiteapi.common.XMLable
DEFAULT_BUFFER_SIZE
-
Constructor Summary
ConstructorDescriptionDeprecated.Creates an instance.Deprecated.Creates an instance and sets the instance type and value to the instance type and value of the provided NamedTypedValue.Deprecated.Creates an instance and sets the instance type and value to the instance type and value of the provided TypedValue. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Deprecated.Appends the full name of this variable to the given buffer.protected static void
appendLocalObject
(StringBuffer sb_, LocalObject local_) Deprecated.protected static void
appendLocalObject
(StringBuilder sb_, LocalObject local_) Deprecated.protected static void
appendLocalObjects
(StringBuffer sb_, LocalObject[] locals_) Deprecated.protected static void
appendLocalObjects
(StringBuilder sb_, LocalObject[] locals_) Deprecated.children()
Deprecated.If the type of the variable is BEAN, returns an array of ACPs (Activity Class Parameters) that are the fields of the bean.Deprecated.computeDisplayString
(AppianTypeCache cache_) Deprecated.This is the same as#computeDisplayString()
, except that the passed cache is used to get the display value (so that for an Appian Type, a user-friendly string is returned; for exmple, "Technology" instead of a number for a GROUP).Deprecated.Computes the string representation of the value of this typed variable, which should be shown to the user.computeValueStringForUiOutput
(ServiceContext sc_, boolean wrapInQuotes_, boolean escapeXml_) Deprecated.static int
convertFromLocalObjectType
(int localObjectType) Deprecated.Convert LocalObject type to Standard typestatic String
Deprecated.static String
externalize
(Object value_, Long type_, boolean multiple_) Deprecated.Convert the data passed in to the externalized (String) formatvoid
fillInAppianTypes
(AppianTypeCache cache_) Deprecated.If this typed variable is an Appian Type, adds its primary key to the cache.static TypedVariable[]
findAllWithKeyPrefix
(TypedVariable[] variables_, String name_) Deprecated.Finds all the variables in the given array whose name sarts with the passedname_
string.static TypedVariable
findByName
(TypedVariable[] variables_, String name_) Deprecated.Finds the variable in the given array whose name corresponds to the given name.int
Deprecated.Gets the type classification of this typed variable.int
Deprecated.Gets the underlying datatype of this typed variable.static Object
getDefaultPvValue
(Long type_, boolean multiple_) Deprecated.Returns the default value for aProcessVariable
of the given type.static Object
getDefaultValue
(Long type_, boolean multiple_) Deprecated.Returns the default value for the given type.int[]
Deprecated.If the underlying representation of this typed variable is an array, returns the types of the objects contained in the array.Deprecated.Returns the set of attributes (properties) that should not be included in the JSON representation of the object.static Class
getInstanceClass
(Long type_) Deprecated.getKey()
Deprecated.int
Deprecated.To determine if a type is multiple or not, retrieve itsDatatype
orDatatypeProperties
bean viaTypeService
and useDatatypeProperties.isListType()
.static Object
getNumericTypedObjectFromUiInput
(String value_, Long nType_, ServiceContext sc_) Deprecated.static int
getObjectTypeMappingFromType
(int tvType_) Deprecated.static Object
getScalarTypedObject
(String val_, Long nType_, Long detailedType_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3static Object
getScalarTypedObject
(String val_, Long nType_, Long detailedType_, ServiceContext sc_) Deprecated.Converts the givenString
to an object of the given type.getType()
Deprecated.static Object
getTypedObjectFromUiInput
(String value_, Long nType_, Long detailedType_, ServiceContext sc_) Deprecated.static Object[]
getTypedObjects
(String[] values_, Long nType_, int[] detailedTypes_, ServiceContext sc_) Deprecated.Converts the givenString
s to objects of the given type.static Object[]
getTypedObjectsFromUiInput
(String[] values_, Long nType_, int[] detailedTypes_, ServiceContext sc_) Deprecated.static TypedVariable[]
getTypedVariables
(NamedTypedValue[] ntvs) Deprecated.static Long
getTypeForClass
(Class class_) Deprecated.Returns theTypedVariable
type for a given class.static int
getTypeFromObjectTypeMappingType
(int otmType_) Deprecated.Returns theTypedVariable
type corresponding to a givenObjectTypeMapping
type.static Class
getUnderlyingClass
(Long type_, boolean multiple_) Deprecated.seeTypeClassResolver#getTypeClass(Long)
protected final String
Deprecated.protected String
Deprecated.protected final String
Deprecated.protected static String
handleTimestampValue
(Date value_, int type_, ServiceContext sc_) Deprecated.protected static String
handleTimestampValueForUiOutput
(Date value_, int type_, ServiceContext sc_) Deprecated.protected static Long
integerToLong
(Integer i_) Deprecated.static TypedVariable
internalize
(String externalized) Deprecated.Interalizes the externalized String passed instatic boolean
isAppianType
(int tvType_) Deprecated.Determines whether the given type is an Appian Type (an Appian Type is any type that has a corresponding TYPE_XXX constant defined inObjectTypeMapping
).boolean
Deprecated.Determines whether the type of this variable could support multiple values.static boolean
isNotDeferred
(int type_) Deprecated.Determines whether the given type is not a deferred type.static boolean
isValidType
(int type_) Deprecated.use TypeServicevoid
putOrAppendTimestamp
(Timestamp ts_, ServiceContext sc_) Deprecated.Do not use this, as it is meant ONLY for web services.void
putOrAppendValue
(String newValAsString_, ServiceContext sc_) Deprecated.Do not use this, as it is meant ONLY for web services.static String
renderArrayAsCsv
(Object[] values_, boolean wrapInQuotes_, boolean escapeXml_, int type_, ServiceContext sc_) Deprecated.Transforms the given array into a single sting containing a comma-separated list of the array values.static String
renderArrayAsCsv
(Object[] values_, boolean wrapInQuotes_, boolean escapeXml_, int type_, ServiceContext sc_, int multiple) Deprecated.static String
renderArrayAsCsv
(Object[] values_, boolean wrapInQuotes_, int type_, ServiceContext sc_) static String
renderArrayAsCsv
(Object[] values_, boolean wrapInQuotes_, int type_, ServiceContext sc_, int multiple) Deprecated.static String
renderArrayAsCsvForUiOutput
(Object[] values_, boolean wrapInQuotes_, boolean escapeXml_, int type_, ServiceContext sc_) Deprecated.static String
renderArrayAsString
(Object[] values_, boolean wrapInQuotes_, boolean escapeXml_, int type_, ServiceContext sc_, String delim_, int multiple) Deprecated.void
setDetailedTypes
(int[] detailedTypes_) Deprecated.SeegetDetailedTypes()
.final void
setInstanceType
(Long instanceType) Deprecated.Sets the instance type of the typed value.void
Deprecated.useNamedTypedValue#setName()
void
setMultiple
(int multiple) Deprecated.Set theinstance type
instead.void
Deprecated.useTypedValue#setInstanceType()
void
setTypeMultiple
(Long type, int multiple) Deprecated.UsesetInstanceType(Long)
instead.void
Deprecated.Sets the value of the typed variable.Deprecated.Converts an array ofString
s in to a singleString
containing a comma-separated list of the passed strings.toXML()
Deprecated.Converts a typed variable to XML.void
toXML
(StringBuilder buffer_) Deprecated.Appends the XML representation of this typed variable to the given buffer.Methods inherited from class com.appiancorp.suiteapi.type.NamedTypedValue
equals, findNtvByName, findNtvIndexByName, getName, getNtvNames, hashCode, setName, toString
Methods inherited from class com.appiancorp.suiteapi.type.TypedValue
clearPasswordOnTransport, clone, getInstanceType, getInstanceTypeIds, getTypeRef, getValue, setTypeRef
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.appiancorp.suiteapi.common.DeepCloneable
clone
Methods inherited from interface com.appiancorp.type.HasTypeRef
getTypeRef, setTypeRef
Methods inherited from interface com.appiancorp.core.expr.portable.PortableNamedTypedValue
getName
Methods inherited from interface com.appiancorp.core.expr.portable.PortableNamedTypedValueWithChildren
setName
Methods inherited from interface com.appiancorp.core.expr.portable.PortableTypedValue
getInstanceType, getValue
-
Field Details
-
classType$TRANSIENT
public static final boolean classType$TRANSIENTDeprecated.- See Also:
-
dataType$TRANSIENT
public static final boolean dataType$TRANSIENTDeprecated.- See Also:
-
detailedTypes$TRANSIENT
public static final boolean detailedTypes$TRANSIENTDeprecated.- See Also:
-
multipleSupportingType$TRANSIENT
public static final boolean multipleSupportingType$TRANSIENTDeprecated.- See Also:
-
displayName$TRANSIENT
public static final boolean displayName$TRANSIENTDeprecated.- See Also:
-
MAX_TYPE
public static final int MAX_TYPEDeprecated.- See Also:
-
LOCAL_USER
public static final int LOCAL_USERDeprecated. -
LOCAL_GROUP
public static final int LOCAL_GROUPDeprecated. -
LOCAL_DOCUMENT
public static final int LOCAL_DOCUMENTDeprecated. -
LOCAL_FOLDER
public static final int LOCAL_FOLDERDeprecated. -
LOCAL_PORTLET
public static final int LOCAL_PORTLETDeprecated. -
LOCAL_PAGE
public static final int LOCAL_PAGEDeprecated. -
LOCAL_FORUM
public static final int LOCAL_FORUMDeprecated. -
LOCAL_TOPIC
public static final int LOCAL_TOPICDeprecated. -
LOCAL_MESSAGE
public static final int LOCAL_MESSAGEDeprecated. -
LOCAL_KC
public static final int LOCAL_KCDeprecated. -
LOCAL_COMMUNITY
public static final int LOCAL_COMMUNITYDeprecated. -
LOCAL_PM
public static final int LOCAL_PMDeprecated. -
LOCAL_PROCESS
public static final int LOCAL_PROCESSDeprecated. -
LOCAL_TASK
public static final int LOCAL_TASKDeprecated. -
LOCAL_NODE
public static final int LOCAL_NODEDeprecated. -
LOCAL_EMAIL_ADDRESS
public static final int LOCAL_EMAIL_ADDRESSDeprecated.
-
-
Constructor Details
-
TypedVariable
public TypedVariable()Deprecated.Creates an instance. -
TypedVariable
Deprecated.Creates an instance and sets the instance type and value to the instance type and value of the provided NamedTypedValue.- Parameters:
ntv
- a NamedTypedValue containing the instance type and value to set for the newly created TypedVariable
-
TypedVariable
Deprecated.Creates an instance and sets the instance type and value to the instance type and value of the provided TypedValue.- Parameters:
tv
- a TypedValue containing the instance type and value to set for the newly created TypedVariable
-
-
Method Details
-
getTypedVariables
Deprecated. -
getHiddenAttributes
Deprecated.Description copied from interface:JSONable
Returns the set of attributes (properties) that should not be included in the JSON representation of the object.- Specified by:
getHiddenAttributes
in interfaceJSONable
- Overrides:
getHiddenAttributes
in classTypedValue
- Returns:
- the set of hidden attributes
-
getKey
Deprecated.Returns the name of the typed variable. Identical toNamedTypedValue.getName()
- originally, a typed variable was a key/value binding, hence the name is called "key". -
setKey
Deprecated.useNamedTypedValue#setName()
SeegetKey()
. -
getDetailedTypes
public int[] getDetailedTypes()Deprecated.If the underlying representation of this typed variable is an array, returns the types of the objects contained in the array. For example, if the type of theTypedVariable
is PEOPLE and the value contains 2 groups and 3 users, this method will return an array of size 5, where the first two elements are GROUP and the next 3 are USER.- Returns:
- An array of types (type constants defined by this class).
-
convertFromLocalObjectType
public static int convertFromLocalObjectType(int localObjectType) Deprecated.Convert LocalObject type to Standard type- Parameters:
localObjectType
- TheObjectTypeMapping
type from the LocalObject- Returns:
- The corresponding AppianType
-
setValue
Deprecated.Description copied from class:TypedValue
Sets the value of the typed variable.- Overrides:
setValue
in classTypedValue
- Parameters:
value
- The value to set the typed variable to.
-
setDetailedTypes
public void setDetailedTypes(int[] detailedTypes_) Deprecated.SeegetDetailedTypes()
. -
isAppianType
public static boolean isAppianType(int tvType_) Deprecated.Determines whether the given type is an Appian Type (an Appian Type is any type that has a corresponding TYPE_XXX constant defined inObjectTypeMapping
).- Parameters:
tvType_
- The type to check.- Returns:
true
if the passed type is an Appian Type, andfalse
otherwise
-
isValidType
Deprecated.use TypeServiceDetermines whether the given type is a valid type.- Parameters:
type_
- The type to check.- Returns:
true
if the passed type is a valid type, andfalse
otherwise
-
isNotDeferred
public static boolean isNotDeferred(int type_) Deprecated.Determines whether the given type is not a deferred type. A deffered type is a variable whose type cannot be determined until design time (determining the type is deffered until design time, such as for the type of the answer in a Multiple Questions process model node).- Parameters:
type_
- The type to check.- Returns:
true
if type is NOT deferred, andfalse
otherwise
-
toXML
Deprecated.Converts a typed variable to XML. -
getXMLWrapperName
Deprecated. -
getXMLWrapperStart
Deprecated.- Returns:
- The xml wrapper start of a typed variable.
-
getXMLWrapperEnd
Deprecated.- Returns:
- The xml wrapper end of a typed variable.
-
toXML
Deprecated.Appends the XML representation of this typed variable to the given buffer. -
toString
Deprecated.Converts an array ofString
s in to a singleString
containing a comma-separated list of the passed strings. -
getScalarTypedObject
public static Object getScalarTypedObject(String val_, Long nType_, Long detailedType_, ServiceContext sc_) Deprecated.Converts the givenString
to an object of the given type.- Parameters:
val_
- The string representation of a value.nType_
- A constant representing the type to whichval_
should be converted. This type MUST be a scalar, ie notXXX_ARRAY
.detailedType_
- The type of the sub-object, which is only useful if the underlying class is aLocalObject
(ie forPEOPLE
andCONTENT
types). Otherwise, the parameter is ignored and can be set tonull
.- Returns:
- The object of the passed type and containing the passed value.
- Throws:
IllegalArgumentException
- ifnType_
is invalid, not scalar, or DEFERRED or BEAN
-
getScalarTypedObject
@Deprecated public static Object getScalarTypedObject(String val_, Long nType_, Long detailedType_, com.appiancorp.asl3.servicefw.connect.ServiceContext sc_) Deprecated.since 6.0.3Converts the givenString
to an object of the given type.- Parameters:
val_
- The string representation of a value.nType_
- A constant representing the type to whichval_
should be converted. This type MUST be a scalar, ie notXXX_ARRAY
.detailedType_
- The type of the sub-object, which is only useful if the underlying class is aLocalObject
(ie forPEOPLE
andCONTENT
types). Otherwise, the parameter is ignored and can be set tonull
.- Returns:
- The object of the passed type and containing the passed value.
- Throws:
IllegalArgumentException
- ifnType_
is invalid, not scalar, or DEFERRED or BEAN
-
getTypedObjects
public static Object[] getTypedObjects(String[] values_, Long nType_, int[] detailedTypes_, ServiceContext sc_) Deprecated.Converts the givenString
s to objects of the given type.- Parameters:
values_
- The strings representing the values.nType_
- A constant representing the type to which each of the passed values should be converted. This type MUST be a scalar, i.e. notXXX_ARRAY
.detailedTypes_
- The types of the sub-objects, which are only useful if the underlying class is aLocalObject
(i.e. forPEOPLE
andCONTENT
types). Otherwise, the parameter is ignorred and can be set tonull
.- Returns:
- The objects of the passed type and containing the passed values.
- Throws:
IllegalArgumentException
- ifnType_
is invalid, not scalar, or DEFERRED or BEAN
-
getTypedObjectsFromUiInput
public static Object[] getTypedObjectsFromUiInput(String[] values_, Long nType_, int[] detailedTypes_, ServiceContext sc_) Deprecated. -
getTypedObjectFromUiInput
public static Object getTypedObjectFromUiInput(String value_, Long nType_, Long detailedType_, ServiceContext sc_) Deprecated. -
getNumericTypedObjectFromUiInput
public static Object getNumericTypedObjectFromUiInput(String value_, Long nType_, ServiceContext sc_) Deprecated. -
putOrAppendValue
Deprecated.Do not use this, as it is meant ONLY for web services. -
putOrAppendTimestamp
Deprecated.Do not use this, as it is meant ONLY for web services. -
appendFullName
Deprecated.Appends the full name of this variable to the given buffer. The full name is the full name of the parent, if one exists, followed by a "." and the name of this variable.- Parameters:
sb_
- The buffer to append the name to.
-
findByName
Deprecated.Finds the variable in the given array whose name corresponds to the given name. If no such variable can be found, returnsnull
.- Parameters:
variables_
- The collection of variables to search.name_
- The name to look for.- Returns:
- The variable in the collection whose name is a case-insensitive
match for
name_
. If multiple values that meet this criterion exist (which they should not), the first match is returned. If no such value exists, or either parameter isnull
,null
is returned.
-
findAllWithKeyPrefix
Deprecated.Finds all the variables in the given array whose name sarts with the passedname_
string. If no such variable(s) can be found or if either of the passed arguments isnull
, returnsnull
.- Parameters:
variables_
- The collection of variables to search.name_
- The name search string.- Returns:
- The variable(s) in the collection whose name starts with
name_
(case-insensitive). If no such variable is found, or if either argument isnull
,null
is returned.
-
children
Deprecated.If the type of the variable is BEAN, returns an array of ACPs (Activity Class Parameters) that are the fields of the bean. If the type of the variable is BEAN_ARRAY, returns an array of the ACPs that are the cells in the array. Otherwise, returnsnull
. Note that this is not agetXXX
method, so as not to be confused with a property.- Specified by:
children
in interfacecom.appiancorp.core.expr.portable.PortableNamedTypedValueWithChildren
- Returns:
- The typed variables representing the ACPs.
-
integerToLong
Deprecated. -
getUnderlyingClass
Deprecated.seeTypeClassResolver#getTypeClass(Long)
Determines the class that best represents the type of>value
. For most types, this isLong.class
, but for USER and STRING it isString.class
, for DATE isjava.sql.Date.class
, for TIME isjava.sql.Time.class
, for DATETIME isjava.sql.Timestamp.class
, and for arrays it is the array type that corresponds to an array of the scalar type, such asLong[].class
.- Parameters:
type_
- The type to check, which is one of the type constants defined by this class.multiple_
- Whether to get the class for the array version of the type.- Returns:
- The underlying class for the given type.
-
getTypeForClass
Deprecated.Returns theTypedVariable
type for a given class.- Parameters:
class_
- A class.- Returns:
- The
TypedVariable
type corresponding to the passed class, which is aLong
version of one of the type constants defined by this class. If the passed class is unknown, returnsDEFERRED
.
-
getDefaultValue
Deprecated.Returns the default value for the given type. The back end does not allownull
values, so clients should set value to this instead. For type STRING, the default is empty string, for LONGs it is 0, and for arrays, it is a 0-length array. For timestamps, the default is the current time. There is no default value for DEFERRED, BEAN and BEAN_ARRAY, so this method returnsnull
(which will cause an exception if you try to store it).- Parameters:
type_
- A type, which is one of the type constants defined by this class.- Returns:
- The default value for the passed type.
-
getDefaultPvValue
Deprecated.Returns the default value for aProcessVariable
of the given type. For most types this isnull
, unlessmultiple_
istrue
, in which case the value is a 0-length array. For type LONG, the default value is 0, for DOUBLE it is 0.0, and for STRING it is "". There is no default value for DEFERRED, BEAN and BEAN_ARRAY, so this method returnsnull
(which will cause an exception if you try to store it).- Parameters:
type_
- A type, which is one of the type constants defined by this class.multiple_
- Whether or not the variable is an array.- Returns:
- The default value for the passed type.
-
fillInAppianTypes
Deprecated.If this typed variable is an Appian Type, adds its primary key to the cache.- Specified by:
fillInAppianTypes
in interfaceAppianTypeHolder
- Parameters:
cache_
- The cache to add to.
-
computeValueString
Deprecated.Computes the string representation of the value of this typed variable, which should be shown to the user. For most types, this is just the number. For arrays, it is a CSV (comma-separated values string), and for time types it is a nicely formatted date or time. If the type is aString[]
, the CSV for the array does not quote the strings in the array; for example, an array of users whose usernames are payton.manning and brett.favre would result in the string "payton.manning,brett.favre" which can be fed to a picker as a value.- Returns:
- The string representation of the value of the typed variable.
-
computeValueStringForUiOutput
public String computeValueStringForUiOutput(ServiceContext sc_, boolean wrapInQuotes_, boolean escapeXml_) Deprecated. -
computeDisplayString
Deprecated.Use eithercomputeValueString(ServiceContext)
, orcomputeValueStringForUiOutput(ServiceContext, boolean, boolean)
. This is the same as#computeValueString()
except that if the type is aString[]
, the CSV for the array does have quotes around the individual strings in the array; for example, an array of users whose usernames are payton.manning and brett.favre would result in the string ""payton.manning","brett.favre"".- Returns:
- The string representation of the value of the typed variable.
-
computeDisplayString
Deprecated.This is the same as#computeDisplayString()
, except that the passed cache is used to get the display value (so that for an Appian Type, a user-friendly string is returned; for exmple, "Technology" instead of a number for a GROUP).- Parameters:
cache_
- The cache to use to look up the typed variable value.- Returns:
- The display value of the typed variable, as it is stored in the
passed cache, or
null
if this typed variable is not an Appian Type.
-
handleTimestampValue
Deprecated. -
handleTimestampValueForUiOutput
Deprecated. -
renderArrayAsCsv
@Deprecated public static String renderArrayAsCsv(Object[] values_, boolean wrapInQuotes_, int type_, ServiceContext sc_) Deprecated.Use eitherrenderArrayAsCsv(Object[], boolean, boolean, int, ServiceContext)
orrenderArrayAsCsv(Object[], boolean, boolean, int, ServiceContext, char)
. Transforms the given aray into a single string containing a comma-separated list of the array values.- Parameters:
values_
- The array of values to convert to a CSV string.isString_
- Whether the objects areString
s, in which case they will be surrounded by quotes. The quotes that are used are XML-escaped (ie they are ").type_
- the type of the things being rendered, as one of the type contants such as DATE or LONG. Currently, the type is only used to determine the format with which to render timestamp values.
-
renderArrayAsCsv
public static String renderArrayAsCsv(Object[] values_, boolean wrapInQuotes_, int type_, ServiceContext sc_, int multiple) Deprecated. -
renderArrayAsCsv
public static String renderArrayAsCsv(Object[] values_, boolean wrapInQuotes_, boolean escapeXml_, int type_, ServiceContext sc_) Deprecated.Transforms the given array into a single sting containing a comma-separated list of the array values.- Parameters:
values_
- The array of values to convert to a CSV string.wrapInQuotes_
- Whether or not the objects areString
s, in which case they will be surrounded by quotes.escapeXml_
- Whether to escape the quotes (which are only used ifisString_
istrue
). Iffalse
, the " symbol will be used to surround the strings, otherwise " is used.type_
- the type of the things being rendered, as one of the type contants such as DATE or LONG. Currently, the type is only used to determine the format with which to render timestamp values.
-
renderArrayAsCsv
public static String renderArrayAsCsv(Object[] values_, boolean wrapInQuotes_, boolean escapeXml_, int type_, ServiceContext sc_, int multiple) Deprecated. -
renderArrayAsString
public static String renderArrayAsString(Object[] values_, boolean wrapInQuotes_, boolean escapeXml_, int type_, ServiceContext sc_, String delim_, int multiple) Deprecated. -
renderArrayAsCsvForUiOutput
public static String renderArrayAsCsvForUiOutput(Object[] values_, boolean wrapInQuotes_, boolean escapeXml_, int type_, ServiceContext sc_) Deprecated. -
getClassType
public int getClassType()Deprecated.Gets the type classification of this typed variable.- Returns:
- One of the
TypeDescriptor.CLASS_XXX
constants, orCLASS_NONE
if the type is not recognized.
-
getDataType
public int getDataType()Deprecated.Gets the underlying datatype of this typed variable.- Returns:
- One of the
TypeDescriptor.DATATYPE_XXX
constants, orDATATYPE_UNKNOWN
if the type is not recognized.
-
isMultipleSupportingType
public boolean isMultipleSupportingType()Deprecated.Determines whether the type of this variable could support multiple values. Note that if the answer is yes (true
), this does NOT mean that this instance supports multiple values. If the type is not recognized, this method returnstrue
by default. -
appendLocalObject
Deprecated. -
appendLocalObject
Deprecated. -
appendLocalObjects
Deprecated. -
appendLocalObjects
Deprecated. -
getTypeFromObjectTypeMappingType
public static int getTypeFromObjectTypeMappingType(int otmType_) Deprecated.Returns theTypedVariable
type corresponding to a givenObjectTypeMapping
type.- Parameters:
otmType_
- TheObjectTypeMapping
type, defined by one of theTYPE_XXX
in theObjectTypeMapping
class.- Returns:
- A
TypedVariable
type which is one of the type constants defined by this class.
-
getObjectTypeMappingFromType
public static int getObjectTypeMappingFromType(int tvType_) Deprecated. -
externalize
Deprecated.Convert the data passed in to the externalized (String) format- Parameters:
value_
- the value to converttype_
- theTypedVariable
type to convert tomultiple_
- whether the type can hold multiple values- Returns:
- the externalized String
-
externalize
Deprecated. -
internalize
Deprecated.Interalizes the externalized String passed in- Parameters:
externalized
- the externalized String- Returns:
- a
TypedVariable
representation of the data encoded into the externalized String
-
getInstanceClass
Deprecated. -
getMultiple
Deprecated.To determine if a type is multiple or not, retrieve itsDatatype
orDatatypeProperties
bean viaTypeService
and useDatatypeProperties.isListType()
.Determines whether this instance supports multiple values. The value should be NEVER or ALWAYS.- Returns:
- One of NEVER or ALWAYS.
-
setMultiple
Deprecated.Set theinstance type
instead. The instance type contains the multiple information within it.This sets instanceType as necessary. SeegetMultiple()
. -
getType
Deprecated.Return the type of the typed variable, which is one of the constants defined by this class. -
setType
Deprecated.useTypedValue#setInstanceType()
This sets instanceType as necessary. SeegetType()
. -
setTypeMultiple
Deprecated.UsesetInstanceType(Long)
instead. -
setInstanceType
Deprecated.Sets the instance type of the typed value. This is used in preference to type and multiple; it will set type and multiple as necessary for backward compatibility.- Overrides:
setInstanceType
in classTypedValue
- Parameters:
instanceType
- The instance type id, which corresponds to aDatatype
. Built-in datatype ids are defined inAppianType
-
NamedTypedValue
instead.