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 mezProperty
Level 2     Methods
Level 2     AddChild
Level 2     ConvertIndexed
Level 2     Expand
Level 2     GetActionListItem
Level 2     GetValueList
Level 2     GetValueListItem
Level 2     NewChild
Level 2     RemoveChild
Level 2     SetPropertyData
Level 2     Validate
Level 2     Properties
Level 2     bDisplayInPropSheet
Level 2     bDisplayInTree
Level 2     bHasValueList
Level 2     bIsAddableFromNewParent
Level 2     bIsDataVisible
Level 2     bIsExpandable
Level 2     bIsIndexed
Level 2     bIsKeyPart
Level 2     bIsModifiable
Level 2     bIsModified
Level 2     bIsRequired
Level 2     bMustPick
Level 2     bValueListMoreAvailable
Level 2     eParentAccessLevel
Level 2     ePropertyDataType
Level 2     ePropertyType
Level 2     eSortType
Level 2     hSctxHndl
Level 2     iActionListCount
Level 2     iParentObjectNumber
Level 2     iPropertyLength
Level 2     iPropertyNum
Level 2     iPropertyRefAttr
Level 2     iRefObjectNum
Level 2     lValueListCount
Level 2     mzList
Level 2     sParentKeyValue
Level 2     sPropertyData
Level 2     sPropertyName
Level 2 mezList
Level 2 mezUtility
Level 1 Enumeration Constants
Level 1 Status Codes
Level 1 General Information
   

bDisplayInPropSheet Property

This property returns Boolean True when this mezProperty object should be displayed along with other single-value mezProperty objects in a property sheet.

Syntax
objMezProperty.bDisplayInPropSheet

Applies to
mezProperty object

Data Type
Boolean

Default Value
False

Access
Read-only

 

bDisplayInTree Property

This property returns Boolean True when this mezProperty object should be displayed as a child of it's parent mezObject, in a tree view.

Syntax
objMezProperty.bDisplayInTree

Applies to
mezProperty object

Data Type
Boolean

Default Value
False

Access
Read-only

See Also
mezObject Object

 

bHasValueList Property

This property returns Boolean True when the mezProperty object has a list of values that either must be or may be selected from to set the property value.

Syntax
objMezProperty.bHasValueList

Applies to
mezProperty object

Data Type
Boolean

Default Value
False

Access
Read-only

See Also
bIsIndexed Property
bMustPick Property
bValueListMoreAvailable Property
GetValueList Method
GetValueListItem Method

 

bIsAddableFromNewParent Property

This property returns Boolean True if child objects may be added to a mezProperty object, although its parent mezObject is new and has not yet been stored in the CS library (e_ObjectState enumeration eObjStateNew). For example, Group Membership objects may be added when adding a new user, but Search request objects may not.

Syntax
objMezProperty.bIsAddableFromNewParent

Applies to
mezProperty object

Data Type
Boolean

Default Value
False

Access
Read-only

See Also
mezObject Object
e_ObjectState enumeration
mezObject eObjectState Property

 

bIsDataVisible Property

This property returns Boolean True when the value of the mezProperty object should be visible. This property is generally used to hide values for certain properties such as passwords.

Syntax
objMezProperty.bIsDataVisible

Applies to
mezProperty object

Data Type
Boolean

Default Value
True

Access
Read-only

 

bIsExpandable Property

This property returns Boolean True when a mezProperty object contains a mezList object of child objects, which in turn contains zero or more mezObjects. A mezProperty object that contains a list of objects is created by calling the Expand() method to generate the mezList object and populate it with child mezObjects.

Syntax
objMezProperty.bIsExpandable

Applies to
mezProperty object

Data Type
Boolean

Default Value
False

Access
Read-only

See Also
Expand Method
mezObject eObjectState Property
mezList Object
mezObject Object

 

bIsIndexed Property

