Package wt.inf.sharing

Class SharedContainerMap

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.fc._Item
wt.fc.Item
wt.inf.sharing._SharedContainerMap
wt.inf.sharing.SharedContainerMap
All Implemented Interfaces:
Externalizable, Serializable, wt.access._AccessControlled, wt.access._AccessControlList, wt.access._AdHocControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.AccessControlList, AdHocControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, NetFactor, ObjectMappable, Persistable, DisplayIdentification, wt.inf.container._WTContained, WTContained, wt.recent.RecentlyVisited
@GenAsPersistable(superClass=Item.class,interfaces={AdHocControlled.class,WTContained.class},versions={-4786760396285351357L,-635977966995461980L},properties={@GeneratedProperty(name="sharedObjectRef",type=ObjectReference.class,javaDoc="Reference to the shared object. It may be an object or a version reference. @see wt.fc.WTReference @see wt.fc.ObjectReference @see wt.vc.VersionReference",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="sharedVersionRef",type=VersionReference.class,accessors=@PropertyAccessors(setExceptions={}),columnProperties=@ColumnProperties(index=true)),@GeneratedProperty(name="iterationId",type=IterationIdentifier.class,javaDoc="Attribute containing the {@link wt.vc.IterationIdentifier} for the first iteration shared, in case the shared object is {@link wt.vc.Iterated}. If the object is not iterated, this attribute is null.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="targetContainerRef",type=WTContainerRef.class,javaDoc="Reference to the container that is sharing the object.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="sourceContainerRef",type=WTContainerRef.class,javaDoc="Reference to the container that ows the shared object.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="targetFolderRef",type=ObjectReference.class,javaDoc="Folder in the target container where the shared object is located. Null if the shared object is not foldered.",accessors=@PropertyAccessors(setExceptions={}),columnProperties=@ColumnProperties(index=true)),@GeneratedProperty(name="creatorRef",type=WTPrincipalReference.class,javaDoc="Reference to the user who created the sharing.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="enabled",type=boolean.class,initialValue="true",javaDoc="Determines if the sharing is active. It is set to \'true\' is active or \'false\' otherwise. This attribute is used for temporary inactivation of the sharing. The initial value is \'true\'.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="shareKey",type=long.class,javaDoc="Identification of the sharing. Used to identify the sharing as a member of a \"shared object collection.\" <p>Shared object collections can result from sharing a complex object like a folder or a part or through multiple select. In these cases it might be desirable to cancel the share to all objects of the share. The information about the set is held in the key attribute. <p> Note: the shared object key is not enough to characterize the collective share operation but the pair <key, target container> is. <p>This attribute is modeled as a String so not to constrain what can be stored in it. For cases where it is possible to identify a single object to represent the collection (such as a folder), a possibility is to use a stringfied representation of the object\'s reference.",accessors=@PropertyAccessors(setExceptions={}),columnProperties=@ColumnProperties(index=true)),@GeneratedProperty(name="shareType",type=int.class,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="shortcut",type=boolean.class,javaDoc="Stores whether one can add access control to shared object in the context of the target container. The value is \'true\' if no access control can be added and \'false\' otherwise. The default (normal share behavior) is \'false\'. Shares that don\'t allow additional access control are called \"shortcuts.\"",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="sharedMasterRef",type=ObjectReference.class,javaDoc="Reference to the master of the object being shared. This attribute is only not null for REVISION and STATE shares.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="lcState",type=State.class,javaDoc="Lifecycle state of the shared object. This attribute is only not null for STATE shares.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="baselineMemberRef",type=ObjectReference.class,javaDoc="Reference to the baseline member link, if one exists for this share.",accessors=@PropertyAccessors(setExceptions={}))},tableProperties=@TableProperties(compositeIndex1="sharedObjectRef.key.id",compositeIndex2="sharedVersionRef.key.branchId",compositeIndex3="targetContainerRef.key.id",compositeIndex4="sourceContainerRef.key.id",compositeIndex5="targetFolderRef.key.id",compositeIndex6="sharedMasterRef.key.id",compositeUnique1="sharedObjectRef.key.id + sharedVersionRef.key.branchId + targetContainerRef.key.id")) public class SharedContainerMap extends wt.inf.sharing._SharedContainerMap
Records which objects are shared by which containers. Basically it contains references to the shared object and the sharing ("target") container. In case the shared object is foldered, also contains a reference to the folder the shared object is placed in the target container. A SharedContainerMap object is also called a "sharing."

Each sharing holds also additional attributes that helps querying and other operations.

Use the newSharedContainerMap static factory method(s), not the SharedContainerMap constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also: