com.stellent.cis.client.api.sis.process
Interface ISISTemplateField

All Superinterfaces:
ICISObject, ISISObject, java.io.Serializable

public interface ISISTemplateField
extends ISISObject

The interface represents individual field information for a single template which has been created and applied within Acorde Process Builder.


Field Summary
 
Fields inherited from interface com.stellent.cis.client.api.sis.ISISObject
OPERATOR_ADVSEARCH, OPERATOR_ALLVALUES, OPERATOR_AND, OPERATOR_BEGINSWITH, OPERATOR_CONTAINS, OPERATOR_ENDSWITH, OPERATOR_EQUAL, OPERATOR_EXACTPHRASE, OPERATOR_GREATERTHAN, OPERATOR_GREATERTHANEQUAL, OPERATOR_IN, OPERATOR_LESSTHAN, OPERATOR_LESSTHANEQUAL, OPERATOR_LIKE, OPERATOR_NOTBEGINSWITH, OPERATOR_NOTCONTAINS, OPERATOR_NOTENDSWITH, OPERATOR_NOTEQUAL, OPERATOR_NOTIN, OPERATOR_NOTLIKE, OPERATOR_OR, OPERATOR_SEARCH
 
Fields inherited from interface com.stellent.cis.client.api.common.ICISObject
FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM
 
Method Summary
 int getFieldID()
           
 java.lang.String getFieldName()
           
 int getLength()
           
 int getTemplateID()
           
 java.lang.String getTemplateName()
           
 int getType()
           
 boolean isIndexed()
           
 boolean isOptionList()
           
 boolean isReadOnly()
           
 boolean isSystemField()
           
 
Methods inherited from interface com.stellent.cis.client.api.sis.ISISObject
getErrorMessage, getObjectVersion, getSourceObject, getSourceObject, hasError
 
Methods inherited from interface com.stellent.cis.client.api.common.ICISObject
getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty
 

Method Detail

getTemplateID

int getTemplateID()
Returns:
Represents the numeric identifier of the template that defines the structure of the package.

getTemplateName

java.lang.String getTemplateName()
Returns:
Represents the name of the template that defines the structure of the package.

getFieldID

int getFieldID()
Returns:
Uniquely identifies a field within a given Package.

getFieldName

java.lang.String getFieldName()
Returns:
Provides the textual name of the field within a package.

isOptionList

boolean isOptionList()
Returns:
States if a list of expected field values has been associated with this field by Acorde Process Builder.

isIndexed

boolean isIndexed()
Returns:
States if this field's values have been indexed in the database. An indexed field speeds evaluations of Profiles.

isReadOnly

boolean isReadOnly()
Returns:
States if the field's data value is read only.

isSystemField

boolean isSystemField()
Returns:
States if the field is a system defined field or a user defined field.

getLength

int getLength()
Returns:
States the maximum number of characters that can be inserted in a string field.

getType

int getType()
Returns:
States the data type of the value stored by this field