Class %FileMan.File

deprecatedpersistent class %FileMan.File extends %Persistent

This file stores the descriptive information for all files in the FileMan managed database.

Note: The FileMan toolset is available and fully supported in InterSystems IRIS for existing FileMan users. InterSystems recommends against starting new development projects using FileMan.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	6		3	1

Summary

Properties
DATE	FIELDS	GLOBALNAME	NAME	NUMBER
VERSION

Methods
%AddToSaveSet	%AddToSyncSet	%BuildDeferredIndices	%BuildIndicesAsync
%BuildIndicesAsyncResponse	%CheckConstraints	%CheckConstraintsForExtent	%ClassIsLatestVersion
%ClassName	%ComposeOid	%ConstructClone	%Delete
%DeleteExtent	%DeleteId	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%Exists	%ExistsId	%Extends
%GUID	%GUIDSet	%GetLock	%GetParameter
%GetSwizzleObject	%Id	%IsA	%IsModified
%IsNull	%KillExtent	%LockExtent	%LockId
%New	%NormalizeObject	%ObjectIsNull	%ObjectModified
%Oid	%OnBeforeAddToSync	%OnDeleteFinally	%OnDetermineClass
%OnOpenFinally	%OnSaveFinally	%Open	%OpenId
%OriginalNamespace	%PackageName	%PurgeIndices	%Reload
%RemoveFromSaveSet	%ResolveConcurrencyConflict	%RollBack	%Save
%SaveDirect	%SerializeObject	%SetModified	%SortBegin
%SortEnd	%SyncObjectIn	%SyncTransport	%UnlockExtent
%UnlockId	%ValidateIndices	%ValidateObject	%ValidateTable

Parameters

• parameter READONLY = 1;

READONLY = 1 means that objects can be created, opened but not saved or deleted. Tables are projected to SQL as READONLY.

Properties

• property DATE as %Library.FilemanDate [ SqlFieldName = DATE ];

FileMan Field Label: 'DATE' FileMan Field Number: '21'

• relationship FIELDS as %FileMan.Field [ Inverse = FILE,Cardinality = children ];

• property GLOBALNAME as %Library.String(COLLATION="EXACT",MAXLEN=255,TRUNCATE=0) [ SqlFieldName = GLOBAL_NAME,Transient ];

FileMan Field Label: 'GLOBAL NAME' FileMan Field Number: '1'

• property NAME as %Library.String(COLLATION="EXACT",MAXLEN=45,MINLEN=3,TRUNCATE=0) [ SqlFieldName = NAME ];

FileMan Field Label: 'NAME' FileMan Field Number: '.01'

• property NUMBER as %Library.String(COLLATION="EXACT",TRUNCATE=0);

FileMan Field Label: 'NUMBER' FileMan Field Number: '.001'

• property VERSION as %Library.String(COLLATION="EXACT",MAXLEN=255,TRUNCATE=0) [ SqlFieldName = VERSION,Transient ];

FileMan Field Label: 'VERSION' FileMan Field Number: '51'

Queries

• query AllFiles()

SQL Query :
SELECT NUMBER,NAME FROM %FileMan."File"
WHERE NAME IS NOT NULL
ORDER BY NUMBER

• query AllFilesByName()

SQL Query :
SELECT NUMBER,NAME FROM %FileMan."File"
WHERE NAME IS NOT NULL
ORDER BY NAME

• query ListFilesByName(file As %Library.String)

SQL Query :
SELECT NUMBER,NAME FROM %FileMan."File"
WHERE "NAME" %STARTSWITH :file
ORDER BY NAME

Indices

•index (IDKeyIndex on NUMBER) [IdKey,PrimaryKey,Unique];

Class Reference IRIS for UNIX 2024.1.2
Documentation Search