Package wt.folder

Class Cabinet

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.fc._Item
wt.fc.Item
wt.folder._Cabinet
wt.folder.Cabinet
All Implemented Interfaces:
Externalizable, Serializable, wt.access._AccessControlled, wt.access._AccessControlList, wt.access._AdHocControlled, wt.access._IdentityAccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.AccessControlList, AdHocControlled, wt.access.IdentityAccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.fc._Identified, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, Identified, NetFactor, ObjectMappable, Persistable, wt.folder._CabinetBased, wt.folder._Folder, wt.folder._FolderServiceManaged, CabinetBased, Folder, wt.folder.FolderServiceManaged, DisplayIdentification, wt.inf.container._WTContained, wt.inf.container._WTContainedIdentified, WTContained, WTContainedIdentified, wt.notify._Notifiable, Notifiable, wt.ownership._Ownable, wt.ownership.Ownable, wt.recent.RecentlyVisited
@GenAsPersistable(superClass=Item.class,interfaces={Identified.class,Notifiable.class,AdHocControlled.class,Folder.class,wt.ownership.Ownable.class,wt.access.IdentityAccessControlled.class},versions=1438494200585984503L,properties={@GeneratedProperty(name="name",type=java.lang.String.class,javaDoc="Unique name for the Cabinet. The name may not contain <code>FolderService.FOLDER_SEPARATOR<\\code> character.",constraints=@PropertyConstraints(changeable=VIA_OTHER_MEANS,upperLimit=400,required=true),columnProperties=@ColumnProperties(persistent=true)),@GeneratedProperty(name="description",type=java.lang.String.class,javaDoc="Describes the purpose of the cabinet."),@GeneratedProperty(name="personalCabinet",type=boolean.class,javaDoc="A boolean set to true if the cabinet is a personal cabinet and set to false if the cabinet is a shared cabinet.",constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="creatorReference",type=WTPrincipalReference.class,javaDoc="A reference to the WTPrincipal (eg user) that created this folder.",accessors=@PropertyAccessors(setExceptions={}),constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(columnName="B"))},tableProperties=@TableProperties(compositeIndex1="name+domainRef.key.id",compositeIndex2="ownership.owner.key.id + personalCabinet",compositeUnique1="containerReference.key.id + name"),iconProperties=@IconProperties(standardIcon="wt/clients/images/folder_navigator.gif",openIcon="wt/clients/images/folder_navigator.gif")) public final class Cabinet extends wt.folder._Cabinet
A Cabinet is a major organizing characteristic for information residing in folders. A cabinet acts like a top-level folder, providing containment for the information that is "inside" of it. There are two types of Cabinets, personal cabinets and shared cabinets. Both can be associated with any AdministrativeDomain. A Personal Cabinet holds the information owned by a specific user while a Shared Cabinet contains the information that can be accessed by other users in the system depending on the administrative polices. The methods in this class are not intended for general client usage because they implement lower level functionality compared to methods on the FolderService.

Use the newCabinet static factory method(s), not the Cabinet 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.

The Cabinet constructor method and the newCabinet static factory methods are not supported APIs for customization.



Supported API: true

Extendable: false

See Also:

  • Field Summary

    Fields inherited from class wt.folder._Cabinet

    CREATOR_REFERENCE, DESCRIPTION, EXTERNALIZATION_VERSION_UID, NAME, PERSONAL_CABINET

    Fields inherited from class wt.fc.Item

    SIMPLE_X10_UID, VERSION_40_UID, VERSION_51_UID

    Fields inherited from class wt.fc._WTObject

    CREATE_TIMESTAMP, MODIFY_TIMESTAMP

    Fields inherited from interface wt.access._AdHocControlled

    ENTRY_SET

    Fields inherited from interface wt.fc.adminlock._AdministrativelyLockable

    ADMINISTRATIVE_LOCK

    Fields inherited from interface wt.admin._DomainAdministered

    DOMAIN_REF, INHERITED_DOMAIN

    Fields inherited from interface wt.notify._Notifiable

    EVENT_SET

    Fields inherited from interface wt.ownership._Ownable

    OWNERSHIP

    Fields inherited from interface wt.fc._Persistable

    PERSIST_INFO

    Fields inherited from interface wt.access._SecurityLabeled

    SECURITY_LABELS

    Fields inherited from interface wt.inf.container._WTContained

    CONTAINER, CONTAINER_NAME, CONTAINER_REFERENCE

    Fields inherited from interface wt.folder.CabinetBased

    FOLDER_PATH, LOCATION

    Fields inherited from interface wt.identity.DisplayIdentification

    DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

    Fields inherited from interface wt.fc.Persistable

    IDENTITY, TYPE

    Fields inherited from interface wt.access.SecurityLabeled

    SECURITY_LABELS_INTERNAL_VALUE

    Fields inherited from interface wt.inf.container.WTContained

    CONTAINER_ID

  • Method Summary

    Methods inherited from class wt.folder._Cabinet

    getClassInfo, getConceptualClassname, getContainer, getContainerName, getContainerReference, getCreatorReference, getDescription, getEntrySet, getEventSet, getName, getOwnership, getType, isPersonalCabinet, readExternal, readExternal, readVersion, setContainer, setContainerReference, setCreatorReference, setDescription, setEntrySet, setEventSet, setOwnership, setPersonalCabinet, super_readExternal_Cabinet, super_readVersion_Cabinet, super_writeExternal_Cabinet, writeExternal, writeExternal

    Methods inherited from class wt.fc._Item

    getAdministrativeLock, getDomainRef, getSecurityLabels, isInheritedDomain, readVersion, setAdministrativeLock, setDomainRef, setInheritedDomain, setSecurityLabels, super_readExternal_Item, super_readVersion_Item, super_writeExternal_Item

    Methods inherited from class wt.fc.WTObject

    checkAttributes, duplicate, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity

    Methods inherited from class wt.fc._WTObject

    equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface wt.fc.adminlock._AdministrativelyLockable

    getAdministrativeLock, setAdministrativeLock

    Methods inherited from interface wt.fc._Persistable

    getPersistInfo, setPersistInfo

    Methods inherited from interface wt.fc.Persistable

    checkAttributes, getIdentity