Object Class Archive (XAM) (FSCXAMARCHIVE@1.1001:ArchiveXAM)

Object Class Hierarchy

COOSYSTEM@1.1:Object > COOSYSTEM@1.1:AdministrationObject > COOSYSTEM@1.1:ArchiveStore > FSCXAMARCHIVE@1.1001:ArchiveXAM

Additional Information

Default Background Menu: COODESK@1.1:MenuRootWinContext
Compound: false
Action for Moving Objects: COODESK@1.1:DragIntoMove
Abstract: false
ACL Object: COOSYSTEM@1.1:DefaultAdministratorACL
Symbol: COODESK@1.1:SymbolArchive
Base Class: COOSYSTEM@1.1:ArchiveStore
Action for Linking Objects: COODESK@1.1:DragIntoLink
Default Main Menu: COODESK@1.1:MenuRootFolder
Action for Copying Objects: COODESK@1.1:DragIntoCopy
Display Mode: DISP_LINES

Properties

ReferenceName
FSCXAMARCHIVE@1.1001:authfileAuthentication File
FSCXAMARCHIVE@1.1001:vendoridVendor Identification

Actions

ReferenceName
COOSYSTEM@1.1:ArchObject
COOSYSTEM@1.1:DeleteArchObject
COOSYSTEM@1.1:GetArchObject
COOSYSTEM@1.1:GetArchStoreName
COOSYSTEM@1.1:GetArchSystemName
COOSYSTEM@1.1:SetArchObjectRetentionDate

Properties

FSCXAMARCHIVE@1.1001:authfile (Authentication File)

Additional Information

Type: COOSYSTEM@1.1:CONTENT
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

FSCXAMARCHIVE@1.1001:vendorid (Vendor Identification)

Additional Information

Initialization Value: 1
Type: FSCXAMARCHIVE@1.1001:VendorIdentificationModule
Changeable: true
Visible: true
Must Be Defined: false
ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL
Changeable in Installed Component: true


[top]

Actions

COOSYSTEM@1.1:ArchObject

This action is called by the kernel for storing objects in an archive store. Multiple objects can be stored at once (see COOSYSTEM@1.1:AttrObjArchive).
ParameterTypeIn/OutOptionalDescription
archidCOOSYSTEM@1.1:STRINGoutfalse Archive Document ID
objCOOSYSTEM@1.1:OBJECTinfalse Root Object
versnrCOOSYSTEM@1.1:INTEGERinfalse Version Number
contentsCOOSYSTEM@1.1:ArchContentinfalse Contents
propertiesCOOSYSTEM@1.1:ArchPropertyinfalse Properties (see COOSYSTEM@1.1:archstattrconfig)
retentionperiodCOOSYSTEM@1.1:STRINGintrue Retention Period (Years)
retentiondateCOOSYSTEM@1.1:STRINGintrue Retention Date (ISO-Format: YYYY-MM-ddTHH:mm:ss)

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:DeleteArchObject

This action is called by the kernel to delete an object from its archive store.
ParameterTypeIn/OutOptionalDescription
archidCOOSYSTEM@1.1:STRINGinfalse Archive Document ID
objCOOSYSTEM@1.1:OBJECTintrue Object
versnrCOOSYSTEM@1.1:INTEGERintrue Version Number

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:GetArchObject

This action is called by the kernel to load the contents of an archived object from its archive store. A special content contains the object properties in XML format.
ParameterTypeIn/OutOptionalDescription
archidCOOSYSTEM@1.1:STRINGinfalse Archive Document ID
objCOOSYSTEM@1.1:OBJECTintrue Object
versnrCOOSYSTEM@1.1:INTEGERintrue Version Number
contentsCOOSYSTEM@1.1:ArchContentoutfalse Archived Contents

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:GetArchStoreName

Get archive store name.
ParameterTypeIn/OutOptionalDescription
nameCOOSYSTEM@1.1:STRINGoutfalse Name of COOSYSTEM@1.1:ArchiveStore

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:GetArchSystemName

Get archive system name.
ParameterTypeIn/OutOptionalDescription
nameCOOSYSTEM@1.1:STRINGoutfalse Name of COOSYSTEM@1.1:ArchiveStore class

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]

COOSYSTEM@1.1:SetArchObjectRetentionDate

This action is called by the kernel to set the retention date of an archived object in its archive store.
ParameterTypeIn/OutOptionalDescription
archidCOOSYSTEM@1.1:STRINGin/outfalse Archive Document ID
objCOOSYSTEM@1.1:OBJECTintrue Archived Object
retentiondateCOOSYSTEM@1.1:STRINGinfalse Retention Date (ISO-Format: YYYY-MM-ddTHH:mm:ss)

Additional Information

ACL Object: COOSYSTEM@1.1:DefaultDeveloperACL


[top]