dmaClass_ContentTransfer

A content element that represents content that is, or will be, directly captured and managed by the document space.

Class ID: dmaClass_ContentTransfer
Superclass: Content Element

Interfaces

Properties

Name	Impl. Required	System Gen'ed	Read-Only	Value Required	Type	Cardinality	Required Class
OIID	-	Yes	Yes	-	String	Scalar
Class Description	Yes	Yes	Yes	Yes	Object	Scalar	Class Description
This	-	Yes	Yes	Yes	Object	Scalar	Content Transfer
Create Pending	-	Yes	Yes	Yes	Boolean	Scalar
Update Pending	-	Yes	Yes	Yes	Boolean	Scalar
Delete Pending	-	Yes	Yes	Yes	Boolean	Scalar
Component Type	Yes	-	-	Yes	String	Scalar
Retrieval Name	Yes	-	-	-	String	Scalar

Property Descriptions

• OIID {dmaProp_OIID}
Property Inherited from DMA

• Class Description {dmaProp_ClassDescription}
Property Inherited from DMA

• This {dmaProp_This}
Property Inherited from DMA

• Create Pending {dmaProp_CreatePending}
Property Inherited from DMA

• Update Pending {dmaProp_UpdatePending}
Property Inherited from DMA

• Delete Pending {dmaProp_DeletePending}
Property Inherited from DMA

• Component Type {dmaProp_ComponentType}
Property Inherited from Content Element

• Retrieval Name {dmaProp_RetrievalName}

Suggested name suffix for the resource into which the document content should be retrieved for editing.

If a value is present in this property, then it specifies the suggested name suffix for the resource into which the document content should be retrieved for editing, with the purpose of allowing inference by extension (for example) as a means of determining the appropriate editing application.

When delivering new content, the client application should set this property to the resource name from which the content was copied, if such a name exists. A syntactically correct URL is required. The document space may save either this entire URL, or it may eliminate everything but the final component of the path (the portion of the string following the last path separator character; this will typically be of the form filename.ext). If the client does not supply a value for this property, and the content is delivered via the IdmaContentTransfer::SetCaptureResource method then the document space is at liberty to set a default value by parsing the capture resource name. If such defaulting does take place, then it should become visible only after ExecuteChange and Refresh have been applied to the parent DocVersion object. (SetCaptureResource is not permitted to side-effect the value of the Retrieval Name property on the scratchpad object).

During content retrieval the client application may use the value of this property, if present, to construct the name of a resource into which the content is copied. However, it is not obliged to do so.

Document spaces may allow the value of this property to be modified on content element objects which have already been made persistent, but this is not required.