Actions of Records Object Model (RECORDSOM@1.1001)

ReferenceName
RECORDSOM@1.1001:AttrAccRestrictionsSetSet time-constrained access restrictions
RECORDSOM@1.1001:AttrContainsChildrenCopyCopy children of "Contains" property
RECORDSOM@1.1001:AttrContainsSetSet "Contains" property
RECORDSOM@1.1001:AttrObjSecRestrictedSetSet users/groups with restricted change access
RECORDSOM@1.1001:AttrRefersToSetSet "Refers to" property
RECORDSOM@1.1001:AttrStructuredCodeGetBuild structured code
RECORDSOM@1.1001:BuildClassificationCodeBuild classification code
RECORDSOM@1.1001:BuildClassificationCodeIntBuild classification code number
RECORDSOM@1.1001:CheckAllowedChildrenCheck allowed children
RECORDSOM@1.1001:ClassCodeSetSet classification code
RECORDSOM@1.1001:FQClassCodeSetSet "Fully-Qualified Classification Code"
RECORDSOM@1.1001:GenericPropToChildrenSetSet action for generic propagation to children
RECORDSOM@1.1001:GetAllowedChildClassesHintGet allowed child classes (Hint)
RECORDSOM@1.1001:GetAllowedChildClassesSettingsGet child class settings
RECORDSOM@1.1001:GetContainsObjectsGet "Contains" objects
RECORDSOM@1.1001:GetTopLevelObjectGet top-level object
RECORDSOM@1.1001:InitializeInitialize ERMS Object
RECORDSOM@1.1001:ModifyPageACLWrapperModify display items of security page
RECORDSOM@1.1001:ProcessAccessRestrictionsProcess access restrictions

RECORDSOM@1.1001:AttrAccRestrictionsSet (Set time-constrained access restrictions)

Set action can be overridden with project-specific implementations

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:AttrContainsChildrenCopy (Copy children of "Contains" property)

Copy children of an ERMS object

Additional Information

Prototype: COOSYSTEM@1.1:AttrCopyPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

RECORDSOM@1.1001:AttrContainsSet (Set "Contains" property)

Set RECORDSOM@1.1001:contains property and check if it contains valid objects

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:AttrObjSecRestrictedSet (Set users/groups with restricted change access)

Set restricted users/groups with change access and propagate changes to children

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:AttrRefersToSet (Set "Refers to" property)

Initialize an object when it is attached to an ERMS object

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

RECORDSOM@1.1001:AttrStructuredCodeGet (Build structured code)

Get the structured code for an ERMS object

Additional Information

Prototype: COOSYSTEM@1.1:AttrGetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

RECORDSOM@1.1001:BuildClassificationCode (Build classification code)

Build classification code for ERMS object

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:BuildClassificationCodeInt (Build classification code number)

Build integer classification code for ERMS object

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:CheckAllowedChildren (Check allowed children)

Check if children are allowed in object list. If object classes instead of ordinary objects are passed in the children parameter, check whether these object classes are allowed in attrdef.
ParameterTypeIn/OutOptionalDescription
childrenCOOSYSTEM@1.1:OBJECTLISTinfalse the objects or object classes to check
allowedCOOSYSTEM@1.1:BOOLEANoutfalse
throwerrorCOOSYSTEM@1.1:BOOLEANintrue
attrdefCOOSYSTEM@1.1:OBJECTintrue the attribute definition
modeCOOSYSTEM@1.1:CheckAllowedModeintrue

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:ClassCodeSet (Set classification code)

Build fully qualified classification code

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

RECORDSOM@1.1001:FQClassCodeSet (Set "Fully-Qualified Classification Code")

Build fully qualified classification code

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

RECORDSOM@1.1001:GenericPropToChildrenSet (Set action for generic propagation to children)

Propagate a property value to the children of the object

Additional Information

Prototype: COOSYSTEM@1.1:AttrSetPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

RECORDSOM@1.1001:GetAllowedChildClassesHint (Get allowed child classes (Hint))

Filter action for RECORDSOM@1.1001:specialchildclasses that provides list entries for the RECORDSOM@1.1001:ERMSClass property RECORDSOM@1.1001:specialchildclasses according to the value of RECORDSOM@1.1001:specialchildclassessettings within the current classification scheme. See RECORDSOM@1.1001:GetAllowedChildClassesSettings for a similar functionality within a RECORDSOM@1.1001:ERMSClassificationScheme.
ParameterTypeIn/OutOptionalDescription
allowedspecialclassesCOOSYSTEM@1.1:OBJECTLISToutfalse fields that will be presented to the user for selection within the property RECORDSOM@1.1001:specialchildclasses of a class @see RECORDSOM@1.1001:specialchildclassessettings @see RECORDSOM@1.1001:specialchildclasses

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:GetAllowedChildClassesSettings (Get child class settings)

Returns the child class settings from the parent class or classification scheme
ParameterTypeIn/OutOptionalDescription
settingsCOOSYSTEM@1.1:OBJECToutfalse

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:GetContainsObjects (Get "Contains" objects)

Retrieves objects within the property RECORDSOM@15.1001:contains and returns "null" if no such property is present.

This way an easy and unified way of retrieving objects within contains is provided that is independent of the current object class.
ParameterTypeIn/OutOptionalDescription
containsobjsCOOSYSTEM@1.1:OBJECTLISToutfalse Objects within contains, and depending on recursive also subordinate objects. Returns "null" if target object does not have the property contains.
recursiveCOOSYSTEM@1.1:BOOLEANinfalse If "true" also subordinate objects are traversed and included by using COOSYSTEM@1.1:GetAttributeRecursiveand. Objects within the property contains are retrieved down to the level including Record, but excluding MetadataStub. Thus no components like content objects that may be part of a record are included.

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:GetTopLevelObject (Get top-level object)

Returns the nearest object with a object class topobjclass by walking up the hierarchy through the attribute attrdef starting with the current object. If called on an object with the object class Class and topobjclass being Class, it returns the object itself.
ParameterTypeIn/OutOptionalDescription
toplevelobjectCOOSYSTEM@1.1:OBJECToutfalse Resulting top level object with an object class topobjclass that is superordinate to the current object.
topobjclassCOOSYSTEM@1.1:OBJECTintrue Object class to search for. If "null", the top object of the whole hierarchy is returned.
attrdefCOOSYSTEM@1.1:OBJECTintrue Attribute used to walk up the hierarchy. If "null", the attribute RECORDSOM@1.1001:refersto is used.

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:Initialize (Initialize ERMS Object)

Initialize a new ERMS object with defaults (from its parent)
ParameterTypeIn/OutOptionalDescription
target_objectCOOSYSTEM@1.1:OBJECTintrue the target_object
target_attrdefCOOSYSTEM@1.1:OBJECTintrue the target_attrdef
templateCOOSYSTEM@1.1:OBJECTintrue the template
param_objectsCOOSYSTEM@1.1:OBJECTLISTintrue the param_objects

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]

RECORDSOM@1.1001:ModifyPageACLWrapper (Modify display items of security page)

Remove objlitigationhold flag from form page

Additional Information

Prototype: COOATTREDIT@1.1:FormPageItemPrototype
ACL Object: COOWF@1.1:WorkFlowActionACL
Private: true


[top]

RECORDSOM@1.1001:ProcessAccessRestrictions (Process access restrictions)

Process time constrained access restrictions

Additional Information

ACL Object: COOWF@1.1:WorkFlowActionACL


[top]