Selectable Fields for Interface

This section lists the selectable fields for interface objects.

Selectable Fields for Interface
Field Description Output

abstract

Is this interface defined as abstract?

True/False

allchildren

All child interfaces

Returns names of all child interfaces. Same as derivative.

allparents

All parent interfaces

Names of all parents.

attribute[].*

Attributes of interface

If [name] is specified, returns True if name is an attribute of the interface; False if not. If no name is specified, returns all attributes.

derivative[].*

All child interfaces

If [name] is specified, returns True if name is child of this object; False if not. If no name is specified, returns names of all child interfaces (same as allparents).

derived.*

Immediate parent interfaces

Name of the immediate parent interface definition

description

Interface object description

Value

hidden

Is this interface defined as hidden?

True/False

id

Interface identifier

Value

immediateattribute[].*

Non-inherited attributes

If [name] is specified, returns True if name is an immediateattribute of the interface; False if not. If no name is specified, returns all immediateattributes.

immediatederivative[].*

Immediate child interfaces

Returns first level children, see derivative for defaults.

modified

Time and date the administration object was modified

Value

modified.generic

Time and date in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator) the administration object was modified

Value

name

Interface object name

Value

object[ ]

a corresponding business object

Returns a business object where the type matches the string in [ ] and the name is the same as the interface's name. If no string is given, the object type is interface, with case ignored. In a case sensitive environment if more than 1 type meets that criteria (such as both a Person type and a PERSON type), OR if there are more than 1 object with the same type and name that are not in the same revision chain, the object with the latest originated date is returned. When objects with same type and name are in the same revision chain, the latest revision is returned.

originated

Time and date the administration object was created

Value

originated.generic

Time and date in generic format (independent of the MX_NORMAL_DATETIME_FORMAT and MX_DECIMAL_SYMBOL settings chosen by an Administrator) the administration object was created

Value

property[].*

Associated properties

If [name] is specified, returns property name and value. If blank, returns all property names and values.

relationship

Name

Names of relationship types.