This property returns Boolean True when the mezProperty object has a tooltype of SPI_TOOLTYPE_INDX_ATTR, indicating that the property values stored in the CS database are numbers, but are displayed as strings in the user interface. For more information about indexed property value lists, see the FileNet Content Services API Manual, release 5 series documentation on the FileNet website.

Syntax
objMezProperty.bIsIndexed

Applies to
mezProperty object

Data Type
Boolean

Default Value
False

Access
Read-only

See Also
bHasValueList Property
bMustPick Propert
bValueListMoreAvailable Property
ConvertIndexed Method
GetValueList Method
GetValueListItem Method

 

bIsKeyPart Property

This property returns Boolean True when the mezProperty object is part of its parent mezObject's key. For example, Group Membership objects have a two part key: the group name and the user name.

Syntax
objMezProperty.bIsKeyPart

Applies to
mezProperty object

Data Type
Boolean

Default Value
False

Access
Read-only

See Also
mezObject Object

 

bIsModifiable Property

This property returns Boolean True when the user has permission to modify the value of the mezProperty object.

Syntax
objMezProperty.bIsModifiable

Applies to
mezProperty object

Data Type
Boolean

Default Value
False

Access
Read-only

 

bIsModified Property

This property returns Boolean True when the value of the mezProperty object has been modified.

Syntax
objMezProperty.bIsModified

Applies to
mezProperty object

Data Type
Boolean

Default Value
False

Access
Read-only

 

bIsRequired Property

This property returns Boolean True when the mezProperty object must have a value.

Syntax
objMezProperty.bIsRequired

Applies to
mezProperty object

Data Type
Boolean

Default Value
False

Access
Read-only

 

bMustPick Property

This property returns Boolean True when the value for the mezProperty object must be chosen from a provided list values.

Syntax
objMezProperty.bMustPick

Applies to
mezProperty object

Data Type
Boolean

Default Value
False

Access
Read-only

See Also
bHasValueList Property
bIsIndexed Property
bValueListMoreAvailable Property
GetValueList Method
GetValueListItem Method

 

bValueListMoreAvailable Property

This property returns a Boolean True when there are more values available in the mezProperty object's value list.

Syntax
objMezProperty.bValueListMoreAvailable

Applies to
mezProperty object

Data Type
Boolean

Default Value
False

Access
Read-only

 

eParentAccessLevel Property

The level of access the user has to the parent mezObject of the mezProperty object, 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
objMezProperty.eParentAccessLevel

Applies to
mezProperty object

Data Type
e_ObjectAccess

Default Value
eObjAccessNone

Access
Read-only

See Also
e_ObjectAccess Enumeration
mezObject Object


ePropertyDataType Property

The data type of the mezProperty object, as defined in the e_PropertyDataType enumeration:

ePropDataTypeNumstring — Numeric string
ePropDataTypeString — String
ePropDataTypeNumeric — Numeric
ePropDataTypeDateTimedate / time
ePropDataTypeTexttext (longer than 32 characters)
ePropDataTypeVersion — version

Syntax
objMezProperty.ePropertyDataType

Applies to
mezProperty object

Data Type
e_PropertyDataType

Default Value
ePropDataTypeNumstring

Access
Read-only

See Also
e_PropertyDataType Enumeration

 

ePropertyType Property

This property indicates whether the mezProperty object is a single value or list type, as defined in the e_PropertyType enumeration:

ePropTypeSingle — a single data value
ePropTypeList — a mezList object, which in turn contains zero or more mezObjects

Syntax
objMezProperty.ePropertyType

Applies to
mezProperty object

Data Type
e_PropertyType

Default Value
n/a

Access
Read-only

See Also
e_PropertyType Enumeration
mezList Object
mezObject Object

 

eSortType Property

This property specifies whether the values for the mezProperty object should be sorted numerically (right justified) or alphanumerically (as a string) (left justified), as defined in the e_SortType enumeration:

eSortTypeStringsort values as strings (alphanumerically), left justified
eSortTypeNumericsort values as numbers, right justified

