VPMDocumentIterationFormat Class Definition

Parent Package

VPMDocumentIterationFormat Class Characteristics

name	VPMDocumentIterationFormat
type	Class
Role	The document format is used to hold file format type related information and aggregates one and only one document file object. The format object is aggregated by the document iteration object. More than one format can exist under one iteration, but only one format can be primary. Non-primary formats are called secondary formats and they must be distinguishable by either V_format_type or V505_SubMimeType.
uuid	80A2B3BD-0000-0509-384D1062000588ED
visibility	Public
Extensible	Yes
CAADerivable	Yes

VPMDocumentIterationFormat Attributes: 10

		V_docformatorder			The document format order number
		V_iteration			The link to the document belonging iteration
		V_control_code			A flag to specify whether a document is system controlled
		V_format_type			The document format type
		V_IsURL			A flag to specify whether the document is an URL document
		V505_IsPrimary			A flag to specify whether this format is primary
		V505_SubMimeType			A string to distinguish multi format types
		V508_PageCount			The number of pages of the physical file
		V509_IsSync			Not in use yet.
		V_IsRecomputed			Not in use yet

[Top]

Attributes Full Definition

V_control_code
	Role	Legal values are 1 system controlled document or 2 for non-vaulted or external document. This flag should not be modified after creation.
	Type	Integer
	Uuid	80A2B3BD-0000-0509-384D106200058D5D
	Visibility	Public
	Mandatory	Yes
	AccessMode	ReadWrite
	Multi Valuated	No
			[Top]
V_format_type
	Role	The document format type is determined by the extension of the file name. It should not be modified after creation.
	Type	String
	Uuid	80A2B3BD-0000-0509-384D106200059174
	Visibility	Public
	Mandatory	Yes
	Length	80
	AccessMode	ReadWrite
	Multi Valuated	No
			[Top]
V_IsURL
	Role	This flag should not be modified after creation.
	Type	Boolean
	Uuid	80A2B3BD-0000-0509-384D1062000595A9
	Visibility	Public
	Mandatory	Yes
	AccessMode	ReadWrite
	Multi Valuated	No
			[Top]
V_IsRecomputed
	Role	For updating secondary formats.
	Type	Boolean
	Uuid	90868ce6-be67-0000-0280030dcf000000
	Visibility	Public
	Mandatory	No
	AccessMode	ReadWrite
	Multi Valuated	No
			[Top]
V_docformatorder
	Role	The document format order number should not be modified.
	Type	Integer
	Uuid	80A2B3BD-0000-0509-384D1062000599D6
	Visibility	Public
	Mandatory	Yes
	AccessMode	ReadWrite
	Multi Valuated	No
			[Top]
V505_IsPrimary
	Role	This flag should only be modified through Set Primary command.
	Type	Boolean
	Uuid	94740711-0000-039f-020a100526000000
	Visibility	Public
	Mandatory	No
	AccessMode	ReadWrite
	Multi Valuated	No
			[Top]
V505_SubMimeType
	Role	The SubMimeType should be unique in the combination with V_format_type on formats under the same iteration. It should not be modified after creation.
	Type	String
	Uuid	9474091a-0000-24e8-020a100526000000
	Visibility	Public
	Mandatory	No
	Length	80
	AccessMode	ReadWrite
	Multi Valuated	No
			[Top]
V508_PageCount
	Role	The number of pages of the physical file is used for printing an index sheet of a multi-sheet document.
	Type	Integer
	Uuid	9b1dbbc1-0000-7519-020a100526000000
	Visibility	Public
	Mandatory	No
	AccessMode	ReadWrite
	Multi Valuated	No
			[Top]
V509_IsSync
	Role	For updating secondary formats.
	Type	Boolean
	Uuid	9f250c2f-0000-bb26-020a100567000000
	Visibility	Public
	Mandatory	No
	AccessMode	ReadWrite
	Multi Valuated	No
			[Top]
V_iteration
	Role	The link to the document belonging iteration should not be modified at any circumstances
	Type	Relationship
	Uuid	80A2B3BD-0000-0509-384D106200059DD5
	Visibility	Public
	Mandatory	Yes
	AccessMode	ReadWrite
	Multi Valuated	No
	Aggregation type	Shared
	Target objects	VPMDocumentIteration
			[Top]