com.sssw.cm.api
Interface EbiDocPropDescriptor

All Superinterfaces:

Comparable

public interface EbiDocPropDescriptor

extends Comparable

Objects that implement this interface describe specific standard Document Metadata properties such as author, publish date, etc.

Each property is characterized by the following attributes:

• Property name, e.g. EboDocPropUtil.DOCTYPEID;
• Property display name, e.g. "Document type ID";
• Property index within the property list, e.g. EboDocPropUtil.IDX_DOCTYPEID;
• Property data type, e.g. EboDocQueryUtil.TYPE_NAME_STRING;
• A boolean specifying whether the Document property is mandatory or not; all Documents have values for mandatory properties; if values are not specified for those at Document creation time, then certain defaults are used by the system (see EbiAddDocumentParams for more details).

See Also:

EbiAddDocumentParams, EboDocPropUtil, EboDocQueryUtil

Method Summary

String	getPropDisplayName() Gets the display (user-friendly) property name
int	getPropIndex() Gets the index of the property
String	getPropName() Gets the name of the property
String	getPropType() Gets the type of the property
boolean	isMandatoryProperty() Tells whether the property is mandatory (i.e.

Methods implemented from interface java.lang.Comparable

compareTo

Method Detail

getPropName

public String getPropName()

Gets the name of the property

Returns:

the property name

getPropDisplayName

public String getPropDisplayName()

Gets the display (user-friendly) property name

Returns:

the display property name

getPropIndex

public int getPropIndex()

Gets the index of the property

Returns:

the property index

getPropType

public String getPropType()

Gets the type of the property

Returns:

the type of the property

isMandatoryProperty

public boolean isMandatoryProperty()

Tells whether the property is mandatory (i.e. must have a value)

Returns:

true if mandatory, false if value is optional