dmaClass_System

A DMA system is a collection of Document Spaces.

Class ID: dmaClass_System
Superclass: DMA

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	System
Create Pending	-	Yes	Yes	Yes	Boolean	Scalar
Update Pending	-	Yes	Yes	Yes	Boolean	Scalar
Delete Pending	-	Yes	Yes	Yes	Boolean	Scalar
Character Set Encoding	Yes	-	-	Yes	Integer32	Scalar
Locale Name	Yes	Yes	Yes	Yes	String	Scalar
System OIID Prefix	Yes	Yes	Yes	Yes	String	Scalar
Locale Names	Yes	Yes	Yes	Yes	String	List
Display Name	Yes	-	-	Yes	String	Scalar
Descriptive Text	Yes	-	-	-	String	Scalar
System Id	Yes	Yes	Yes	Yes	ID	Scalar

Detailed Description

A DMA system may be comprised of a single Document Space or multiple Document Spaces, and may be supplied/implemented by different vendors.

Object valued properties cannot be accessed if the System object is in an unauthenticated state. (Lists that have non object-valued elements are not considered object-valued properties for this purpose, even though a DMA object interface is employed for delivery of those values.) Attempts to access an object valued property in an unauthenticated state will yield a DMARC_NOT_AUTHENTICATED return code.

A DMA system object is a source of system-specific, system-level services as well. These services are available via interfaces, such as IdmaScopeFactory and IdmaObjectFactory, which may be optionally available. Any locale-dependent interfaces that are provided for system-level services always honor the System object dmaProp_Locale property value established when the particular DMA System object is instantiated.

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

• Character Set Encoding {dmaProp_CharacterSetEncoding}

Indicates the Character Set that this system uses.

• Locale Name {dmaProp_LocaleName}

Indicates the name of the Locale this object is currently operating in.

• System OIID Prefix {dmaProp_SystemOIIDPrefix}

The system prefix part to be used when constructing an OIID.

• Locale Names {dmaProp_LocaleNames}

The list of locales this object supports.

• Display Name {dmaProp_DisplayName}

A string containing a user-intelligible name for the class/property/... being described.

• Descriptive Text {dmaProp_DescriptiveText}

Text documenting this object.

• System Id {dmaProp_SystemId}

The persistent Id that identifies this System.