com.filenet.api.meta
Interface PropertyDescription

All Superinterfaces:
DependentObject, EngineObject, Metadata, java.io.Serializable
All Known Subinterfaces:
PropertyDescriptionBinary, PropertyDescriptionBoolean, PropertyDescriptionDateTime, PropertyDescriptionFloat64, PropertyDescriptionId, PropertyDescriptionInteger32, PropertyDescriptionObject, PropertyDescriptionString

public interface PropertyDescription
extends Metadata, EngineObject, DependentObject

Represents the base class for all property description classes. A property description object holds immutable metadata that describes a specific class property. Each property description class corresponds to a specific property data type (for example, PropertyDescriptionBinary defines a property that returns a binary value, PropertyDescriptionBoolean defines a property that returns a Boolean value, and so on). Because all of its properties are read-only, you cannot directly modify a property description object.

Metadata

Auditable: false
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: true
IsHidden: false
Searchable: false
StorageType: Domain or ObjectStore
SuperclassName: Metadata


Method Summary
 Cardinality get_Cardinality()
          Returns the value of the Cardinality property.
 ChoiceList get_ChoiceList()
          Returns the value of the ChoiceList property.
 TypeID get_DataType()
          Returns the value of the DataType property.
 Id get_Id()
          Returns the value of the Id property.
 java.lang.Boolean get_IsHidden()
          Returns the value of the IsHidden property.
 java.lang.Boolean get_IsOrderable()
          Returns the value of the IsOrderable property.
 java.lang.Boolean get_IsReadOnly()
          Returns the value of the IsReadOnly property.
 java.lang.Boolean get_IsSearchable()
          Returns the value of the IsSearchable property.
 java.lang.Boolean get_IsSelectable()
          Returns the value of the IsSelectable property.
 java.lang.Boolean get_IsSystemGenerated()
          Returns the value of the IsSystemGenerated property.
 java.lang.Boolean get_IsSystemOwned()
          Returns the value of the IsSystemOwned property.
 java.lang.Boolean get_IsValueRequired()
          Returns the value of the IsValueRequired property.
 java.lang.String get_Name()
          Returns the value of the Name property.
 PropertyPersistence get_PersistenceType()
          Returns the value of the PersistenceType property.
 PropertySettability get_PrivilegedSettability()
          Returns the value of the PrivilegedSettability property.
 java.lang.Boolean get_RequiresUniqueElements()
          Returns the value of the RequiresUniqueElements property.
 PropertySettability get_Settability()
          Returns the value of the Settability property.
 java.lang.String get_SymbolicName()
          Returns the value of the SymbolicName property.
 
Methods inherited from interface com.filenet.api.meta.Metadata
get_DescriptiveText, get_DisplayName, get_Ids
 
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
 

Method Detail

get_DataType

TypeID get_DataType()
Returns the value of the DataType property. For more information, see DataType Property.


get_Cardinality

Cardinality get_Cardinality()
Returns the value of the Cardinality property. For more information, see Cardinality Property.


get_IsSelectable

java.lang.Boolean get_IsSelectable()
Returns the value of the IsSelectable property. For more information, see IsSelectable Property.


get_IsSearchable

java.lang.Boolean get_IsSearchable()
Returns the value of the IsSearchable property. For more information, see IsSearchable Property.


get_IsOrderable

java.lang.Boolean get_IsOrderable()
Returns the value of the IsOrderable property. For more information, see IsOrderable Property.


get_IsSystemGenerated

java.lang.Boolean get_IsSystemGenerated()
Returns the value of the IsSystemGenerated property. For more information, see IsSystemGenerated Property.


get_IsReadOnly

java.lang.Boolean get_IsReadOnly()
Returns the value of the IsReadOnly property. For more information, see IsReadOnly Property.


get_IsValueRequired

java.lang.Boolean get_IsValueRequired()
Returns the value of the IsValueRequired property. For more information, see IsValueRequired Property.


get_IsHidden

java.lang.Boolean get_IsHidden()
Returns the value of the IsHidden property. For more information, see IsHidden Property.


get_SymbolicName

java.lang.String get_SymbolicName()
Returns the value of the SymbolicName property. For more information, see SymbolicName Property.


get_Id

Id get_Id()
Returns the value of the Id property. For more information, see Id Property.


get_Name

java.lang.String get_Name()
Returns the value of the Name property. For more information, see Name Property.


get_PersistenceType

PropertyPersistence get_PersistenceType()
Returns the value of the PersistenceType property. For more information, see PersistenceType Property.


get_IsSystemOwned

java.lang.Boolean get_IsSystemOwned()
Returns the value of the IsSystemOwned property. For more information, see IsSystemOwned Property.


get_Settability

PropertySettability get_Settability()
Returns the value of the Settability property. For more information, see Settability Property.


get_PrivilegedSettability

PropertySettability get_PrivilegedSettability()
Returns the value of the PrivilegedSettability property. For more information, see PrivilegedSettability Property.


get_ChoiceList

ChoiceList get_ChoiceList()
Returns the value of the ChoiceList property. For more information, see ChoiceList Property.


get_RequiresUniqueElements

java.lang.Boolean get_RequiresUniqueElements()
Returns the value of the RequiresUniqueElements property. For more information, see RequiresUniqueElements Property.



© Copyright IBM Corporation 2006, 2009. All rights reserved.