com.filenet.api.admin
Interface PropertyTemplate
-
- All Superinterfaces:
- EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable
- All Known Subinterfaces:
- PropertyTemplateBinary, PropertyTemplateBoolean, PropertyTemplateDateTime, PropertyTemplateFloat64, PropertyTemplateId, PropertyTemplateInteger32, PropertyTemplateObject, PropertyTemplateString
public interface PropertyTemplate extends RepositoryObject, Replicable, Subscribable, IndependentlyPersistableObject
Represents the base class for all property template classes. A property template is a global template that enables you to create one or more property definitions for a given data type with the same set of property values.Many of the metaproperties that originate from a property template can be modified on the property definition of the class, while other metaproperties can be modified only on the property template. For a list of modifiable metaproperties and how they can be customized, see Modifying Custom Metaproperties.
Metadata
-
-
Method Summary
Methods Modifier and Type Method and Description PropertyDefinition
createClassProperty()
Creates and returns a new property definition object based on this property template.IdList
get_AliasIds()
Returns the value of the AliasIds property.PropertyTemplate
get_AuditAs()
Returns the value of the AuditAs property.EventSet
get_AuditedEvents()
Returns the value of the AuditedEvents property.Cardinality
get_Cardinality()
Returns the value of the Cardinality property.ChoiceList
get_ChoiceList()
Returns the value of the ChoiceList property.java.lang.String
get_Creator()
Returns the value of the Creator property.TypeID
get_DataType()
Returns the value of the DataType property.java.util.Date
get_DateCreated()
Returns the value of the DateCreated property.java.util.Date
get_DateLastModified()
Returns the value of the DateLastModified property.java.lang.String
get_DescriptiveText()
Returns the value of the DescriptiveText property.LocalizedStringList
get_DescriptiveTexts()
Returns the value of the DescriptiveTexts property.java.lang.String
get_DisplayName()
Returns the value of the DisplayName property.LocalizedStringList
get_DisplayNames()
Returns the value of the DisplayNames property.Id
get_Id()
Returns the value of the Id property.AddOn
get_InstalledByAddOn()
Returns the value of the InstalledByAddOn 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_IsValueRequired()
Returns the value of the IsValueRequired property.java.lang.String
get_LastModifier()
Returns the value of the LastModifier 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.java.lang.String
get_Owner()
Returns the value of the Owner property.AccessPermissionList
get_Permissions()
Returns the value of the Permissions property.PropertyPersistence
get_PersistenceType()
Returns the value of the PersistenceType property.java.lang.String
get_PropertyDisplayCategory()
Returns the value of the PropertyDisplayCategory 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.ClassDefinitionSet
get_UsedInClasses()
Returns the value of the UsedInClasses property.void
set_AliasIds(IdList value)
Sets the value of the AliasIds property.void
set_AuditAs(PropertyTemplate value)
Sets the value of the AuditAs property.void
set_Cardinality(Cardinality value)
Sets the value of the Cardinality property.void
set_ChoiceList(ChoiceList value)
Sets the value of the ChoiceList property.void
set_Creator(java.lang.String value)
Sets the value of the Creator property.void
set_DateCreated(java.util.Date value)
Sets the value of the DateCreated property.void
set_DateLastModified(java.util.Date value)
Sets the value of the DateLastModified property.void
set_DescriptiveTexts(LocalizedStringList value)
Sets the value of the DescriptiveTexts property.void
set_DisplayNames(LocalizedStringList value)
Sets the value of the DisplayNames 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_LastModifier(java.lang.String value)
Sets the value of the LastModifier property.void
set_ModificationAccessRequired(java.lang.Integer value)
Sets the value of the ModificationAccessRequired property.void
set_Owner(java.lang.String value)
Sets the value of the Owner property.void
set_Permissions(AccessPermissionList value)
Sets the value of the Permissions property.void
set_PersistenceType(PropertyPersistence value)
Sets the value of the PersistenceType property.void
set_PropertyDisplayCategory(java.lang.String value)
Sets the value of the PropertyDisplayCategory property.void
set_RequiresUniqueElements(java.lang.Boolean value)
Sets the value of the RequiresUniqueElements property.void
set_Settability(PropertySettability value)
Sets the value of the Settability property.void
set_SymbolicName(java.lang.String value)
Sets the value of the SymbolicName property.-
Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore
-
Methods inherited from interface com.filenet.api.replication.Replicable
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup
-
Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent
-
Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
-
Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
-
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
-
-
-
-
Method Detail
-
get_Creator
java.lang.String get_Creator()
Returns the value of the Creator property. For more information, see Creator Property.
-
set_Creator
void set_Creator(java.lang.String value)
Sets the value of the Creator property. For more information, see Creator Property.
-
get_DateCreated
java.util.Date get_DateCreated()
Returns the value of the DateCreated property. For more information, see DateCreated Property.
-
set_DateCreated
void set_DateCreated(java.util.Date value)
Sets the value of the DateCreated property. For more information, see DateCreated Property.
-
get_LastModifier
java.lang.String get_LastModifier()
Returns the value of the LastModifier property. For more information, see LastModifier Property.
-
set_LastModifier
void set_LastModifier(java.lang.String value)
Sets the value of the LastModifier property. For more information, see LastModifier Property.
-
get_DateLastModified
java.util.Date get_DateLastModified()
Returns the value of the DateLastModified property. For more information, see DateLastModified Property.
-
set_DateLastModified
void set_DateLastModified(java.util.Date value)
Sets the value of the DateLastModified property. For more information, see DateLastModified 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_AuditedEvents
EventSet get_AuditedEvents()
Returns the value of the AuditedEvents property. For more information, see AuditedEvents Property.
-
get_Owner
java.lang.String get_Owner()
Returns the value of the Owner property. For more information, see Owner Property.
-
set_Owner
void set_Owner(java.lang.String value)
Sets the value of the Owner property. For more information, see Owner Property.
-
get_Permissions
AccessPermissionList get_Permissions()
Returns the value of the Permissions property. For more information, see Permissions Property.
-
set_Permissions
void set_Permissions(AccessPermissionList value)
Sets the value of the Permissions property. For more information, see Permissions Property.
-
get_DisplayNames
LocalizedStringList get_DisplayNames()
Returns the value of the DisplayNames property. For more information, see DisplayNames Property.
-
set_DisplayNames
void set_DisplayNames(LocalizedStringList value)
Sets the value of the DisplayNames property. For more information, see DisplayNames Property.
-
get_DescriptiveTexts
LocalizedStringList get_DescriptiveTexts()
Returns the value of the DescriptiveTexts property. For more information, see DescriptiveTexts Property.
-
set_DescriptiveTexts
void set_DescriptiveTexts(LocalizedStringList value)
Sets the value of the DescriptiveTexts property. For more information, see DescriptiveTexts 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.
-
set_Cardinality
void set_Cardinality(Cardinality value)
Sets 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.
-
set_PersistenceType
void set_PersistenceType(PropertyPersistence value)
Sets 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.
-
set_RequiresUniqueElements
void set_RequiresUniqueElements(java.lang.Boolean value)
Sets 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_SymbolicName
java.lang.String get_SymbolicName()
Returns the value of the SymbolicName property. For more information, see SymbolicName Property.
-
set_SymbolicName
void set_SymbolicName(java.lang.String value)
Sets the value of the SymbolicName property. For more information, see SymbolicName Property.
-
get_UsedInClasses
ClassDefinitionSet get_UsedInClasses()
Returns the value of the UsedInClasses property. For more information, see UsedInClasses Property.
-
get_PropertyDisplayCategory
java.lang.String get_PropertyDisplayCategory()
Returns the value of the PropertyDisplayCategory property. For more information, see PropertyDisplayCategory Property.
-
set_PropertyDisplayCategory
void set_PropertyDisplayCategory(java.lang.String value)
Sets the value of the PropertyDisplayCategory property. For more information, see PropertyDisplayCategory 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_InstalledByAddOn
AddOn get_InstalledByAddOn()
Returns the value of the InstalledByAddOn property. For more information, see InstalledByAddOn Property.
-
get_AuditAs
PropertyTemplate get_AuditAs()
Returns the value of the AuditAs property. For more information, see AuditAs Property.
-
set_AuditAs
void set_AuditAs(PropertyTemplate value)
Sets the value of the AuditAs property. For more information, see AuditAs Property.
-
createClassProperty
PropertyDefinition createClassProperty()
Creates and returns a new property definition object based on this property template. To create a new user-defined property on a particular class, add this property definition object to the class definition'sPropertyDefinitions
collection.- Returns:
- An object instance of a
PropertyDefinition
subclass (PropertyDefinitionBinary
, for example).
-
-