Content Class Reference

An Archive Content is an object of source or target of Archive operations (cf. More...

Inheritance diagram for Content:

Collaboration diagram for Content:

Public Member Functions
_.Library.Status	AddSource (_.Library.RegisteredObject DataSource, _.Library.String TagName)
	Specify a data source to export to server.
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Attributes
	Attribute
	Optional attributes of the content, in pairs of AttributeName and AttributeValue. More...
	DataSink
	a list of targets (file path, Stream, etc.) for retrieving content from server More...
	DataSource
	for storing content to server More...
	Name
	An optional, descriptive name for the content. More...
	RetentionSpec
	Either a retention period, specified as a number (consisting of only digits) in seconds, or a retention class name. More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

An Archive Content is an object of source or target of Archive operations (cf.

<class>Archive.Session</class>)

Sample script that creates an Archive Content object for a (source) file or files to be archived:

Set ContentOref = ##class(Archive.Content).New() Set ContentOref.Name = "File" // description of the content Set ContentOref.RetentionSpec = 0 // a retention period or class name Set Status = ContentOref.AddSource(SourceFilePath1,"Test File 1") // path of the source file and a brief description ("tagname") // and if there are more files to store (as a single content) – Set Status = ContentOref.AddSource(SourceFilePath2,"Test File 2") // and so on

Sample script that creates an Archive Content object for a file or files as the target of a retrieval:

Set ContentOref = ##class(Archive.Content).New() Set Status = ContentOref.DataSink.Insert(TargetFilePath1) // and if the content contains more than one file – Set Status = ContentOref.DataSink.Insert(TargetFilePath2) // and so on

Member Data Documentation

Attribute

Attribute

Optional attributes of the content, in pairs of AttributeName and AttributeValue.

 

DataSink

DataSink

a list of targets (file path, Stream, etc.) for retrieving content from server

 

DataSource

DataSource

for storing content to server

• DataSource = DataSourceCount

• DataSource(DataSourceID,"TagName") = TagName
• DataSource(DataSourceID,"Source") = Output source (file path, Stream, etc.)

 

Name

Name

An optional, descriptive name for the content.

 

RetentionSpec

RetentionSpec

Either a retention period, specified as a number (consisting of only digits) in seconds, or a retention class name.