Skip navigation  
Glossary  |  General Information  
   Content Services User Administration API
     Search in CS User Admin API Overview   |   API Classes   |   Enumeration Constants   |   Status Codes  
Level 1 Overview
Level 1 API Classes
Level 2 mezSession
Level 2 mezObject
Level 2     Methods
Level 2     Copy
Level 2     Delete
Level 2     GetActionListItem
Level 2     GetData
Level 2     GetPropertyByID
Level 2     GetPropertyByIndex
Level 2     RefreshData
Level 2     Rename
Level 2     SetDeleteFlag
Level 2     SetupNewObject
Level 2     Update
Level 2     Properties
Level 2     bAreRequiredPropertiesEntered
Level 2     bDeleteFlag
Level 2     bIsModifiable
Level 2     bIsModified
Level 2     eAccessLevel
Level 2     eObjectState
Level 2     hSctx
Level 2     iActionListCount
Level 2     iKeyCount
Level 2     iObjectNum
Level 2     iPropertyCount
Level 2     sKeyValue
Level 2     sListKey
Level 2     sObjectName
Level 2 mezProperty
Level 2 mezList
Level 2 mezUtility
Level 1 Enumeration Constants
Level 1 Status Codes
Level 1 General Information
   

mezObject Class

The mezObject class is used to represent a single object in a Content Services library. The class contains a collection of mezProperty objects, each of which represents a single property of the mezObject and can be retrieved using the GetPropertyByID() or GetPropertyByIndex() method. An action list is also included in the class and is used to identify the actions a specific user can perform on the mezObject, such as "Delete" or "Copy". The GetActionListItem() method can be used to retrieve an individual action.

A mezObject can be in one of several states, the most common of which are full and partial. Full mezObjects contain all of their properties. Partial mezObjects only contain some of their properties and these are the result of mezProperty child expansion via the mezProperty.Expand() method. Partial mezObjects can be converted to full by using the GetData() method.

The Update() method can be used to store changes to a mezObject to the server. The Update method performs a cascading update, in which any child object contained by a list mezProperty object (described later in this document) are updated along with the parent mezObject.

  Methods

Copy

returns a new mezObject, created by copying the current object

Delete

delete an existing object from a CS library

GetActionListItem

retrieves an individual action item for an object

GetData

convert an object from partial to full by populating all of the property values for the object

GetPropertyByID

retrieve a single mezProperty of the object using the property identifier

GetPropertyByIndex

retrieve a single mezProperty of the object using the property index in the object

RefreshData

refresh the properties for an object from the server

Rename

rename an object

SetDeleteFlag

set the delete flag of an object to either Boolean True or False

SetupNewObject

used to create an object of a particular type (generally used to get information about a particular object type)

Update

store the data contained in an object (and child objects of its properties) to the server

  Properties

bAreRequiredPropertiesEntered

indicates when all of an object's required properties have assigned values

bDeleteFlag

indicates when an object's delete flag has been set to True

bIsModifiable

indicates when the user has permission to modify at least one of the object's properties

bIsModified

indicates when any of the object's single value properties have been modified

eAccessLevel

the level of access the user has to an object, using the e_ObjectAccess enumeration

eObjectState

the current state of the object, using the e_ObjectState enumeration

hSctx

the handle of the user session into the CS library

iActionListCount

the number of actions that can be performed on the object

iKeyCount

the number of key properties for the object type

iObjectNum

the number for the object type

iPropertyCount

the number of properties contained in the object

sKeyValue

the value of the object's key

sListKey

the start value to be used when calling mezProperty.Expand() for a subsequent set of rows contained in the object

sObjectName

the user friendly name for the type of the object