Share Base Class and Subclass

The Share base class (ClbShare) and its subclass define user-creatable share records associated with a document or folder.

The following subclasses derive from the Share base class: Document Share and Folder Share

You can view the base class and subclasses in the Administration Console for Content Platform Engine, under the object store navigation pane. Go to Data Design > Classes > Other Classes > Abstract Persistable > Share.

Share base class

The Share base class (ClbShare) represents the base abstract class for document shares and folder shares.

Class metadata:

Allows instances: false
Hidden: false
Subclassed from: Abstract Persistable (CmAbstractPersistable) class

Table 1. Share properties on the Share base class
Column Name	Property	Description
Share Issuer (ClbShareIssuer)	Singleton OVP	Required class User, value-required. References the user who issued the share. Read/Write
Share Recipient (ClbShareRecipient)	Singleton OVP	Required class User, value-required, settable only on create. References the user to whom the share is offered. Settable on create
Shared Rights Mask (ClbSharedRightsMask)	Singleton Integer	Value required. A bitmask of access rights shared (becomes the DelegatedAccessMask of a DelegatedPermission). Read/Write
Share Recipient Response(ClbShareRecipientResponse)	Singleton Integer	A value drawn from a choice list giving the status of this share: 0 = pending (invitation issued but not yet accepted) 1 = accepted 2 = rejected The default value is 0 and is the only value permitted upon creation. Read/Write
Share Expiry Date (ClbShareExpiryDate)	Singleton Date Time	An optional value specifying the date/time beyond which the share should be automatically removed (by the ShareDispositonSweep). This allows limited duration sharing. Read/Write
Share Description (ClbShareDescription)	Singleton String	A description of the reason for the share, shown to the recipient when they view the share. Can be sent within the email invitation. Read/Write
Share Recipient Response Date (ClbShareRecipientResponseDate)	Singleton Date Time	Timestamp the user accepts/rejects record. Read /Write once
Share Title (ClbShareTitle)	Singleton String	This value is used for the subject of the email when creating the invitation for the external user. String Length -256 Read/Write
Transaction Id (ClbShareTransactionId)	ID	Transaction Id used by the application to group share items.
Share Options(ClbShareOptions)	String	This value is set and utilized by the application
Controlling Share (ClbControllingShare)	Object	Required for folder share (ClbFolderShare), reflective property ClbFolderShare.ControlledShares, Settable only on create.

Document Share(ClbDocumentShare)

Table 2. Document Share properties on the Share base class
Column Name	Property	Description
Shared Document (ClbSharedDocument)	Singleton OVP
Document Major Version(ClbShareRecipient)	Singleton Integer
Document Minor Version(ClbSharedRightsMask)	Singleton Integer
Share Target (ClbShareTarget)	Singleton Object	Required class Document, value-required, settable-only-on-create, target access required DELEGATE_ACCESS.

Folder Share(ClbFolderShare)

Table 3. Folder Share properties on the Share base class
Column Name	Property	Description
Share Target (ClbShareTarget)	Singleton OVP	Required class Folder, value-required, settable-only-on-create, target access required DELEGATE_ACCESS. Enables CASCADE DELETE via folder.
Controlled Shares (ClbControlledShares)	Enum of Object	Required class: Document Share, reflective to DocumentShare.ControllingShare. CASCADE DELETE.
Contributed Document Access Mask (ClbContributedDocumentAccessMask)	Singleton Integer	A bitmask of access rights that are returned to a recipient document filer once ownership of the document is transferred to the issuer.