A
object is a dependently persistable object; it has no
method and therefore cannot be independently saved. Because any given
object is dependent on the independently persistable
object to which it belongs, its state is not saved until you call the
method of the
object that owns it. For a given
object to belong to a
object, it must be added to the
collection that is returned by the
object's
property.
The type of data that a
object can represent is determined by the
constant value that you specify with its
property. This property determines whether a
object represents an integer-type choice item, a string-type choice item, a group node for a nested collection of integer-type choice items, or a group node for a nested collection of string-type choice items.
Localization is provided by the
property, using the same mechanism that
and
objects use. However, unlike those objects, the
object does not have a
property. To localize a
object, set its
property to a
object containing a collection of
objects. Each object in this collection represents a locale-specific, user-readable display name that can be used for a
object; set its
property to a locale ID and its
property to the localized text for the display name. Once you have set the
property, the server will automatically set the value of the
property to the
property value of the
object in the
collection that corresponds to the object store's default locale.
A
object's display name, or label, identifies it and is stored by its
property. You can either set the
property directly or you can set it indirectly by setting the
property. Setting the
property is the preferred method. You must set either a
object's
property or its
property; you cannot set both. If you set the
property, the server will automatically create a
object with its
property set to the object store's default locale and add it as a single item in the
property's
collection. If you set the
property directly, localization will be bypassed and the language of its text may not match the specified locale. For example, if you store English text (en-us) in the
property and the default locale is French (fr-fr), the
property will return a collection containing a single
object that specifies a French locale with English text. Note that this behavior is unique to
objects.
A
object's display name, which is always a string value, should not be confused with its value, which can be a string, an integer, or a collection of
objects (when a
object acts as a group node). A
object's display name is assigned with the
property, while its value is assigned using the appropriate property, depending on its type:
for integer-type choice items,
for string-type choice items, or
for group nodes. Although the server does not check the display names and values of the choice items within a given choice list for uniqueness, it is recommended that they be unique to avoid ambiguity.
To create a
object, call the
method. In order to save the state of a new
object (when you save the
object to which it belongs), you must, at a minimum, set its
and
properties. The
property can be either set directly, by setting it to a
object; or set indirectly, by setting the
property. To create a list collection of
objects (
object), call the
method.
Namespace: FileNet.Api.Admin
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Interface IChoice Implements IRepositoryObject, IEngineObject, ICloneable, IDependentObject |
C# |
---|
public interface IChoice : IRepositoryObject, IEngineObject, ICloneable, IDependentObject |
C++ |
---|
interface class IChoice : IRepositoryObject, IEngineObject, ICloneable, IDependentObject |
J# |
---|
public interface IChoice implements IRepositoryObject, IEngineObject, ICloneable, IDependentObject |
JScript |
---|
public interface IChoice extends IRepositoryObject, IEngineObject, ICloneable, IDependentObject |
Remarks
Metadata
Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: true
IsHidden: false
Searchable: false
StorageType: ObjectStore
SuperclassName: GenericObject