Syntax
objMezProperty.eSortType

Applies to
mezProperty object

Data Type
e_SortType

Default Value
eSortTypeString

Access
Read-only

See Also
e_SortType Enumeration

 

hSctxHndl Property

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

Syntax
objMezProperty.hSctxHndl

Applies to
mezProperty object

Data Type
Long

Default Value
n/a

Access
Read-only

 

iActionListCount Property

The number of actions contained in the mezProperty object's action list.

Syntax
objMezProperty.iActionListCount

Applies to
mezProperty object

Data Type
Integer

Default Value
0 (zero)

Access
Read-only

 

iParentObjectNumber Property

The object number for the type of the parent mezObject of the mezProperty object.

Syntax
objMezProperty.iParentObjectNumber

Applies to
mezProperty object

Data Type
Integer

Default Value
0 (zero)

Access
Read-only

See Also
mezObject Object

 

iPropertyLength Property

This property returns the display length of the mezProperty object, which can then be used to set the length of edit fields for this property within the user interface.

Syntax
objMezProperty.iPropertyLength

Applies to
mezProperty object

Data Type
Integer

Default Value
0 (zero)

Access
Read-only

 

iPropertyNum Property

This property returns the numeric identifier for the property, based on the mezProperty object's type. Each property for an object type in the Content Services API has a unique identifying number. For example, the identifier for the "Item Id" property in the "Item" object is 257. For more information about property identifiers, see the FileNet Content Services API Manual, release 5 series documentation on the FileNet website.

Syntax
objMezProperty.iPropertyNum

Applies to
mezProperty object

Data Type
Integer

Default Value
Null

Access
Read-only

 

iPropertyRefAttr Property

This property returns the reference attribute number for the property, based on the mezProperty object's type. Content Services uses the reference attribute number to create the value list for the property. Each property for an object type in the Content Services API has a unique reference attribute number. For example, the reference attribute number for the "Storage Category" property in the "Item" object is 2049. For more information about reference attribute numbers, see the FileNet Content Services API Manual, release 5 series documentation on the FileNet website.

Syntax
objMezProperty.iPropertyRefAttr

Applies to
mezProperty object

Data Type
Integer

Default Value
0 (zero)

Access
Read-only

 

iRefObjectNum Property

This property is applicable only to list type mezProperty objects, and returns the object number of the property objects' child objects. The object number is a unique number that describes the type of an object. For example, objects of type "Item" have an object number of 256. For a complete listing of object numbers, see the FileNet Content Services API Manual, release 5 series documentation on the FileNet website.

Syntax
objMezProperty.iRefObjectNum

Applies to
mezProperty object

Data Type
Integer

Default Value
0 (zero)

Access
Read-only

 

lValueListCount Property

This property returns the total number of values contained in the mezProperty object's value list.

Syntax
objMezProperty.lValueListCount

Applies to
mezProperty object

Data Type
Long

Default Value
0 (zero)

Access
Read-only

 

mzList Property

This property returns a reference to the mezProperty object's embedded mezList object.

Syntax
objMezProperty.mzList

Applies to
mezProperty object

Data Type
mezList

Default Value
Null

Access
Read-only

See Also
Expand Method
mezList Object

 

sParentKeyValue Property

The value of the mezProperty object's parent mezObject's key.

Syntax
objMezProperty.sParentKeyValue

Applies to
mezProperty object

Data Type
String

Default Value
Empty (null)

Access
Read-only

See Also
mezObject Object

 

sPropertyData Property

This property returns the current value of mezProperty object.

Syntax
objMezProperty.sPropertyData

Applies to
mezProperty object

Data Type
String

Default Value
Empty (null)

Access
Read-only

 

sPropertyName Property

This user friendly name for the type of the mezProperty object.

Syntax
objMezProperty.sPropertyName

Applies to
mezProperty object

Data Type
String

Default Value
Empty (null)

Access
Read-only