CustomObject
object has no inherent semantics, but is independently securable and can be persisted to an object store. A CustomObject
does not carry content, is not versionable, and does not support lifecycle functionality. The
base interface provides a minimal set of properties (such as Creator, DateCreated, and Name). Unlike most Content Engine objects, the
base interface does not have a specific property defined as the name property in order that subclassed objects can define it in an appropriate way. Because a
object does not have a defined name property, the value of its
property reverts to the default value, which is the same as its
property.
The following tables list the members exposed by ICustomObject.
Public Properties
Name | Description | |
---|---|---|
![]() | IndexationId | The object ID (GUID) of the Verity collection used. This will be for objects that were full text indexed prior to the 4.0 release. This property must be set if the property is to be CBR enabled (the |
![]() | SecurityFolder | Indicates a object from which the object inherits security (a security parent). This value is indirectly set when DefineSecurityParentage is specified as the value of the You can designate multiple security parents for an object by using one or more object-valued properties and setting the |
![]() | SecurityParent | Obsolete. Specifies the object from which a given object inherits security. The value of this property is a (or ) that represents the object from which security is inherited. An object can inherit its permissions from its security parent. For example, a |
![]() | WorkflowSubscriptions | The IInstanceWorkflowSubscriptionSet object containing the IInstanceWorkflowSubscription objects whose target is this object. |
Public Methods
Name | Description | |
---|---|---|
![]() | ApplySecurityTemplate | Applies a security policy template to the given object. The specified value for the parameter must match the value of the ApplyStateID property of one of the templates in the security policy for the object. For a versioning security template, the apply state ID can be one of the following: For an application security template, the apply state ID is defined by your application. |
![]() | ChangeClass | Changes the class of a Content Engine object. The new class must already exist and both it and the original class must be subclasses of the same base class. The method does not modify the security for an object, even if the object's current security is derived from the default security for its source class. For the object's user-defined properties, the following rules apply:
When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's
|
![]() | IsLocked | Queries this object's lock state. This helper method examines the object's lock-related properties and determines the object's lock state. An alternative approach is to call the method and handle any exception thrown if the method fails. Note that this method returns an approximation of the locked state at the time of the call. Once this method executes and returns the value, the object's lock state could be immediately changed by another application's call to the Before calling this method, make sure that the object's LockToken, LockTimeout, and DateLastModified properties have relatively fresh values. If any of those properties is missing, they are silently fetched from the server and added to the object's property cache. The Note: Note: To successfully run |
![]() | LockObject | Sets a new lock or updates an existing lock on the object. Calling this method has no effect in preventing others from updating a locked object (with the exception that others cannot re-lock the locked object). This lock mechanism is used for custom purposes only and has no bearing on the actual ability to update an object. To successfully execute this method, the current user must have permission to modify this object's properties. For example, locking a If the call succeeds:
To update an existing lock, the objects needs to be in the locked state and the current user needs to match the user of the lock. Note that the user is the logged in user, not the |
![]() | Unlock | Explicitly removes the lock from this object. Only the user who locked the object may remove the lock. If the current user is not the user of the lock, the current user can still remove the lock provided that user has permission on the object. An exception is thrown if the above conditions are not met. Upon successful execution of this method, the values for the object's LockOwner, LockToken, and LockTimeout properties are removed (set to ). If you do not call to explicitly remove the lock, the lock is implicitly removed when the lock's timeout value expires. |
![]() | UpdateLock | Adjusts the timeout period of the lock on this object. This method updates the object's DateLastModified property to the current time and its LockTimeout property to the timeout value. The net effect of this may extend or shorten the original lock's expiration time. Only the user who locked the object can successfully call this method; for any other user, an exception is thrown. There is no limit to the number of times you can call this method. |