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
   

bAreRequiredPropertiesEntered Property

This property returns Boolean True when all of a mezObject's required properties have assigned values, otherwise, the method returns False.

Syntax
objMezObject.bAreRequiredPropertiesEntered

Applies to
mezObject object

Data Type
Boolean

Default Value
False

Access
Read-only

 

bDeleteFlag Property

This property returns Boolean True when a mezObject's delete flag has been set to True. When the delete flag is set to True, the mezObject will be deleted the next time the Update() method is called.

Syntax
objMezObject.bDeleteFlag

Applies to
mezObject object

Data Type
Boolean

Default Value
False

Access
Read-only

See Also
SetDeleteFlag Method
Update Method
mezList object

 

bIsModifiable Property

This property returns Boolean True when the user has permission to modify at least one of the mezObject's properties.

Syntax
objMezObject.bIsModifiable

Applies to
mezObject object

Data Type
Boolean

Default Value
False

Access
Read-only

 

bIsModified Property

This property returns Boolean True when any of the mezObject's single value properties have been modified.

Syntax
objMezObject.bIsModified

Applies to
mezObject object

Data Type
Boolean

Default Value
False

Access
Read-only

 

eAccessLevel Property

The level of access the user has to a mezObject, as defined in the e_ObjectAccess enumeration:

eObjAccessNone — no privileges to the object (not visible to end user)
eObjAccessViewer — read-only
eObjAccessAuthor — read and write, version check-in / out, modify certain properties
eObjAccessOwner — all author privileges, create / delete object, modify most properties
eObjAccessAdmin — all owner privileges, modify all modifiable properties

For more information about security access rights for end users, see the FileNet Content Services API Manual, release 5 series documentation on the FileNet website.

Syntax
objMezObject.eAccessLevel

Applies to
mezObject object

Data Type
e_ObjectAccess

Default Value
eObjAccessNone

Access
Read-only

See Also
e_ObjectAccess Enumeration

 

eObjectState Property

The level of access the user has to a mezObject, as defined in the e_ObjectState enumeration:

eObjStateInitial — object created with "New" command, not yet stored in CS library,
        no property values yet
eObjStateFull — full object in the CS library with all property values specified
eObjStatePartial — partial object in the CS library with some property values specified;
        (Partial mezObjects only contain some of their properties and
        are the result of mezProperty expansion via the Expand() method.)
eObjStateNew — newly allocated object, not yet stored in the CS library
eObjStateDeleted — object deleted from the CS library

For more information about security access rights for end users, see the FileNet Content Services API Manual, release 5 series documentation on the FileNet website.

Syntax
objMezObject.eObjectState

Applies to
mezObject object

Data Type
e_ObjectState

Default Value
eObjStateInitial

Access
Read-only

See Also
e_ObjectState Enumeration
mezProperty object
mezProperty Expand Method

 

hSctx Property

This property returns the handle of the mezObject for the user's session into the Content Services library.

Syntax
objMezObject.hSctx

Applies to
mezObject object

Data Type
Long

Default Value
n/a

Access
Read-only

 

iActionListCount Property

The number of actions that can be performed on the mezObject.

Syntax
objMezObject.iActionListCount

Applies to
mezObject object

Data Type
Integer

Default Value
0 (zero)

Access
Read-only

 

iKeyCount Property

The number of key properties for the mezObject type.

Syntax
objMezObject.iKeyCount

Applies to
mezObject object

Data Type
Integer

Default Value
0 (zero)

Access
Read-only

 

iObjectNum Property

The number for the mezObject type.

Syntax
objMezObject.iObjectNum

Applies to
mezObject object

Data Type
Integer

Default Value
n/a

Access
Read-only

 

iPropertyCount Property

The number of properties contained in the mezObject.

Syntax
objMezObject.iPropertyCount

Applies to
mezObject object

Data Type
Integer

Default Value
0 (zero)

Access
Read-only

 

sKeyValue Property

The value of the mezObject's key.

Syntax
objMezObject.sKeyValue

Applies to
mezObject object

Data Type
String

Default Value
Empty (null)

Access
Read-only

See Also
sListKey Property

 

sListKey Property

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

Syntax
objMezObject.sListKey

Applies to
mezObject object

Data Type
String

Default Value
Empty (null)

Access
Read-only

See Also
sKeyValue Property
mezProperty object
mezProperty Expand Method

 

sObjectName Property

The user friendly name for the type of the mezObject.

Syntax
objMezObject.sObjectName

Applies to
mezObject object

Data Type
String

Default Value
Empty (null)

Access
Read-only