com.stellent.cis.client.api.scs.document.information
Interface ISCSDocMetaDefinition

All Superinterfaces:

ICISObject, ICISObjectInitializable, ISCSObject, java.io.Serializable

All Known Subinterfaces:

ISCSSchemaFieldDefinition

public interface ISCSDocMetaDefinition
extends ISCSObject

Definition of metadata in the Content Server

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	getCaption()
java.lang.String	getDefaultValue()
java.lang.String	getName()
java.lang.String	getOptionListKey()
java.lang.String	getOptionListType()
int	getOrder()
java.lang.String	getType()
boolean	isEnabled()
boolean	isOptionList()
boolean	isRequired()
boolean	isSearchable()
void	setCaption(java.lang.String caption)
void	setDefaultValue(java.lang.String defaultValue)
void	setEnabled(boolean enabled)
void	setOptionList(boolean isOptionList)
void	setOptionListKey(java.lang.String optionListKey)
void	setOptionListType(java.lang.String optionListType)
void	setOrder(int order)
void	setRequired(boolean required)
void	setSearchable(boolean searchable)
void	setType(java.lang.String type)

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

getCaption

java.lang.String getCaption()

Returns:

The description of this field.

setCaption

void setCaption(java.lang.String caption)

Parameters:

caption - the caption

getDefaultValue

java.lang.String getDefaultValue()

Returns:

The default value of this field.

setDefaultValue

void setDefaultValue(java.lang.String defaultValue)

Parameters:

defaultValue - the default value for the field

isEnabled

boolean isEnabled()

Returns:

Whether or not this field is currently enabled.

setEnabled

void setEnabled(boolean enabled)

Parameters:

enabled - true to enable the field

getName

java.lang.String getName()

Returns:

The name of this field.

isRequired

boolean isRequired()

Returns:

Whether or not this field is required.

setRequired

void setRequired(boolean required)

Parameters:

required - true to make the field required

isSearchable

boolean isSearchable()

Returns:

Whether or not this field is searchable.

setSearchable

void setSearchable(boolean searchable)

Parameters:

searchable - true to make the field searchable

isOptionList

boolean isOptionList()

Returns:

Whether or not an option list is associated with this field.

setOptionList

void setOptionList(boolean isOptionList)

Parameters:

isOptionList - true to set this as an optionlist field

getOptionListKey

java.lang.String getOptionListKey()

Returns:

The identifier for the option list if available.

setOptionListKey

void setOptionListKey(java.lang.String optionListKey)

Parameters:

optionListKey - the key for the option list

getOptionListType

java.lang.String getOptionListType()

Returns:

The type of option list for this field.

setOptionListType

void setOptionListType(java.lang.String optionListType)

Parameters:

optionListType - the option list type

getOrder

int getOrder()

Returns:

The order value for this field.

setOrder

void setOrder(int order)

Parameters:

order - the order of the field

getType

java.lang.String getType()

Returns:

The data type for this field.

setType

void setType(java.lang.String type)

Parameters:

type - the type of the field