com.stellent.cis.client.api.scs.schema
Interface ISCSSchemaFieldDefinition

All Superinterfaces:
ICISObject, ICISObjectInitializable, ISCSDocMetaDefinition, ISCSObject, java.io.Serializable

public interface ISCSSchemaFieldDefinition
extends ISCSDocMetaDefinition

Represents a schema field configuration


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable
ICISObjectInitializable.AdapterVersionAware
 
Field Summary
 
Fields inherited from interface com.stellent.cis.client.api.common.ICISObject
FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM
 
Method Summary
 java.lang.String getDependentField()
           
 java.lang.String getDependentRelationship()
           
 java.lang.String getFieldName()
           
 java.lang.String getOptionViewKey()
           
 java.lang.String getSchemaFieldName()
           
 long getSchemaLastLoaded()
           
 boolean isDependentList()
           
 boolean isDocumentMetaField()
           
 boolean isMetaData()
           
 boolean isUseOptionList()
           
 boolean isUseTreeControl()
           
 boolean isUseViewList()
           
 
Methods inherited from interface com.stellent.cis.client.api.scs.document.information.ISCSDocMetaDefinition
getCaption, getDefaultValue, getName, getOptionListKey, getOptionListType, getOrder, getType, isEnabled, isOptionList, isRequired, isSearchable, setCaption, setDefaultValue, setEnabled, setOptionList, setOptionListKey, setOptionListType, setOrder, setRequired, setSearchable, setType
 
Methods inherited from interface com.stellent.cis.client.api.scs.ISCSObject
castObject, clearPropertyFilter, copyObject, getPropertyFilter, getSourceAdapter, getSourceObject, getSourceObjectPropertyType, mergeObject, mergeObject, removeProperty, setPropertyFilter, setRestrictedPropertyFilter, setSourceObjectPropertyType
 
Methods inherited from interface com.stellent.cis.client.api.common.ICISObject
getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty
 
Methods inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable
intialize
 

Method Detail

getSchemaFieldName

java.lang.String getSchemaFieldName()
Returns:
the name of the schema field

getFieldName

java.lang.String getFieldName()
Returns:
friendly name of the field

isUseViewList

boolean isUseViewList()
Returns:
true if this field uses a view for the list

isUseTreeControl

boolean isUseTreeControl()
Returns:
true if this field uses the tree control

isUseOptionList

boolean isUseOptionList()
Returns:
true if the 'UseOptionList' property is set

isDocumentMetaField

boolean isDocumentMetaField()
Returns:
true if this field is a document meta data field

isMetaData

boolean isMetaData()
Returns:
true if the metadata flag is set

isDependentList

boolean isDependentList()
Returns:
true if the field definition is a dependent list

getOptionViewKey

java.lang.String getOptionViewKey()
Returns:
the name of the view that draws this list
See Also:
isUseViewList()

getDependentField

java.lang.String getDependentField()
Returns:
name of the field this field is dependent on
See Also:
isDependentList()

getDependentRelationship

java.lang.String getDependentRelationship()
Returns:
the name of the dependent relationship
See Also:
isDependentList()

getSchemaLastLoaded

long getSchemaLastLoaded()
Returns:
the time the schema was last loaded