Retrieves ClassDescription objects from the repository or repositories specified
for this instance.
Namespace:
FileNet.Api.QueryAssembly: FileNet.Api (in FileNet.Api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Function FetchSearchableClassDescriptions ( _ classNames As String(), _ filter As PropertyFilter _ ) As IClassDescriptionSet |
C# |
---|
public IClassDescriptionSet FetchSearchableClassDescriptions( string[] classNames, PropertyFilter filter ) |
Visual C++ |
---|
public: IClassDescriptionSet^ FetchSearchableClassDescriptions( array<String^>^ classNames, PropertyFilter^ filter ) |
JavaScript |
---|
function fetchSearchableClassDescriptions(classNames, filter); |
Parameters
- classNames
- Type: array<
System..::.String
>[]()[]
A String array of the names of the classes to retrieve. The class names can be the symbolic name, the display name, or the object ID for the class (in String format).
- filter
- Type: FileNet.Api.Property..::.PropertyFilter
A PropertyFilter object that represents information for controlling which property values (and with what level of detail and recursion) to return. If null, this method returns values for all non-object properties and returns placeholders for all object-valued properties (PropertyEngineObject properties with a state of PropertyState.UNEVALUATED or PropertyState.REFERENCE); any subsequent attempts to access an object-valued property will cause an automatic round-trip to the server to fetch its value.
Return Value
A ClassDescriptionSet collection object containing ClassDescription objects for the metadata retrieved.If the SearchScope instance references multiple repositories, properties that are not applicable to multiple repositories will not be present in the ClassDescription objects returned, nor in the PropertyDescription objects contained in these ClassDescription objects.
For the ClassDescription objects returned, these properties are:
- SuperclassDescription
- SuperclassPropertyCount
- ImmediateSubclassDescriptions
- NamePropertyIndex
- AllowsInstances
- PermissionDescriptions
- DefaultInstancePermissions
For the PropertyDescription objects contained in the ClassDescription objects, these properties are:
- IsSystemGenerated
- IsReadOnly
- IsHidden
- PropertyDefaultObject
- PropertySelectionsObject
- RequiredClass
- ReflectivePropertyId