com.filenet.api.admin
Interface PropertyDefinition

All Superinterfaces:
DependentObject, EngineObject, RepositoryObject, java.io.Serializable
All Known Subinterfaces:
PropertyDefinitionBinary, PropertyDefinitionBoolean, PropertyDefinitionDateTime, PropertyDefinitionFloat64, PropertyDefinitionId, PropertyDefinitionInteger32, PropertyDefinitionObject, PropertyDefinitionString

public interface PropertyDefinition
extends RepositoryObject, EngineObject, DependentObject

Represents the base class for all property definition classes. A property definition is created from a property template and holds mutable property metadata. Each property definition class corresponds to a specific property data type (for example, PropertyDefinitionBinary defines a property that returns a binary value, PropertyDefinitionBoolean defines a property that returns a Boolean value, and so on). When a property definition is added to a class definition's PropertyDefinitions collection, a user-defined property is added to that class.

Metadata

Auditable: false
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: true
IsHidden: false
Searchable: false
StorageType: ObjectStore
SuperclassName: GenericObject


Method Summary
 IdList get_AliasIds()
          Returns the value of the AliasIds property.
 Cardinality get_Cardinality()
          Returns the value of the Cardinality property.
 ChoiceList get_ChoiceList()
          Returns the value of the ChoiceList property.
 Id get_ColumnId()
          Returns the value of the ColumnId property.
 java.lang.Boolean get_CopyToReservation()
          Returns the value of the CopyToReservation property.
 TypeID get_DataType()
          Returns the value of the DataType property.
 java.lang.String get_DescriptiveText()
          Returns the value of the DescriptiveText property.
 java.lang.String get_DisplayName()
          Returns the value of the DisplayName property.
 ExternalPropertyAliasList get_ExternalAliases()
          Returns the value of the ExternalAliases 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_IsNameProperty()
          Returns the value of the IsNameProperty 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.Integer get_ModificationAccessRequired()
          Returns the value of the ModificationAccessRequired property.
 java.lang.String get_Name()
          Returns the value of the Name property.
 PropertyPersistence get_PersistenceType()
          Returns the value of the PersistenceType property.
 Id get_PrimaryId()
          Returns the value of the PrimaryId property.
 PropertyTemplate get_PropertyTemplate()
          Returns the value of the PropertyTemplate 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.
 TableDefinition get_TableDefinition()
          Returns the value of the TableDefinition property.
 void set_AliasIds(IdList value)
          Sets the value of the AliasIds property.
 void set_ChoiceList(ChoiceList value)
          Sets the value of the ChoiceList property.
 void set_CopyToReservation(java.lang.Boolean value)
          Sets the value of the CopyToReservation property.
 void set_ExternalAliases(ExternalPropertyAliasList value)
          Sets the value of the ExternalAliases property.
 void set_IsHidden(java.lang.Boolean value)
          Sets the value of the IsHidden property.
 void set_IsNameProperty(java.lang.Boolean value)
          Sets the value of the IsNameProperty property.
 void set_IsValueRequired(java.lang.Boolean value)
          Sets the value of the IsValueRequired property.
 void set_ModificationAccessRequired(java.lang.Integer value)
          Sets the value of the ModificationAccessRequired property.
 void set_Settability(PropertySettability value)
          Sets the value of the Settability property.
 
Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore
 
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
 

Method Detail

get_PrimaryId

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


get_IsSystemOwned

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


get_PropertyTemplate

PropertyTemplate get_PropertyTemplate()
Returns the value of the PropertyTemplate property. For more information, see PropertyTemplate Property.


get_AliasIds

IdList get_AliasIds()
Returns the value of the AliasIds property. For more information, see AliasIds Property.


set_AliasIds

void set_AliasIds(IdList value)
Sets the value of the AliasIds property. For more information, see AliasIds Property.


get_DisplayName

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


get_DescriptiveText

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


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_Settability

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


set_Settability

void set_Settability(PropertySettability value)
Sets the value of the Settability property. For more information, see Settability Property.


get_IsValueRequired

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


set_IsValueRequired

void set_IsValueRequired(java.lang.Boolean value)
Sets 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.


set_IsHidden

void set_IsHidden(java.lang.Boolean value)
Sets the value of the IsHidden property. For more information, see IsHidden Property.


get_PersistenceType

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


get_IsNameProperty

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


set_IsNameProperty

void set_IsNameProperty(java.lang.Boolean value)
Sets the value of the IsNameProperty property. For more information, see IsNameProperty Property.


get_RequiresUniqueElements

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


get_ChoiceList

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


set_ChoiceList

void set_ChoiceList(ChoiceList value)
Sets the value of the ChoiceList property. For more information, see ChoiceList Property.


get_TableDefinition

TableDefinition get_TableDefinition()
Returns the value of the TableDefinition property. For more information, see TableDefinition Property.


get_ColumnId

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


get_SymbolicName

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


get_CopyToReservation

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


set_CopyToReservation

void set_CopyToReservation(java.lang.Boolean value)
Sets the value of the CopyToReservation property. For more information, see CopyToReservation 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_ModificationAccessRequired

java.lang.Integer get_ModificationAccessRequired()
Returns the value of the ModificationAccessRequired property. For more information, see ModificationAccessRequired Property.


set_ModificationAccessRequired

void set_ModificationAccessRequired(java.lang.Integer value)
Sets the value of the ModificationAccessRequired property. For more information, see ModificationAccessRequired Property.


get_ExternalAliases

ExternalPropertyAliasList get_ExternalAliases()
Returns the value of the ExternalAliases property. For more information, see ExternalAliases Property.


set_ExternalAliases

void set_ExternalAliases(ExternalPropertyAliasList value)
Sets the value of the ExternalAliases property. For more information, see ExternalAliases Property.



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