dmaClass_DocSpace

A Doc Space is a collection of documents and policies.

Class ID: dmaClass_DocSpace
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	Doc Space
Create Pending	-	Yes	Yes	Yes	Boolean	Scalar
Update Pending	-	Yes	Yes	Yes	Boolean	Scalar
Delete Pending	-	Yes	Yes	Yes	Boolean	Scalar
Display Name	Yes	-	-	Yes	String	Scalar
Descriptive Text	Yes	-	-	-	String	Scalar
Class Descriptions	Yes	-	-	Yes	Object	List	Class Description
Locale Name	Yes	-	-	Yes	String	Scalar
Locale Names	Yes	Yes	Yes	Yes	String	List
Doc Space Id	Yes	Yes	Yes	Yes	ID	Scalar
Initial Containers	-	Yes	Yes	-	Object	Enum	Container
Doc Space Capabilities	Yes	Yes	Yes	Yes	Integer32	List

Detailed Description

A Doc Space is the source of metadata for all objects except Systems and Document Spaces themselves. Each Document Space publishes the supported objects and how the objects are accessed. There may be class and property definitions that are not meaningful to other Document Spaces.

Object valued properties cannot be accessed if the DocSpace object is in an unauthenticated state. Attempts to access an object valued property in an unauthenticated state will yield a DMARC_NOT_AUTHENTICATED return code.

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

• 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.

• Class Descriptions {dmaProp_ClassDescriptions}

A list of all class descriptions supported by this document space.

• Locale Name {dmaProp_LocaleName}

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

• Locale Names {dmaProp_LocaleNames}

The list of locales this object supports.

• Doc Space Id {dmaProp_DocSpaceId}

The persistent Id that identifies this Document Space.

• Initial Containers {dmaProp_InitialContainers}

An enumeration of folder objects which represent starting points for folder navigation

• Doc Space Capabilities {dmaProp_DocSpaceCapabilities}

List of capabilities for the Doc Space.

Capabilities that a Doc Space supports or provides are listed in this property. An application can discover if a Doc Space provides a feature by checking this property. This allows the application to optimize presentation options to the user without the expense of trying certain operations to see whether they are supported.