PublicObject (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.beans.LibraryObject
- - oracle.ifs.beans.TieLibraryObject
  - - oracle.ifs.beans.PublicObject

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, PublicObjectInterface, Traceable

Direct Known Subclasses:

TiePublicObject
```
public class PublicObject
extends TieLibraryObject
implements PublicObjectInterface
```
The PublicObject class is the abstract superclass of all "public object" classes, some of which are Documents, Folders, and ApplicationObjects. The common traits of public objects are:
- Public Objects are the only objects that appear in Folders.
- Public Objects are access controlled. Methods are implemented on this class to grant, revoke, set, and inquire on permissions.
- Public Objects have system-set create and modification date attributes.
- Public Objects have creator, owner, description, and ACL attributes that can be set from the API.
- Many subclasses of PublicObject can be versioned. The isVersionable() method will tell you if that class can be versioned.
- a PublicObject can be related to any other PublicObject via an instance of the Relationship class. There are methods to retrieve the left and right side relationship instances as well as the PublicObjects at the other end of those relationships.
- a PublicObject can belong to a category.
- A PublicObject can have its security attributes tied to another object. For example, PublicObject A can be "secured by" PublicObject B. When an access is changed on PublicObject B, PublicObject A's access is also modified.
Version:

1.0

Author:

Dave Long

See Also:

Family, Relationship, Category, PublicObjectDefinition

(Published)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACL_ATTRIBUTE` The AccessControlList that secures this object.
`static String`	`CLASS_NAME` This class name for this class.
`static String`	`CREATEDATE_ATTRIBUTE` The date and time (in GMT) when this object was created.
`static String`	`CREATOR_ATTRIBUTE` The DirectoryUser that created this object.
`static String`	`DELETOR_ATTRIBUTE` The DirectoryUser that deleted (not 'Freed') this object.
`static String`	`DESCRIPTION_ATTRIBUTE` A textual description of this object.
`static String`	`EXPIRATIONDATE_ATTRIBUTE` The date when this object 'expires'.
`static String`	`FAMILY_ATTRIBUTE` The Family to which this object belongs if this object is versioned.
`static long`	`FLAG_CATEGORY_EXISTS` Flag that indicates one or more Categories exist (bit 16).
`static long`	`FLAG_CONFIGURATIONCATEGORY_EXISTS` Flag that indicates one or more ConfigurationCategories exist (bit 17).
`static long`	`FLAG_MARKED` Flag for IMAP "Marked" status (bit 2).
`static long`	`FLAG_NOINFERIOR` Flag for IMAP "No Inferior" status (bit 0).
`static long`	`FLAG_NOSELECT` Flag for IMAP "No Select" status (bit 1).
`static long`	`FLAG_NTFS_ARCHIVE` Flag for SMB/NTFS "archive" status (bit 6).
`static long`	`FLAG_NTFS_HIDDEN` Flag for SMB/NTFS "hidden" status (bit 4).
`static long`	`FLAG_NTFS_READONLY` Flag for SMB/NTFS "readonly" status (bit 7).
`static long`	`FLAG_NTFS_SYSTEM` Flag for SMB/NTFS "system" status (bit 5).
`static long`	`FLAG_UNMARKED` Flag for IMAP "Unmarked" status (bit 3).
`static String`	`FLAGS_ATTRIBUTE` System-set flags of this object.
`static String`	`LASTMODIFIER_ATTRIBUTE` The DirectoryUser that last modified this object.
`static String`	`LASTMODIFYDATE_ATTRIBUTE` The date and time (in GMT) when this object was last modified.
`static String`	`LOCKENTRIES_ATTRIBUTE` LockEntries for this object.
`static String`	`LOCKOBJECT_ATTRIBUTE` The lock object for this PublicObject.
`static String`	`NAME_ATTRIBUTE` The name of this object.
`static String`	`OWNER_ATTRIBUTE` The DirectoryUser that owns this object.
`static String`	`POLICYBUNDLE_ATTRIBUTE` Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
`static String`	`POLICYLISTS_ATTRIBUTE` The set of PolicyLists explicitly applied to this object.
`static String`	`PRIMARYPARENTFOLDER_ATTRIBUTE` The primary parent folder for this PublicObject.
`static String`	`PROPERTYBUNDLE_ATTRIBUTE` The PropertyBundle associated with this object.
`static String`	`RESOLVEDPUBLICOBJECT_ATTRIBUTE` The PublicObject to which this object resolves.
`static String`	`SECURINGPUBLICOBJECT_ATTRIBUTE` A PublicObject from which this object should defer security decisions (e.g, all versions in a Family may have the Family as their securing public object).

Fields inherited from class oracle.ifs.beans.LibraryObject
DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PublicObject(LibrarySession session, Long id, Long classId, S_LibraryObjectData data)` Constructs a PublicObject object - standard variant.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected AccessControlEntry`	`addAccess(AccessControlEntryDefinition def)` addAccess - USed by grantAccess() and revokeAccess() to add a AccessControlEntry for this object.
`AttachmentRelation`	`addAttachment(Document doc)` Add an Attachment.
`Category`	`addCategory(CategoryDefinition catdef)` Adds a Category associated with this PublicObject.
`void`	`addFlags(long addedFlags)` Adds flags to the exist value of the FLAGS attribute, without causing the modification attributes to change.
`MessageList`	`addMessageList()` Deprecated. 9.2.4: use `findOrAddMessageList`
`Relationship`	`addRelationship(RelationshipDefinition reldef)` Creates a relationship object linking this object (the "left" object) to the PublicObject (the "right" object) contained in the specified Relationship Definition.
`protected void`	`auditPublicObjectLocked(int lockType)` Audits a PublicObject being locked.
`protected void`	`auditPublicObjectUnlocked(int lockType)` Audits a PublicObject being unlocked.
`boolean`	`canAcquireManualLock()` Returns whether a LockEntry of type `LibraryConstants.LOCKTYPE_MANUAL` can be acquired for this object by the current user.
`boolean`	`canReleaseDavLock()` Returns whether a LockEntry of type `LibraryConstants.LOCKTYPE_DAV` can be released from this object by the current user.
`protected boolean`	`canReleaseLock(LockEntry existingLock)` Returns whether the given existing LockEntry can be released from this object by the current user.
`boolean`	`canReleaseManualLock()` Returns whether a LockEntry of type `LibraryConstants.LOCKTYPE_MANUAL` can be released from this object by the current user.
`PublicObjectCapabilities`	`capabilities()` Returns the PublicObjectCapabilities delegate which tracks the capabilities of this object.
`boolean`	`checkAuditViewCapability()` Checks if user can view audit information for this object.
`boolean`	`checkCapabilities(AccessLevel capabilities)` Checks if the given capabilities are enabled for this object.
`boolean`	`checkCapability(long capability)` Checks if the given capability is enabled for this object.
`boolean`	`checkEffectiveAccess(AccessLevel level)` Checks to see if current user has the specified access level on this object.
`boolean`	`checkEffectiveAccess(DirectoryObject obj, AccessLevel level)` Check to see if specified user has the specified access level on this object.
`boolean`	`checkLockAccess(AccessLevel level)` Checks to see if current user is locked from the specified access level on this object.
`protected void`	`checkParentFolderCapability(PublicObjectDefinition poDef)` Check ADDITEM capability on a new parent folder, if one is specified.
`protected void`	`checkVersioned()`
`void`	`clearFlags(long clearedFlags)` Clears flags from the exist value of the FLAGS attribute, without causing the modification attributes to change.
`protected static PublicObject`	`constructPublicObject(LibrarySession sess, S_LibraryObjectData data)`
`static PublicObject[]`	`constructPublicObjectArray(LibrarySession sess, Long[] ids)` Constructs a PublicObject array from an array of object IDs.
`protected static Vector`	`constructPublicObjectVector(LibrarySession sess, Vector vector)`
`boolean`	`containsLockEntry(LockEntry le)` Checks if the specified LockEntry is contained in this instance's set of LockEntries.
`PublicObject`	`copy(LibraryObjectDefinition def)` Produces a copy of this PublicObject.
`protected boolean`	`coreAutoFolderingEnabled()` Extensibility point to see if core AutoFoldering is enabled.
`protected void`	`createCategories(CategoryDefinition[] catDefs)` Creates a set of Category objects associated with this PublicObject, without changing the modify date/modifier on the target object.
`protected PolicyPropertyBundle`	`createDedicatedPolicyPropertyBundle()` Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
`void`	`delete()` Mark an object for delete.
`void`	`deriveEffectiveAccessLevel(AccessLevel level)` Modify the AccessLevel specified to enable or disable effective permissions for this object.
`AttachmentRelation`	`findAttachmentRelation(Document doc)` Find an AttachmentRelation that corresponds to an attached Document.
`ActivityRecord`	`findOrAddActivityRecord()` Add an ActivityRecord to the target object if one does not already exist, and otherwise return the existing instance.
`ActivityRecord`	`findOrAddActivityRecord(ActivityRecordDefinition def)` Add an ActivityRecord to the target object if one does not already exist, and otherwise return the existing instance.
`Actor`	`findOrAddActor()` Add an Actor to the target object if one does not already exist, and otherwise return the existing instance.
`Actor`	`findOrAddActor(ActorDefinition def)` Add an Actor to the target object if one does not already exist, and otherwise return the existing instance.
`MessageList`	`findOrAddMessageList()` Add a MessageList to the target object if one does not already exist, and otherwise return the existing instance.
`MessageList`	`findOrAddMessageList(MessageListDefinition def)` Add a MessageList to the target object if one does not already exist, and otherwise return the existing instance.
`void`	`free(LibraryObjectDefinition def)` Permanently removes this object from the repository, with options.
`AccessControlList`	`getAcl()` Returns this object's AccessControlList.
`ActivityRecord`	`getActivityRecord()` Returns the ActivityRecord category if one exists.
`Actor`	`getActor()` Returns the Actor category if one exists.
`String[]`	`getAllFolderPaths()` Gets all Folder paths to the target object, starting from the Root Folder.
`String[]`	`getAllFolderPaths(Folder reference)` Gets all Folder paths to the target object.
`String[]`	`getAllFolderPaths(Folder reference, FolderPathOptions fpo)` Gets all Folder paths to the target object.
`String`	`getAnyFolderPath()` Gets any Folder path to the target object, starting from the Root Folder.
`String`	`getAnyFolderPath(Folder reference)` Gets any Folder path to the target object.
`String`	`getAnyFolderPath(Folder reference, FolderPathOptions fpo)` Gets any Folder path to the target object.
`AttachmentRelation`	`getAttachmentRelation()` Returns the AttachmentRelation category if one exists.
`AttachmentRelation[]`	`getAttachmentRelations()` Get the AttachmentRelations that comprise the set of attachments.
`Document[]`	`getAttachments()` Get the attached Documents.
`AccessLevel`	`getCapabilities()` Returns the enabled capabilities for this object.
`Category[]`	`getCategories()` Returns an array of categories for this PublicObject.
`Category[]`	`getCategories(ClassObject classobj)` Returns the associated Category objects that are instances of the ClassObject (or one of its subclasses) specified.
`Category[]`	`getCategories(ClassObject classobj, SortSpecification sort)` Returns the associated Category objects that are instances of the specified class or a subclass of the specified class.
`Category`	`getCategories(int index)` Returns the Category at specified index in the array of all Categories.
`Category[]`	`getCategories(SortSpecification sort)` Returns the associated Category objects.
`Category`	`getCategory(ClassObject classobj)` Returns the associated Category object that is an instance of the ClassObject (or one of its subclasses) specified.
`long`	`getConsumedStorage()` Returns the storage (in bytes) consumed by the content of this object.
`Date`	`getCreateDate()` Returns the date this object was created.
`DirectoryUser`	`getCreator()` Returns the user that created this object.
`AccessLevel`	`getDefaultAccessLevel()` Returns the access level defined for "World" access; i.e. the minimum access granted implicitly to all users.
`LibraryObjectDefinition`	`getDefinitionForSimplePropertyUpdates(boolean updateLastModInfo)` Gets the LibraryObjectDefinition to use for adding or removing SimpleProperties to/from the target object.
`DirectoryUser`	`getDeletor()` Returns the user that deleted this object, or null if the object is not marked for deletion.
`String`	`getDescription()` Returns the description of this object.
`AccessLevel`	`getEffectiveAccessLevel()` Get the access level on this object for the current user.
`AccessLevel`	`getEffectiveAccessLevel(DirectoryObject obj)` Get the access level on this object for the specified user.
`Date`	`getExpirationDate()` Returns the expiration date set for this object
`Family`	`getFamily()` Returns the Family with which this object is associated.
`Category`	`getFirstCategory(ClassObject clssObj)` Return the first category of given type, or null.
`PublicObject`	`getFirstVersion()` Returns the PublicObject referenced by the first VersionDescription in the PrimaryVersionSeries.
`long`	`getFlags()` Gets the flags bitmask.
`Folder[]`	`getFolderReferences()` Returns an array of folders that reference this PublicObject.
`Folder`	`getFolderReferences(int index)` Returns the Folder at specified index in the array of ReferencingFolders.
`SortSpecification`	`getFolderReferencesSortSpecification()` Returns the current sort specification used by the getFolderReferences method.
`DirectoryUser`	`getLastModifier()` Returns the user that last modified this object.
`Date`	`getLastModifyDate()` Returns the date this object was last modified
`PublicObject`	`getLastVersion()` Returns the PublicObject referenced by the last VersionDescription in the PrimaryVersionSeries.
`PublicObject[]`	`getLeftwardRelationshipObjects(ClassObject relClass)` Returns all "left side" public objects that are related to this object by the specied Relationship Class.
`PublicObject[]`	`getLeftwardRelationshipObjects(String relClassName)` Returns all "left side" public objects that are related to this object by the specied Relationship Class.
`Relationship[]`	`getLeftwardRelationships(ClassObject relClass)` Returns all "left side" relationship instances that are used to relate to this object to other PublicObjects.
`Relationship[]`	`getLeftwardRelationships(String relClassName)` Returns all "left side" relationship instances that are used to relate to this object to other PublicObjects.
`long`	`getLeftwardRelationshipsCount(ClassObject relClass)` Returns the count of all "left side" relationship instances that are used to relate to this object to other PublicObjects.
`long`	`getLeftwardRelationshipsCount(String relClassName)` Returns the count of all "left side" relationship instances that are used to relate to this object to other PublicObjects.
`Link[]`	`getLinks()` Gets all Link objects that refer to this PublicObject.
`LockEntry[]`	`getLockEntries()` Returns all LockEntry objects associated with this instance.
`LockEntry[]`	`getLockEntries(boolean includeFamily)` Returns the LockEntry instances that have been applied to this object, optionally including the LockEntry instances that have been applied to this object's Family, if this object has a Family.
`LockObject`	`getLockObject()` Returns the lock object of this object.
`AccessLevel`	`getLockRestrictions()` Gets the set of lock restrictions for the current user.
`protected AttributeValue[]`	`getLockTypeAuditProperties(int lockType)` Gets the audit event properties to add that describe a Lock type.
`MessageList`	`getMessageList()` Returns the MessageList category if one exists.
`PublicObject`	`getNextVersion()` Returns the PublicObject referenced by the next VersionDescription in the PrimaryVersionSeries.
`DirectoryUser`	`getOwner()` Returns the user that owns the object.
`PolicyPropertyBundle`	`getPolicyBundle()` Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
`PolicyList[]`	`getPolicyLists()` Gets the PolicyLists for this object.
`PublicObject`	`getPreviousVersion()` Returns the PublicObject referenced by the previous VersionDescription in the PrimaryVersionSeries.
`String`	`getPrimaryFolderPath()` Gets the primary path to the object, using the PRIMARYPARENTFOLDER attribute of the target object and the referencing folders above it in the folder hierarchy.
`Folder`	`getPrimaryParentFolder()` Gets the primary parent folder for the object.
`Folder`	`getPrimaryParentFolder(boolean useFamily)` Gets the primary parent folder for the object.
`Relation[]`	`getRelations()` Gets the set of Relation attached as categories to this object.
`String`	`getReservationComment()` Returns the reservation comment specified when this object's primaryVersionSeries was reserved.
`Date`	`getReservationDate()` Returns the Date on which this object's primaryVersionSeries was reserved.
`DirectoryUser`	`getReservor()` Returns the user that has reserved the primaryVersionSeries for this object.
`PublicObject`	`getResolvedPublicObject()` Returns the PublicObject to which this object resolves.
`LockEntry[]`	`getRestrictingLockEntries(AccessLevel level)` Gets the set of lock entries that result in restricting the specified access for the current user.
`PublicObject[]`	`getRightwardRelationshipObjects(ClassObject relClass)` Returns all "right side" public objects that are related to this object by the specified Relationship Class.
`PublicObject[]`	`getRightwardRelationshipObjects(String relClassName)` Returns all "right side" public objects that are related to this object by the specified Relationship Class.
`Relationship[]`	`getRightwardRelationships(ClassObject relClass)` Returns all "right side" relationship instances that are used to relate to this object to other PublicObjects.
`Relationship[]`	`getRightwardRelationships(String relClassName)` Returns all "right side" relationship instances that are used to relate to this object to other PublicObjects.
`PublicObject`	`getSecuringPublicObject()` Returns the Public Object that controls this object's security.
`protected VersionDescription`	`getSingletonVersionDescription()`
`long`	`getVersionNumber()` returns the sequential number of this revision within the primary version series.
`PublicObject[]`	`getVersions()` Returns an array of PublicObjects which are all referenced by the VersionDescriptions in the primary version series.
`VersionSeries`	`getVersionSeries()` Returns the Primary VersionSeries with which this object is associated.
`PublicObject`	`getWorkingCopy()` Returns the working copy of this object's Family.
`AccessControlEntry`	`grantAccess(AccessControlEntryDefinition def)` Add or extend an AccessControlEntryDefinition for this object.
`protected PublicObject`	`handleCopy(LibraryObjectDefinition def)` Handle the low-level repository copy
`protected PublicObject`	`handleCreate(LibraryObjectDefinition lodef)` Handles the low-level creation of the PublicObject
`protected void`	`handleUnlockAll()` Provides a template for subclasses to specify additional logic for the unlockAll() operation.
`boolean`	`hasActivityRecord()` Returns indication as to whether the object has an associated ActivityRecord category.
`boolean`	`hasActor()` Returns indication as to whether the object has an associated Actor category.
`boolean`	`hasAttachmentRelation()` Returns indication as to whether the object has an associated AttachmentRelation category.
`boolean`	`hasCategories()` Returns indication as to whether the object has any associated Categories.
`boolean`	`hasCategory(ClassObject clssObj)` Check, if any category of given type is present.
`boolean`	`hasConfigurationCategories()` Returns indication as to whether the object has any associated ConfigurationCategories.
`boolean`	`hasMessageList()` Returns indication as to whether the object has an associated MessageList category.
`boolean`	`hasNameAttribute()` Overrides to return true for any PublicObject, indicating that the instance has a NAME attribute.
`boolean`	`hasPropertyBundleAttribute()` Overrides to return true for any PublicObject, indicating that the instance has a PROPERTYBUNDLE attribute.
`boolean`	`isAttachment(Document doc)` Returns indication as to whether the specified Document is an attachment.
`boolean`	`isDeleted()` isDeleted() - returns true if the object is marked for deletion, false otherwise
`boolean`	`isLatestVersion()` Returns true if this public object is referenced by the lastest VersionDescription in this object's primaryVersionSeries.
`boolean`	`isLocked()` Returns true when the lockobject attribute on this PublicObject is not null
`boolean`	`isLockingSupported()` Return indication as to whether this type supports locking.
`boolean`	`isOwner(DirectoryObject obj)` Returns true if the specified object is the owner of this object.
`boolean`	`isReserved()` Returns true if primaryVersionSeries is currently reserved (by anyone).
`boolean`	`isReservedByCurrentUser()` Returns true if primaryVersionSeries is currently reserved by the current user.
`boolean`	`isVersionable()` Returns true if this class of object is versionable.
`boolean`	`isVersioned()` Returns true if this object is versioned (FAMILY !
`boolean`	`isWorkingCopy()` Returns true if this object is a working copy, which is the PENDINGPUBLICOBJECT of a Family's primary VersionSeries.
`protected Vector`	`listLeftwardRelationships(ClassObject relClass, SortSpecification sortSpec)`
`protected Vector`	`listRightwardRelationships(ClassObject relClass, SortSpecification sortSpec)`
`LockEntry`	`lock(LockEntryDefinition ledef)` Locks this object by adding a LockEntry associated with it.
`void`	`lock(LockObject lockobj)` Sets the value of the lockObject attribute of the object.
`void`	`lock(LockObjectDefinition ldef)` Constructs a new lockobject from the definition and sets it as the value of the lockObject attribute on the PublicObject.
`void`	`lock(SystemLockEntry sle)` Lock the target object by adding an existing SystemLockEntry associated with it.
`VersionDescription`	`newVersion(VersionDescriptionDefinition vddef)` Creates a new VersionDescription at the end of the primary version series.
`protected void`	`postCopy(LibraryObjectDefinition def, PublicObject clone)` Extensibility point to perform actions after the copy of a object.
`protected void`	`postCreate(LibraryObjectDefinition lodef)` Extensibility point to perform actions after the creation of a PublicObject.
`void`	`postSecurityChangedEvent()` Post an event that notes that the security has been changed on an object, forcing all sessions to re-examine whether the target object should be discoverable.
`protected void`	`postUpdate(LibraryObjectDefinition lodef)` Extensibility point to perform actions after the update of a PublicObject.
`protected void`	`preCopy(LibraryObjectDefinition def)` Extensibility point to perform actions prior to the copy of a object.
`protected void`	`preCreate(LibraryObjectDefinition lodef)` Extensibility point to perform actions prior to the creation of a PublicObject.
`protected void`	`preFree(LibraryObjectDefinition def)` Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
`protected void`	`preUpdate(LibraryObjectDefinition lodef)` Extensibility point to perform actions prior to the update of a PublicObject.
`void`	`putPolicy(Policy policy)` Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
`void`	`reassociateLinks(PublicObject newTarget)` Reassociates the Links that are associated with the target object to the specified new target object.
`void`	`removeAllPolicies()` Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
`void`	`removeAttachment(Document doc)` Remove an Attachment.
`void`	`removePolicy(Policy policy)` Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
`void`	`removePolicy(String opname)` Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
`void`	`removeRelationship(Relationship rel)` Frees the specified relationship object that relates two PublicObjects.
`void`	`reserveNext(String contentPath, String comment)` Reserves (locks) the primary version series so a new version can be added.
`void`	`resetFolderReferences()` Clears the locally cached list of Referencing Folders.
`protected SortSpecification`	`resolveFolderReferenceSortSpecification(LibrarySession session)` Forces the SortSpecification (if specified) to be resolved and verified.
`AccessControlEntry`	`revokeAccess(AccessControlEntryDefinition def)` Remove or restrict an AccessControlEntryDefinition for this object.
`void`	`revokeAllAccess()` Removes all AccessControlEntryDefinitions for this object.
`void`	`setAcl(AccessControlList acl)` Sets the AccessControlList for this object.
`void`	`setDescription(String description)` Updates the description of this object.
`void`	`setExpirationDate(Date date)` Updates the expiration date set for this object.
`void`	`setFlags(long flags)` Sets the flags bitmask.
`void`	`setFolderReferencesSortSpecification(SortSpecification sort)` Sets the sort specification used by the getFolderReferences method.
`void`	`setLockEntries(LockEntry[] les)` Sets all LockEntry objects associated with this instance.
`protected void`	`setLockEntrySecurity(LockEntryDefinition def)` Set security for a new LockEntry.
`void`	`setOwner(DirectoryUser owner)` Updates the owner of this object.
`void`	`setOwnerByName(String ownerName)` Updates the Owner of this object.
`void`	`setPolicyBundle(PolicyPropertyBundle bundle)` Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
`void`	`setPolicyLists(PolicyList[] policyLists)` Sets the PolicyLists for this object.
`void`	`setSecuringPublicObject(PublicObject pubobj)` Sets the Public Object that controls our security.
`static PublicObject[]`	`toPublicObjectArray(LibrarySession sess, Long[] ids, PublicObject[] objs)` Constructs a PublicObject array from an array of object IDs.
`void`	`undelete()` cancel "mark delete" status for an object.
`void`	`unlock()` Releases the lock on the object.
`void`	`unlock(LockEntry le)` Release the specified lock on the target object.
`void`	`unlockAll()` Removes all of this object's LockEntry instances.
`void`	`unReserve()` Cancels the reservation on the primary version series.
`void`	`updateFlags(long updatedFlags)` Update flags without causing the modification attributes to change.
`void`	`updateLock(LockObjectDefinition lodef)` Updates the lockobject of this PublicObject with the information in the LockObjectdefinition.
`protected static PublicObject`	`vectorPublicObjectElement(Vector vector, int index)` Returns a PublicObject from a specified Vector of PublicObject and an index.
`protected static PublicObject[]`	`vectorToPublicObjectArray(Vector vector)` Converts a Vector of PublicObject to an array of PublicObject.
`protected void`	`verifyAddRelationshipCapability()` Verify the ability to add a relationship.
`void`	`verifyCapabilities(AccessLevel capabilities)` Verifies that every capability specified by the given AccessLevel is enabled; throws an exception if any of the capabilities are not enabled.
`void`	`verifyCapability(long capability)` Verifies that the given capability is enabled; throws an exception if the capability is not enabled.
`protected void`	`verifyDeleteCapability()` Verify the ability to delete.
`protected void`	`verifyLockCapability(int lockType)` Verify the ability to obtain a lock.
`protected void`	`verifyRemoveRelationshipCapability()` Verify the ability to remove a relationship.
`protected void`	`verifyUnlockCapability(LockEntry le)` Verify the ability to release a lock.
`protected VersionSeries`	`verifyVersionSeries()`

Methods inherited from class oracle.ifs.beans.LibraryObject
added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface
getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable
getTraceLogger, isTraced, trace

- Field Detail
  - CLASS_NAME
```
public static final String CLASS_NAME
```
    This class name for this class. Useful for methods that take a class name argument.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - NAME_ATTRIBUTE
```
public static final String NAME_ATTRIBUTE
```
    The name of this object.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - DESCRIPTION_ATTRIBUTE
```
public static final String DESCRIPTION_ATTRIBUTE
```
    A textual description of this object.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - OWNER_ATTRIBUTE
```
public static final String OWNER_ATTRIBUTE
```
    The DirectoryUser that owns this object.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - ACL_ATTRIBUTE
```
public static final String ACL_ATTRIBUTE
```
    The AccessControlList that secures this object.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - FAMILY_ATTRIBUTE
```
public static final String FAMILY_ATTRIBUTE
```
    The Family to which this object belongs if this object is versioned.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - RESOLVEDPUBLICOBJECT_ATTRIBUTE
```
public static final String RESOLVEDPUBLICOBJECT_ATTRIBUTE
```
    The PublicObject to which this object resolves. Families, VersionSeries, and VersionDescriptions resolve to a specific PublicObject which represents the 'desired version' (e.g. the latest version).
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - CREATEDATE_ATTRIBUTE
```
public static final String CREATEDATE_ATTRIBUTE
```
    The date and time (in GMT) when this object was created.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - CREATOR_ATTRIBUTE
```
public static final String CREATOR_ATTRIBUTE
```
    The DirectoryUser that created this object.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - LASTMODIFYDATE_ATTRIBUTE
```
public static final String LASTMODIFYDATE_ATTRIBUTE
```
    The date and time (in GMT) when this object was last modified.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - LASTMODIFIER_ATTRIBUTE
```
public static final String LASTMODIFIER_ATTRIBUTE
```
    The DirectoryUser that last modified this object.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - DELETOR_ATTRIBUTE
```
public static final String DELETOR_ATTRIBUTE
```
    The DirectoryUser that deleted (not 'Freed') this object. Deletor will be set to null if this object is later undeleted.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - POLICYLISTS_ATTRIBUTE
```
public static final String POLICYLISTS_ATTRIBUTE
```
    The set of PolicyLists explicitly applied to this object.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - POLICYBUNDLE_ATTRIBUTE
```
public static final String POLICYBUNDLE_ATTRIBUTE
```
    Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
    
    The policies that apply specifically to this object.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - PROPERTYBUNDLE_ATTRIBUTE
```
public static final String PROPERTYBUNDLE_ATTRIBUTE
```
    The PropertyBundle associated with this object.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - SECURINGPUBLICOBJECT_ATTRIBUTE
```
public static final String SECURINGPUBLICOBJECT_ATTRIBUTE
```
    A PublicObject from which this object should defer security decisions (e.g, all versions in a Family may have the Family as their securing public object).
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - EXPIRATIONDATE_ATTRIBUTE
```
public static final String EXPIRATIONDATE_ATTRIBUTE
```
    The date when this object 'expires'. ExpirationDate is an advisory attribute. The repository does not act on this attribute.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - LOCKOBJECT_ATTRIBUTE
```
public static final String LOCKOBJECT_ATTRIBUTE
```
    The lock object for this PublicObject. This object encapsulates locking information for the PublicObject
    
    See Also:
    
    LockObject, Constant Field Values
    
    (Published)
  - PRIMARYPARENTFOLDER_ATTRIBUTE
```
public static final String PRIMARYPARENTFOLDER_ATTRIBUTE
```
    The primary parent folder for this PublicObject.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - FLAGS_ATTRIBUTE
```
public static final String FLAGS_ATTRIBUTE
```
    System-set flags of this object.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - LOCKENTRIES_ATTRIBUTE
```
public static final String LOCKENTRIES_ATTRIBUTE
```
    LockEntries for this object.
    
    See Also:
    
    Constant Field Values
    
    (Published)
  - FLAG_NOINFERIOR
```
public static final long FLAG_NOINFERIOR
```
    Flag for IMAP "No Inferior" status (bit 0).
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - FLAG_NOSELECT
```
public static final long FLAG_NOSELECT
```
    Flag for IMAP "No Select" status (bit 1).
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - FLAG_MARKED
```
public static final long FLAG_MARKED
```
    Flag for IMAP "Marked" status (bit 2).
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - FLAG_UNMARKED
```
public static final long FLAG_UNMARKED
```
    Flag for IMAP "Unmarked" status (bit 3).
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - FLAG_NTFS_HIDDEN
```
public static final long FLAG_NTFS_HIDDEN
```
    Flag for SMB/NTFS "hidden" status (bit 4).
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - FLAG_NTFS_SYSTEM
```
public static final long FLAG_NTFS_SYSTEM
```
    Flag for SMB/NTFS "system" status (bit 5).
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - FLAG_NTFS_ARCHIVE
```
public static final long FLAG_NTFS_ARCHIVE
```
    Flag for SMB/NTFS "archive" status (bit 6).
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - FLAG_NTFS_READONLY
```
public static final long FLAG_NTFS_READONLY
```
    Flag for SMB/NTFS "readonly" status (bit 7).
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - FLAG_CATEGORY_EXISTS
```
public static final long FLAG_CATEGORY_EXISTS
```
    Flag that indicates one or more Categories exist (bit 16).
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - FLAG_CONFIGURATIONCATEGORY_EXISTS
```
public static final long FLAG_CONFIGURATIONCATEGORY_EXISTS
```
    Flag that indicates one or more ConfigurationCategories exist (bit 17).
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
- Constructor Detail
  - PublicObject
```
protected PublicObject(LibrarySession session,
                       Long id,
                       Long classId,
                       S_LibraryObjectData data)
                throws IfsException
```
    Constructs a PublicObject object - standard variant.
    
    Parameters:
    
    session - current LibSession
    
    id - the id
    
    classId - the class id
    
    data - the object's data
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
- Method Detail
  - hasNameAttribute
```
public boolean hasNameAttribute()
                         throws IfsException
```
    Overrides to return true for any PublicObject, indicating that the instance has a NAME attribute.
    
    Overrides:
    
    hasNameAttribute in class LibraryObject
    
    Returns:
    
    true
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - hasPropertyBundleAttribute
```
public boolean hasPropertyBundleAttribute()
                                   throws IfsException
```
    Overrides to return true for any PublicObject, indicating that the instance has a PROPERTYBUNDLE attribute.
    
    Overrides:
    
    hasPropertyBundleAttribute in class LibraryObject
    
    Returns:
    
    true
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getDefinitionForSimplePropertyUpdates
```
public LibraryObjectDefinition getDefinitionForSimplePropertyUpdates(boolean updateLastModInfo)
                                                              throws IfsException
```
    Gets the LibraryObjectDefinition to use for adding or removing SimpleProperties to/from the target object.
    
    Overrides:
    
    getDefinitionForSimplePropertyUpdates in class LibraryObject
    
    Parameters:
    
    updateLastModInfo - whether to update the LastModify info of the target object
    
    Returns:
    
    the definition
    
    Throws:
    
    IfsException - if the operation fails
  - getCreateDate
```
public Date getCreateDate()
                   throws IfsException
```
    Returns the date this object was created.
    
    Returns:
    
    Date of creation
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getCreator
```
public DirectoryUser getCreator()
                         throws IfsException
```
    Returns the user that created this object.
    
    Returns:
    
    the creator
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getDeletor
```
public DirectoryUser getDeletor()
                         throws IfsException
```
    Returns the user that deleted this object, or null if the object is not marked for deletion.
    
    Returns:
    
    the deletor
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getLastModifier
```
public DirectoryUser getLastModifier()
                              throws IfsException
```
    Returns the user that last modified this object.
    
    Returns:
    
    the last modifier
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getDescription
```
public String getDescription()
                      throws IfsException
```
    Returns the description of this object.
    
    Returns:
    
    The object description
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setDescription
```
public void setDescription(String description)
                    throws IfsException
```
    Updates the description of this object.
    
    Parameters:
    
    description - New description
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getLastModifyDate
```
public Date getLastModifyDate()
                       throws IfsException
```
    Returns the date this object was last modified
    
    Returns:
    
    Date of modification
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getOwner
```
public DirectoryUser getOwner()
                       throws IfsException
```
    Returns the user that owns the object. The owner automatically has full access to this object.
    
    Returns:
    
    the DirectoryUser that owns this object, or null if this object is not owned.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - isOwner
```
public boolean isOwner(DirectoryObject obj)
                throws IfsException
```
    Returns true if the specified object is the owner of this object. This handles the case where the current session cannot discover the owner, and makes the determination based on the ID of the owner.
    
    Returns:
    
    true if the specified DirectoryObject is the owner of this object; returns false otherwise
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - setOwner
```
public void setOwner(DirectoryUser owner)
              throws IfsException
```
    Updates the owner of this object.
    
    Parameters:
    
    owner - the new owner for the object.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setOwnerByName
```
public void setOwnerByName(String ownerName)
                    throws IfsException
```
    Updates the Owner of this object.
    The owner is specified by name.
    
    Parameters:
    
    ownerName - the owner name
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - setAcl
```
public void setAcl(AccessControlList acl)
            throws IfsException
```
    Sets the AccessControlList for this object.
    
    Parameters:
    
    acl - the AccessControlList setting.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getAcl
```
public AccessControlList getAcl()
                         throws IfsException
```
    Returns this object's AccessControlList.
    Returns null if no AccessControlList was specified.
    
    Returns:
    
    AccessControlList for the object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getSecuringPublicObject
```
public PublicObject getSecuringPublicObject()
                                     throws IfsException
```
    Returns the Public Object that controls this object's security.
    Returns null if no Securing Object was specified.
    
    Returns:
    
    PublicObject that controls this object's security, or null if none
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setSecuringPublicObject
```
public void setSecuringPublicObject(PublicObject pubobj)
                             throws IfsException
```
    Sets the Public Object that controls our security.
    
    Parameters:
    
    pubobj - the PublicObject that controls the security
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addCategory
```
public Category addCategory(CategoryDefinition catdef)
                     throws IfsException
```
    Adds a Category associated with this PublicObject.
    
    Parameters:
    
    catdef - CategoryDefinition that describes the new Category that will be associated with this PublicObject
    
    Returns:
    
    the newly created Category
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - createCategories
```
protected void createCategories(CategoryDefinition[] catDefs)
                         throws IfsException
```
    Creates a set of Category objects associated with this PublicObject, without changing the modify date/modifier on the target object.
    Elements in the specified array may be null (they are skipped).
    
    Parameters:
    
    catDefs - the definitions of the categories to be created
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getCategories
```
public Category[] getCategories(SortSpecification sort)
                         throws IfsException
```
    Returns the associated Category objects. Returns null if no Category objects are associated.
    
    Parameters:
    
    sort - the specification of how the returned Category objects will be sorted
    
    Returns:
    
    array of Category objects associated with the target object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getCategories
```
public Category[] getCategories(ClassObject classobj)
                         throws IfsException
```
    Returns the associated Category objects that are instances of the ClassObject (or one of its subclasses) specified. Returns null if no Category objects are associated.
    
    Parameters:
    
    classobj - the class of Category
    
    Returns:
    
    array of Category objects associated with the target object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getCategory
```
public Category getCategory(ClassObject classobj)
                     throws IfsException
```
    Returns the associated Category object that is an instance of the ClassObject (or one of its subclasses) specified.
    The caller must be certain that no more than one category of the specified class exists, or be satisfied that the first category encountered be returned. Returns null if no Category object of the specified class exist.
    
    Parameters:
    
    classobj - the class of Category
    
    Returns:
    
    the Category associated with the target object, or null if none
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getCategories
```
public Category[] getCategories(ClassObject classobj,
                                SortSpecification sort)
                         throws IfsException
```
    Returns the associated Category objects that are instances of the specified class or a subclass of the specified class. If a null ClassObject is specified, all Categories will be returned. Returns null if no Category objects are associated.
    
    Parameters:
    
    classobj - the class of Category
    
    sort - the specification of how the returned Category objects will be sorted
    
    Returns:
    
    array of Category objects associated with the target object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - hasCategory
```
public boolean hasCategory(ClassObject clssObj)
                    throws IfsException
```
    Check, if any category of given type is present.
    
    Parameters:
    
    clssObj - the class of Category
    
    Returns:
    
    true if there exists at least one instance of a Category matching the specified class
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getFirstCategory
```
public Category getFirstCategory(ClassObject clssObj)
                          throws IfsException
```
    Return the first category of given type, or null.
    
    Parameters:
    
    clssObj - the class of Category
    
    Returns:
    
    the first Category instance for the specified class.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getRelations
```
public Relation[] getRelations()
                        throws IfsException
```
    Gets the set of Relation attached as categories to this object.
    
    Returns:
    
    the attached Relations
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getExpirationDate
```
public Date getExpirationDate()
                       throws IfsException
```
    Returns the expiration date set for this object
    
    Returns:
    
    The expiration date, or null if one is not set
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setExpirationDate
```
public void setExpirationDate(Date date)
                       throws IfsException
```
    Updates the expiration date set for this object. A user must have both Delete and SetAttribute permissions on the object to perform this operation.
    
    Parameters:
    
    date - New expiration date
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getFlags
```
public long getFlags()
              throws IfsException
```
    Gets the flags bitmask. This is used for miscellaneous status bits used by some protocols.
    
    Returns:
    
    the flags value; Returns 0 if no value is specified
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setFlags
```
public void setFlags(long flags)
              throws IfsException
```
    Sets the flags bitmask. This is used for miscellaneous status bits used by some protocols.
    Equivalent to:AttributeValue av = AttributeValue.newAttributeValue(flags); setAttribute(FLAGS_ATTRIBUTE, av);
    
    Parameters:
    
    flags - the flags value.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - updateFlags
```
public void updateFlags(long updatedFlags)
                 throws IfsException
```
    Update flags without causing the modification attributes to change.
    
    Parameters:
    
    updatedFlags - the updated value of the flags attribute
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - addFlags
```
public void addFlags(long addedFlags)
              throws IfsException
```
    Adds flags to the exist value of the FLAGS attribute, without causing the modification attributes to change.
    This assumes that a transaction context has been established.
    
    Parameters:
    
    addedFlags - the added flags
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - clearFlags
```
public void clearFlags(long clearedFlags)
                throws IfsException
```
    Clears flags from the exist value of the FLAGS attribute, without causing the modification attributes to change.
    This assumes that a transaction context has been established.
    
    Parameters:
    
    clearedFlags - the cleared flags
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getLockEntries
```
public LockEntry[] getLockEntries()
                           throws IfsException
```
    Returns all LockEntry objects associated with this instance.
    
    Returns:
    
    array of associated LockEntry objects
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getLockEntries
```
public LockEntry[] getLockEntries(boolean includeFamily)
                           throws IfsException
```
    Returns the LockEntry instances that have been applied to this object, optionally including the LockEntry instances that have been applied to this object's Family, if this object has a Family.
    
    Parameters:
    
    includeFamily - whether to include this Document's Family's LockEntry instances, if this object has a Family
    
    Returns:
    
    the LockEntry instances that have been applied.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setLockEntries
```
public void setLockEntries(LockEntry[] les)
                    throws IfsException
```
    Sets all LockEntry objects associated with this instance.
    
    Parameters:
    
    les - array of associated LockEntry objects
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getLockObject
```
public LockObject getLockObject()
                         throws IfsException
```
    Returns the lock object of this object.
    
    Returns:
    
    The lock object or null if object is unlocked
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - isLocked
```
public boolean isLocked()
                 throws IfsException
```
    Returns true when the lockobject attribute on this PublicObject is not null
    
    Returns:
    
    true if the object is locked
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - lock
```
public void lock(LockObject lockobj)
          throws IfsException
```
    Sets the value of the lockObject attribute of the object.
    A user must have setAttribute permission on the object to perform this operation.
    Use this variant of lock for sharing locks. The rules for sharing locks are as follows
    - User Locks can only be shared if the LockHolder of the lockObject is same as current user.
    - Session Locks can only be shared if the LockedForSession id of the LockObject is same as the current session id.
    - Soft and Hard locks can be shared if the user has accesslevel_lock permission bit and the update permission bit in the ACL of the PublicObject that invoked this method
    see JavaDoc for LockObject for details on different lockstates
    Repository provides two instances of SystemLockObject out-of-the-box which map to a "Soft" and "Hard" lock respectively. They can be queried by name from the session's SystemLockObjectCollection. Use these objects to acquire a simple "Soft" or "Hard" lock.
    Parameters:
    
    lockobj - The lockobject to be used for locking the PublicObject
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - lock
```
public void lock(LockObjectDefinition ldef)
          throws IfsException
```
    Constructs a new lockobject from the definition and sets it as the value of the lockObject attribute on the PublicObject.
    A user must have SetAttribute permissions on the object to perform this operation.
    See JavaDoc on LockObject for details on different lockstates.
    
    Parameters:
    
    ldef - The lockobject definition for the lock
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - updateLock
```
public void updateLock(LockObjectDefinition lodef)
                throws IfsException
```
    Updates the lockobject of this PublicObject with the information in the LockObjectdefinition.
    The rules are as follows:
    - User and Session Locks can only be modified by the lockholder of the UserLock and the Session that holds the session lock respectively
    - Modifying soft and hard locks require the accesslevel_lock permission bit and the update permission bit in the ACL of the PublicObject that invoked this method
    The only attribute that is updateable is the LockTimeOut
    Parameters:
    
    lodef - LockObjectDefinition with updated attributes
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - unlock
```
public void unlock()
            throws IfsException
```
    Releases the lock on the object.
    A user must have SetAttribute permissions on the object to perform this operation. This will set the LockObject attribute on PublicObject to null.
    see JavaDoc for LockObject for details on unlocking PublicObjects in different LockStates.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - canAcquireManualLock
```
public boolean canAcquireManualLock()
                             throws IfsException
```
    Returns whether a LockEntry of type LibraryConstants.LOCKTYPE_MANUAL can be acquired for this object by the current user.
    Returns true if all of the following conditions are true:
    - the current user has the LOCK capability for this object (ECM only)
    - there is no existing MANUAL lock on this object
    Subclasses can impose further restrictions.
    Returns:
    
    true if a MANUAL lock can be acquired on this object by the current user.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - canReleaseManualLock
```
public boolean canReleaseManualLock()
                             throws IfsException
```
    Returns whether a LockEntry of type LibraryConstants.LOCKTYPE_MANUAL can be released from this object by the current user.
    Returns true if this object has a MANUAL lock and at least one of the following conditions are true:
    - this object is currently being freed
    - the current session is in LibrarySession.EXECUTIONMODE_ADMINISTRATION
    - the current user has the AdministerWorkspace capability (ECM only)
    - the current user is the owner of the MANUAL lock
    Returns:
    
    true if this object has a MANUAL lock that can be released by the current user.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - canReleaseDavLock
```
public boolean canReleaseDavLock()
                          throws IfsException
```
    Returns whether a LockEntry of type LibraryConstants.LOCKTYPE_DAV can be released from this object by the current user.
    Returns true if this object has a DAV lock and at least one of the following conditions are true:
    - this object is currently being freed
    - the current session is in LibrarySession.EXECUTIONMODE_ADMINISTRATION
    - the current user has the AdministerWorkspace capability (ECM only)
    - the current user is the owner of the DAV lock
    Returns:
    
    true if this object has a MANUAL lock that can be released by the current user.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - canReleaseLock
```
protected boolean canReleaseLock(LockEntry existingLock)
                          throws IfsException
```
    Returns whether the given existing LockEntry can be released from this object by the current user.
    Returns true if the given existing LockEntry is not null and at least one of the following conditions are true:
    - this object is currently being freed
    - the current session is in LibrarySession.EXECUTIONMODE_ADMINISTRATION
    - the current user has the AdministerWorkspace capability
    - the current user is the owner of the existing LockEntry
    Parameters:
    
    existingLock - the LockEntry to check if can be released.
    
    Returns:
    
    true if the given existing LockEntry can be released by the current user.
    
    Throws:
    
    IfsException - if the operation fails
  - lock
```
public LockEntry lock(LockEntryDefinition ledef)
               throws IfsException
```
    Locks this object by adding a LockEntry associated with it.
    
    Parameters:
    
    ledef - the definition of the new LockEntry.
    
    Returns:
    
    the new LockEntry.
    
    Throws:
    
    IfsException - if the operation fails
  - lock
```
public void lock(SystemLockEntry sle)
          throws IfsException
```
    Lock the target object by adding an existing SystemLockEntry associated with it.
    
    Parameters:
    
    sle - the SystemLockEntry to apply.
    
    Throws:
    
    IfsException - if the operation fails
  - unlock
```
public void unlock(LockEntry le)
            throws IfsException
```
    Release the specified lock on the target object.
    
    Parameters:
    
    le - the LockEntry to remove from the target object.
    
    Throws:
    
    IfsException - if the operation fails
  - unlockAll
```
public void unlockAll()
               throws IfsException
```
    Removes all of this object's LockEntry instances.
    NOTE: this should not be called directly. It is called as a side-effect of a delete operation.
    
    Throws:
    
    IfsException - if the operation fails
  - verifyLockCapability
```
protected void verifyLockCapability(int lockType)
                             throws IfsException
```
    Verify the ability to obtain a lock.
    
    Parameters:
    
    lockType - the lock type for the new LockEntry.
    
    Throws:
    
    IfsException - if the operation fails
  - verifyUnlockCapability
```
protected void verifyUnlockCapability(LockEntry le)
                               throws IfsException
```
    Verify the ability to release a lock.
    
    Parameters:
    
    le - the LockEntry being released
    
    Throws:
    
    IfsException - if the operation fails
  - setLockEntrySecurity
```
protected void setLockEntrySecurity(LockEntryDefinition def)
                             throws IfsException
```
    Set security for a new LockEntry.
    
    Parameters:
    
    def - the definition of the new LockEntry.
    
    Throws:
    
    IfsException - if the operation fails
  - containsLockEntry
```
public boolean containsLockEntry(LockEntry le)
                          throws IfsException
```
    Checks if the specified LockEntry is contained in this instance's set of LockEntries.
    
    Parameters:
    
    le - the LockEntry to look for
    
    Returns:
    
    true if the LockEntry is in the array; false otherwise
    
    Throws:
    
    IfsException - if the operation fails
  - handleUnlockAll
```
protected void handleUnlockAll()
                        throws IfsException
```
    Provides a template for subclasses to specify additional logic for the unlockAll() operation.
    
    Throws:
    
    IfsException - if the operation fails
  - isLockingSupported
```
public boolean isLockingSupported()
```
    Return indication as to whether this type supports locking.
    Returns true, but can be overridden by subclasses that do not support locking (e.g. by Folder)
    
    Returns:
    
    indication as to whether this type supports locking
  - getLockRestrictions
```
public AccessLevel getLockRestrictions()
                                throws IfsException
```
    Gets the set of lock restrictions for the current user.
    
    Returns:
    
    the set of lock restrictions for the user
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getRestrictingLockEntries
```
public LockEntry[] getRestrictingLockEntries(AccessLevel level)
                                      throws IfsException
```
    Gets the set of lock entries that result in restricting the specified access for the current user.
    
    Parameters:
    
    level - specified level
    
    Returns:
    
    the set of lock entries that restrict that level for the current user
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - checkLockAccess
```
public boolean checkLockAccess(AccessLevel level)
                        throws IfsException
```
    Checks to see if current user is locked from the specified access level on this object.
    
    Parameters:
    
    level - specified level
    
    Returns:
    
    true if current user has at least the specified access, false if the user is locked from the specified access
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - capabilities
```
public PublicObjectCapabilities capabilities()
```
    Returns the PublicObjectCapabilities delegate which tracks the capabilities of this object.
    
    Returns:
    
    the instance of PublicObjectCapabilities for this object.
  - getCapabilities
```
public AccessLevel getCapabilities()
                            throws IfsException
```
    Returns the enabled capabilities for this object.
    To determine the set of enabled capabilities, this method checks:
    1. access (permission)
    2. lock restriction
    3. object type or configuration
    Returns:
    
    the enabled capabilities as an AccessLevel.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - checkCapability
```
public boolean checkCapability(long capability)
                        throws IfsException
```
    Checks if the given capability is enabled for this object.
    To determine the set of enabled capabilities, this method checks:
    1. access (permission)
    2. lock restriction
    3. object type or configuration
    Parameters:
    
    capability - the capability to check.
    
    Returns:
    
    true if the given capability is enabled; false otherwise
    
    Throws:
    
    IfsException - if the operation otherwise fails
    
    (Published)
  - checkCapabilities
```
public boolean checkCapabilities(AccessLevel capabilities)
                          throws IfsException
```
    Checks if the given capabilities are enabled for this object.
    To determine the set of enabled capabilities, this method checks:
    1. access (permission)
    2. lock restriction
    3. object type or configuration
    Parameters:
    
    capabilities - the capabilities to check.
    
    Returns:
    
    true if the specified capabilities are enabled; false otherwise
    
    Throws:
    
    IfsException - if the operation otherwise fails
  - verifyCapability
```
public void verifyCapability(long capability)
                      throws IfsException
```
    Verifies that the given capability is enabled; throws an exception if the capability is not enabled.
    This method verifies:
    1. access (permission)
    2. lock restriction
    3. object type or configuration
    Parameters:
    
    capability - the capability to verify.
    
    Throws:
    
    IfsException -
    90400: if the capability is not enabled because of insufficient access (permissions)
    90700: if the capability is not enabled because of a lock restriction
    90703: if the capability is not enabled because of the object type or its configuration
    90002: if an error occurs invoking the specific capability check method
    other: if the operation otherwise fails
  - verifyCapabilities
```
public void verifyCapabilities(AccessLevel capabilities)
                        throws IfsException
```
    Verifies that every capability specified by the given AccessLevel is enabled; throws an exception if any of the capabilities are not enabled.
    This method verifies:
    1. access (permission)
    2. lock restriction
    3. object type or configuration
    Parameters:
    
    capabilities - the set of capabilities (an AccessLevel) to verify.
    
    Throws:
    
    IfsException -
    90400: if the capability is not enabled because of insufficient access (permissions)
    90700: if the capability is not enabled because of a lock restriction
    90703: if the capability is not enabled because of the object type or its configuration
    90002: if an error occurs invoking a specific capability check method
    other: if the operation fails
  - checkAuditViewCapability
```
public boolean checkAuditViewCapability()
                                 throws IfsException
```
    Checks if user can view audit information for this object.
    Override base class to check CAPABILITY_GETAUDITHISTORY.
    
    Returns:
    
    true if the current user can view audit info
    
    Throws:
    
    IfsException - if the operation fails
  - verifyDeleteCapability
```
protected void verifyDeleteCapability()
                               throws IfsException
```
    Verify the ability to delete.
    
    Throws:
    
    IfsException - if the operation fails
  - auditPublicObjectLocked
```
protected void auditPublicObjectLocked(int lockType)
                                throws IfsException
```
    Audits a PublicObject being locked.
    
    Parameters:
    
    lockType - the lock type
    
    Throws:
    
    IfsException - if the operation fails
  - auditPublicObjectUnlocked
```
protected void auditPublicObjectUnlocked(int lockType)
                                  throws IfsException
```
    Audits a PublicObject being unlocked.
    
    Parameters:
    
    lockType - the lock type
    
    Throws:
    
    IfsException - if the operation fails
  - getLockTypeAuditProperties
```
protected AttributeValue[] getLockTypeAuditProperties(int lockType)
                                               throws IfsException
```
    Gets the audit event properties to add that describe a Lock type.
    
    Parameters:
    
    lockType - the lock type
    
    Returns:
    
    the properties to add for a lock/unlock event
    
    Throws:
    
    IfsException - if the operation fails
  - deriveEffectiveAccessLevel
```
public void deriveEffectiveAccessLevel(AccessLevel level)
                                throws IfsException
```
    Modify the AccessLevel specified to enable or disable effective permissions for this object.
    This is overridden to add permissions based on the target object and other permissions defined on the specified level.
    
    Parameters:
    
    level - the current permissions for the requesting user on the target object.
    
    Throws:
    
    IfsException - if the operation fails
  - setPolicyLists
```
public void setPolicyLists(PolicyList[] policyLists)
                    throws IfsException
```
    Sets the PolicyLists for this object.
    
    Parameters:
    
    policyLists - the PolicyList objects to apply
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getPolicyLists
```
public PolicyList[] getPolicyLists()
                            throws IfsException
```
    Gets the PolicyLists for this object.
    
    Returns:
    
    the PolicyList
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - putPolicy
```
public void putPolicy(Policy policy)
               throws IfsException
```
    Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
    
    Adds a Policy to this object's PolicyPropertyBundle. Creates a new PolicyPropertyBundle if one does not already exist.
    
    Parameters:
    
    policy - the Policy to add
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - removePolicy
```
public void removePolicy(String opname)
                  throws IfsException
```
    Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
    
    Removes a Policy from this object's PolicyPropertyBundle.
    
    Parameters:
    
    opname - the operation name of the policy to remove
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - removePolicy
```
public void removePolicy(Policy policy)
                  throws IfsException
```
    Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
    
    Removes a Policy from this object's PolicyPropertyBundle.
    
    Parameters:
    
    policy - the operation name of the policy to remove
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - removeAllPolicies
```
public void removeAllPolicies()
                       throws IfsException
```
    Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
    
    Removes all Policies from this object's PolicyPropertyBundle, leaving an empty PolicyPropertyBundle.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setPolicyBundle
```
public void setPolicyBundle(PolicyPropertyBundle bundle)
                     throws IfsException
```
    Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
    
    Sets the PolicyPropertyBundle for this object, for the managing of per-instance Policies.
    
    Parameters:
    
    bundle - the PolicyPropertyBundle setting.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getPolicyBundle
```
public PolicyPropertyBundle getPolicyBundle()
                                     throws IfsException
```
    Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
    
    Returns this object's PolicyPropertyBundle. Return null if no Policies are specified.
    
    Returns:
    
    PolicyPropertyBundle for the object.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getPrimaryParentFolder
```
public Folder getPrimaryParentFolder()
                              throws IfsException
```
    Gets the primary parent folder for the object. The primary folder is the folder that has contained this object for the longest time.
    
    Returns:
    
    the primary parent folder
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getPrimaryParentFolder
```
public Folder getPrimaryParentFolder(boolean useFamily)
                              throws IfsException
```
    Gets the primary parent folder for the object.
    Same as the zero-argument variant, but uses the target object's Family's path if the target object is not foldered.
    
    Parameters:
    
    useFamily - whether Family's path should be used if target is unfoldered
    
    Returns:
    
    the primary parent folder
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getPrimaryFolderPath
```
public String getPrimaryFolderPath()
                            throws IfsException
```
    Gets the primary path to the object, using the PRIMARYPARENTFOLDER attribute of the target object and the referencing folders above it in the folder hierarchy. This will return null if the target object does not have a path to it.
    
    Returns:
    
    the primary path to the target object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getAnyFolderPath
```
public String getAnyFolderPath()
                        throws IfsException
```
    Gets any Folder path to the target object, starting from the Root Folder. If no reachable path exists, return null. This method will only return a path that the requesting user would be able to traverse. The user must have at least the Discover permission on all of the Folders in the path.
    
    Returns:
    
    a Folder path to the target object or null if no reachable path exists.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getAnyFolderPath
```
public String getAnyFolderPath(Folder reference)
                        throws IfsException
```
    Gets any Folder path to the target object. If no reachable path exists, return null.
    
    Returns:
    
    a Folder path to the target object or null if no reachable path exists.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getAnyFolderPath
```
public String getAnyFolderPath(Folder reference,
                               FolderPathOptions fpo)
                        throws IfsException
```
    Gets any Folder path to the target object. If no reachable path exists, return null.
    
    Parameters:
    
    reference - The folder representing the top node of the desired paths
    
    fpo - Options describing the path determination operation; optional; if null is specified, default beahvior will be in force
    
    Returns:
    
    a Folder path to the target object or null if no reachable path exists
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getConsumedStorage
```
public long getConsumedStorage()
                        throws IfsException
```
    Returns the storage (in bytes) consumed by the content of this object. This is overridden by subclasses to do aggregations if necessary. (For eg., Folder) PublicObjects that do not have any content associated with them directly or indirectly, return 0 for consumed storage.
    
    Returns:
    
    storage consumed by content directly associated with this object (e.g. DOCUMENT instances) or indirectly associated with this object (e.g. FAMILY and FOLDER instances)
    
    Throws:
    
    IfsException - if the operation fails
  - getAllFolderPaths
```
public String[] getAllFolderPaths()
                           throws IfsException
```
    Gets all Folder paths to the target object, starting from the Root Folder. If no reachable path exists, return null.
    
    Returns:
    
    all Folder paths to the target object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getAllFolderPaths
```
public String[] getAllFolderPaths(Folder reference)
                           throws IfsException
```
    Gets all Folder paths to the target object. If no reachable paths exists, return null.
    
    Returns:
    
    all Folder paths to the target object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getAllFolderPaths
```
public String[] getAllFolderPaths(Folder reference,
                                  FolderPathOptions fpo)
                           throws IfsException
```
    Gets all Folder paths to the target object. If no reachable paths exists, return null.
    
    Parameters:
    
    reference - The folder representing the top node of the desired paths
    
    fpo - Options describing the path determination operation; optional; if null is specified, default beahvior will be in force
    
    Returns:
    
    all Folder paths to the target object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getFolderReferencesSortSpecification
```
public SortSpecification getFolderReferencesSortSpecification()
                                                       throws IfsException
```
    Returns the current sort specification used by the getFolderReferences method.
    
    Returns:
    
    the folder references sort specification
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - setFolderReferencesSortSpecification
```
public void setFolderReferencesSortSpecification(SortSpecification sort)
                                          throws IfsException
```
    Sets the sort specification used by the getFolderReferences method.
    
    Parameters:
    
    sort - the folder references sort specification.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getFolderReferences
```
public Folder[] getFolderReferences()
                             throws IfsException
```
    Returns an array of folders that reference this PublicObject.
    
    Returns:
    
    array of Folders that reference this object
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - getFolderReferences
```
public Folder getFolderReferences(int index)
                           throws IfsException
```
    Returns the Folder at specified index in the array of ReferencingFolders. Calling this method creates an internal cache of the results which is not automatically updated.
    
    Parameters:
    
    index - index into the array of referencing folders
    
    Returns:
    
    the requested Folder
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - resetFolderReferences
```
public void resetFolderReferences()
                           throws IfsException
```
    Clears the locally cached list of Referencing Folders. This must be called to force a new array of getFolderReferences to be fetched from the server.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getLinks
```
public Link[] getLinks()
                throws IfsException
```
    Gets all Link objects that refer to this PublicObject.
    
    Returns:
    
    set of Link objects that refer to this instance
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - reassociateLinks
```
public void reassociateLinks(PublicObject newTarget)
                      throws IfsException
```
    Reassociates the Links that are associated with the target object to the specified new target object.
    
    Parameters:
    
    newTarget - new target object for the current set of links to this object
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - getCategories
```
public Category[] getCategories()
                         throws IfsException
```
    Returns an array of categories for this PublicObject.
    
    Returns:
    
    array of categories for this object.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Published)
  - getCategories
```
public Category getCategories(int index)
                       throws IfsException
```
    Returns the Category at specified index in the array of all Categories.
    
    Parameters:
    
    index - index into the array of categories
    
    Returns:
    
    the requested Category
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - preCreate
```
protected void preCreate(LibraryObjectDefinition lodef)
                  throws IfsException
```
    Extensibility point to perform actions prior to the creation of a PublicObject.
    Set an option that indicates that Categories are NOT to be created from within S_PublicObject.
    
    Overrides:
    
    preCreate in class LibraryObject
    
    Parameters:
    
    lodef - object definition that will be used to create the object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - handleCreate
```
protected PublicObject handleCreate(LibraryObjectDefinition lodef)
                             throws IfsException
```
    Handles the low-level creation of the PublicObject
    
    Parameters:
    
    lodef - object definition that will be used to create the object
    
    Returns:
    
    the object created (typically the target object)
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - postCreate
```
protected void postCreate(LibraryObjectDefinition lodef)
                   throws IfsException
```
    Extensibility point to perform actions after the creation of a PublicObject.
    This assumes that a transaction context has already been established.
    
    Overrides:
    
    postCreate in class LibraryObject
    
    Parameters:
    
    lodef - object definition that was used to create the object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - preUpdate
```
protected void preUpdate(LibraryObjectDefinition lodef)
                  throws IfsException
```
    Extensibility point to perform actions prior to the update of a PublicObject.
    Set an option that indicates that Categories are NOT to be created from within S_PublicObject.
    
    Overrides:
    
    preUpdate in class LibraryObject
    
    Parameters:
    
    lodef - object definition used to define how the target object will be updated
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - postUpdate
```
protected void postUpdate(LibraryObjectDefinition lodef)
                   throws IfsException
```
    Extensibility point to perform actions after the update of a PublicObject.
    Create any categories that are specified in the definition.
    
    Overrides:
    
    postUpdate in class LibraryObject
    
    Parameters:
    
    lodef - object definition used to define how the target object was updated
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - preFree
```
protected void preFree(LibraryObjectDefinition def)
                throws IfsException
```
    Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
    Override to free all existing categories, in such a way that the PO doesn't get updated for each category free.
    
    Overrides:
    
    preFree in class LibraryObject
    
    Parameters:
    
    def - object definition used to hold options related to the free operation
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - free
```
public void free(LibraryObjectDefinition def)
          throws IfsException
```
    Permanently removes this object from the repository, with options.
    If a null definition is specified, a default definition is used.
    
    Overrides:
    
    free in class LibraryObject
    
    Parameters:
    
    def - Context for the free operation.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - checkParentFolderCapability
```
protected void checkParentFolderCapability(PublicObjectDefinition poDef)
                                    throws IfsException
```
    Check ADDITEM capability on a new parent folder, if one is specified.
    
    Parameters:
    
    poDef - object definition
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - coreAutoFolderingEnabled
```
protected boolean coreAutoFolderingEnabled()
                                    throws IfsException
```
    Extensibility point to see if core AutoFoldering is enabled.
    Applications (e.g. ECM) may overrides this if they process this differently.
    
    Returns:
    
    true if core AutoFoldering is enabled
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - copy
```
public PublicObject copy(LibraryObjectDefinition def)
                  throws IfsException
```
    Produces a copy of this PublicObject. Applies the optionally specified definition to the new object.
    
    Parameters:
    
    def - Definition describing changes to the new object, or null for exact copy.
    
    Returns:
    
    a copy of the target object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - preCopy
```
protected void preCopy(LibraryObjectDefinition def)
                throws IfsException
```
    Extensibility point to perform actions prior to the copy of a object.
    This method is typically overridden by subclasses that perform other operations prior to the target object being copied. Subclasses are expected to invoke super.preCopy.
    
    Parameters:
    
    def - object definition used to define how the target object will be copied
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - handleCopy
```
protected PublicObject handleCopy(LibraryObjectDefinition def)
                           throws IfsException
```
    Handle the low-level repository copy
    
    Parameters:
    
    def - the LibraryObjectDefinition describing the desired copy
    
    Returns:
    
    the copied object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - postCopy
```
protected void postCopy(LibraryObjectDefinition def,
                        PublicObject clone)
                 throws IfsException
```
    Extensibility point to perform actions after the copy of a object.
    This method is typically overridden by subclasses that perform other operations after the target object is copied. Subclasses are expected to invoke super.postCopy.
    
    Parameters:
    
    def - object definition used to define how the target object was copied
    
    clone - the copied object
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - addRelationship
```
public Relationship addRelationship(RelationshipDefinition reldef)
                             throws IfsException
```
    Creates a relationship object linking this object (the "left" object) to the PublicObject (the "right" object) contained in the specified Relationship Definition.
    
    Parameters:
    
    reldef - Describes the new Relationship object, including the PublicObject to which this object will be related
    
    Returns:
    
    the newly created Relationship object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - removeRelationship
```
public void removeRelationship(Relationship rel)
                        throws IfsException
```
    Frees the specified relationship object that relates two PublicObjects.
    
    Parameters:
    
    rel - the relationship object to be removed
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - verifyAddRelationshipCapability
```
protected void verifyAddRelationshipCapability()
                                        throws IfsException
```
    Verify the ability to add a relationship.
    
    Throws:
    
    IfsException - if the operation fails
  - verifyRemoveRelationshipCapability
```
protected void verifyRemoveRelationshipCapability()
                                           throws IfsException
```
    Verify the ability to remove a relationship.
    
    Throws:
    
    IfsException - if the operation fails
  - getRightwardRelationshipObjects
```
public PublicObject[] getRightwardRelationshipObjects(String relClassName)
                                               throws IfsException
```
    Returns all "right side" public objects that are related to this object by the specified Relationship Class. The Relationship class is specified by name.
    
    Parameters:
    
    relClassName - the class name of the Relationship (or descendant of Relationship) on which to filter
    
    Returns:
    
    an array of related PublicObjects
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getRightwardRelationshipObjects
```
public PublicObject[] getRightwardRelationshipObjects(ClassObject relClass)
                                               throws IfsException
```
    Returns all "right side" public objects that are related to this object by the specified Relationship Class. The Relationship class is specified by ClassObject
    
    Parameters:
    
    relClass - the Relationship class (or descendant of Relationship) on which to filter
    
    Returns:
    
    an array of related PublicObjects
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getLeftwardRelationshipObjects
```
public PublicObject[] getLeftwardRelationshipObjects(String relClassName)
                                              throws IfsException
```
    Returns all "left side" public objects that are related to this object by the specied Relationship Class. The filtering relationship class is specified by name.
    
    Parameters:
    
    relClassName - the class name of the Relationship (or descendant of Relationship) on which to filter.
    
    Returns:
    
    an array of related PublicObjects
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getLeftwardRelationshipObjects
```
public PublicObject[] getLeftwardRelationshipObjects(ClassObject relClass)
                                              throws IfsException
```
    Returns all "left side" public objects that are related to this object by the specied Relationship Class. The filtering relationship class is specified by ClassObject
    
    Parameters:
    
    relClass - the Relationship class (or descendant of Relationship) on which to filter.
    
    Returns:
    
    an array of related PublicObjects
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getRightwardRelationships
```
public Relationship[] getRightwardRelationships(String relClassName)
                                         throws IfsException
```
    Returns all "right side" relationship instances that are used to relate to this object to other PublicObjects. The Filtering Relationship class is specified by name.
    
    Parameters:
    
    relClassName - the class name of the Relationship (or descendant of Relationship) on which to filter.
    
    Returns:
    
    an array of Relationship objects
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getRightwardRelationships
```
public Relationship[] getRightwardRelationships(ClassObject relClass)
                                         throws IfsException
```
    Returns all "right side" relationship instances that are used to relate to this object to other PublicObjects. The Filtering Relationship class is specified by ClassObject.
    
    Parameters:
    
    relClass - the Relationship class (or descendant of Relationship) on which to filter.
    
    Returns:
    
    an array of Relationship objects
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getLeftwardRelationships
```
public Relationship[] getLeftwardRelationships(String relClassName)
                                        throws IfsException
```
    Returns all "left side" relationship instances that are used to relate to this object to other PublicObjects. The Filtering Relationship class is specified by name.
    
    Parameters:
    
    relClassName - the class name of the Relationship (or descendant of Relationship) on which to filter.
    
    Returns:
    
    an array of Relationship objects
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getLeftwardRelationships
```
public Relationship[] getLeftwardRelationships(ClassObject relClass)
                                        throws IfsException
```
    Returns all "left side" relationship instances that are used to relate to this object to other PublicObjects. The Filtering Relationship class is specified by ClassObject.
    
    Parameters:
    
    relClass - the Relationship class (or descendant of Relationship) on which to filter.
    
    Returns:
    
    an array of Relationship objects
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getLeftwardRelationshipsCount
```
public long getLeftwardRelationshipsCount(String relClassName)
                                   throws IfsException
```
    Returns the count of all "left side" relationship instances that are used to relate to this object to other PublicObjects. The Relationship class is specified by name.
    
    Parameters:
    
    relClassName - the name of the class of relationship on which to filter.
    
    Returns:
    
    count of existing Relationship objects
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getLeftwardRelationshipsCount
```
public long getLeftwardRelationshipsCount(ClassObject relClass)
                                   throws IfsException
```
    Returns the count of all "left side" relationship instances that are used to relate to this object to other PublicObjects. The Relationship class is specified by ClassObject.
    
    Parameters:
    
    relClass - the class of relationship on which to filter
    
    Returns:
    
    count of existing Relationship objects
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getAttachments
```
public Document[] getAttachments()
                          throws IfsException
```
    Get the attached Documents.
    
    Returns:
    
    the Documents that comprise the set of attachments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getAttachmentRelations
```
public AttachmentRelation[] getAttachmentRelations()
                                            throws IfsException
```
    Get the AttachmentRelations that comprise the set of attachments.
    
    Returns:
    
    the AttachmentRelations representing the attachments
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addAttachment
```
public AttachmentRelation addAttachment(Document doc)
                                 throws IfsException
```
    Add an Attachment.
    
    Parameters:
    
    doc - the Attachment to add
    
    Returns:
    
    the newly created AttachmentRelation
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - removeAttachment
```
public void removeAttachment(Document doc)
                      throws IfsException
```
    Remove an Attachment.
    
    Parameters:
    
    doc - the Document to remove as an aattachment (assuming it is an Attachment)
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - isAttachment
```
public boolean isAttachment(Document doc)
                     throws IfsException
```
    Returns indication as to whether the specified Document is an attachment.
    
    Parameters:
    
    doc - the Document to check
    
    Returns:
    
    true if the specified Document is an attachment; false otherwise
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - findAttachmentRelation
```
public AttachmentRelation findAttachmentRelation(Document doc)
                                          throws IfsException
```
    Find an AttachmentRelation that corresponds to an attached Document.
    
    Parameters:
    
    doc - the Document to look for
    
    Returns:
    
    the corresponding AttachmentRelation, or null if the specified Document is not an attachment
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - findOrAddMessageList
```
public MessageList findOrAddMessageList()
                                 throws IfsException
```
    Add a MessageList to the target object if one does not already exist, and otherwise return the existing instance.
    Uses a default MessageListDefinition.
    
    Returns:
    
    the existing or newly created MessageList
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - findOrAddMessageList
```
public MessageList findOrAddMessageList(MessageListDefinition def)
                                 throws IfsException
```
    Add a MessageList to the target object if one does not already exist, and otherwise return the existing instance.
    
    Parameters:
    
    def - the definition to use if a new instance is created
    
    Returns:
    
    the existing or newly created MessageList
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addMessageList
```
public MessageList addMessageList()
                           throws IfsException
```
    Deprecated. 9.2.4: use findOrAddMessageList
    
    Add a MessageList.
    
    Returns:
    
    the newly created MessageList
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - findOrAddActor
```
public Actor findOrAddActor()
                     throws IfsException
```
    Add an Actor to the target object if one does not already exist, and otherwise return the existing instance.
    Uses a default ActorDefinition.
    
    Returns:
    
    the existing or newly created Actor
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - findOrAddActor
```
public Actor findOrAddActor(ActorDefinition def)
                     throws IfsException
```
    Add an Actor to the target object if one does not already exist, and otherwise return the existing instance.
    
    Parameters:
    
    def - the definition to use if a new instance is created
    
    Returns:
    
    the existing or newly created Actor
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - findOrAddActivityRecord
```
public ActivityRecord findOrAddActivityRecord()
                                       throws IfsException
```
    Add an ActivityRecord to the target object if one does not already exist, and otherwise return the existing instance.
    Uses a default ActivityRecordDefinition.
    
    Returns:
    
    the existing or newly created ActivityRecord
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - findOrAddActivityRecord
```
public ActivityRecord findOrAddActivityRecord(ActivityRecordDefinition def)
                                       throws IfsException
```
    Add an ActivityRecord to the target object if one does not already exist, and otherwise return the existing instance.
    
    Parameters:
    
    def - the definition to use if a new instance is created
    
    Returns:
    
    the existing or newly created ActivityRecord
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - reserveNext
```
public void reserveNext(String contentPath,
                        String comment)
                 throws IfsException
```
    Reserves (locks) the primary version series so a new version can be added. A reserved version series cannot be deleted. newVersion() or unReserve() will unlock the version series.
    
    Parameters:
    
    contentPath - the path of the local work file. This is saved with the version series as a convenience, but is not used.
    
    comment - Reservation comment.
    
    Throws:
    
    IfsException - if the operation fails
    
    See Also:
    
    VersionSeries
    
    (Unpublished)
  - unReserve
```
public void unReserve()
               throws IfsException
```
    Cancels the reservation on the primary version series.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - newVersion
```
public VersionDescription newVersion(VersionDescriptionDefinition vddef)
                              throws IfsException
```
    Creates a new VersionDescription at the end of the primary version series. This may result in a new PublicObject depending on the contents of VersionDescriptionDefinition.
    
    Parameters:
    
    vddef - The VersionDescriptionDefinition describing the desired new version.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - isReserved
```
public boolean isReserved()
                   throws IfsException
```
    Returns true if primaryVersionSeries is currently reserved (by anyone).
    
    Returns:
    
    true if primaryVersionSeries is currently reserved
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - isReservedByCurrentUser
```
public boolean isReservedByCurrentUser()
                                throws IfsException
```
    Returns true if primaryVersionSeries is currently reserved by the current user.
    
    Returns:
    
    true if primaryVersionSeries is currently reserved
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getReservor
```
public DirectoryUser getReservor()
                          throws IfsException
```
    Returns the user that has reserved the primaryVersionSeries for this object.
    
    Returns:
    
    the user that has reserved the primaryVersionSeries for this object
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getReservationDate
```
public Date getReservationDate()
                        throws IfsException
```
    Returns the Date on which this object's primaryVersionSeries was reserved.
    
    Returns:
    
    the Date on which this object's primaryVersionSeries was reserved
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getReservationComment
```
public String getReservationComment()
                             throws IfsException
```
    Returns the reservation comment specified when this object's primaryVersionSeries was reserved.
    
    Returns:
    
    the reservation comment specified when this object's primaryVersionSeries was reserved
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - isVersioned
```
public boolean isVersioned()
                    throws IfsException
```
    Returns true if this object is versioned (FAMILY != null).
    
    Returns:
    
    true if this object is versioned (FAMILY != null)
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - isLatestVersion
```
public boolean isLatestVersion()
                        throws IfsException
```
    Returns true if this public object is referenced by the lastest VersionDescription in this object's primaryVersionSeries.
    This method is one of many versioning convenience methods on PublicObject. These methods are valid only when this public object is referenced by a single VersionDescription in the primaryVersionSeries (simple versioning). For more complex versioning models, you must use the methods on the version classes (Family, et. al).
    
    Returns:
    
    true if this public object is referenced by the lastest VersionDescription in this object's primaryVersionSeries
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getVersions
```
public PublicObject[] getVersions()
                           throws IfsException
```
    Returns an array of PublicObjects which are all referenced by the VersionDescriptions in the primary version series. May return the same PublicObject more than once if it is referenced by more than one VersionDescription.
    
    Returns:
    
    an array of PublicObjects which are all referenced by the VersionDescriptions in the primary version series.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getFirstVersion
```
public PublicObject getFirstVersion()
                             throws IfsException
```
    Returns the PublicObject referenced by the first VersionDescription in the PrimaryVersionSeries.
    This method is one of many versioning convenience methods on PublicObject. These methods are valid only when this public object is referenced by a single VersionDescription in the primaryVersionSeries (simple versioning). For more complex versioning models, you must use the methods on the version classes (Family, et. al).
    
    Returns:
    
    the PublicObject referenced by the first VersionDescription in the PrimaryVersionSeries
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getLastVersion
```
public PublicObject getLastVersion()
                            throws IfsException
```
    Returns the PublicObject referenced by the last VersionDescription in the PrimaryVersionSeries.
    This method is one of many versioning convenience methods on PublicObject. These methods are valid only when this public object is referenced by a single VersionDescription in the primaryVersionSeries (simple versioning). For more complex versioning models, you must use the methods on the version classes (Family, et. al).
    
    Returns:
    
    the PublicObject referenced by the last VersionDescription in the PrimaryVersionSeries
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getNextVersion
```
public PublicObject getNextVersion()
                            throws IfsException
```
    Returns the PublicObject referenced by the next VersionDescription in the PrimaryVersionSeries.
    This method is one of many versioning convenience methods on PublicObject. These methods are valid only when this public object is referenced by a single VersionDescription in the primaryVersionSeries (simple versioning). For more complex versioning models, you must use the methods on the version classes (Family, et. al).
    
    Returns:
    
    the PublicObject referenced by the last VersionDescription in the PrimaryVersionSeries
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getPreviousVersion
```
public PublicObject getPreviousVersion()
                                throws IfsException
```
    Returns the PublicObject referenced by the previous VersionDescription in the PrimaryVersionSeries.
    This method is one of many versioning convenience methods on PublicObject. These methods are valid only when this public object is referenced by a single VersionDescription in the primaryVersionSeries (simple versioning). For more complex versioning models, you must use the methods on the version classes (Family, et. al).
    
    Returns:
    
    the PublicObject referenced by the last VersionDescription in the PrimaryVersionSeries
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getFamily
```
public Family getFamily()
                 throws IfsException
```
    Returns the Family with which this object is associated. A PublicObject has a Family when (and only when) it is versioned. Most PublicObjects can be associated with a Family, call isVersionable to be sure.
    
    Returns:
    
    Family with which this Object is associated or null if the PublicObject is not versioned
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getWorkingCopy
```
public PublicObject getWorkingCopy()
                            throws IfsException
```
    Returns the working copy of this object's Family.
    Returns null if this object does not have a Family, or if the Family is reserved by another user. Otherwise it returns the current Working Copy (the VersionSeries' PendingPublicObject).
    
    Returns:
    
    the working copy of this object, or null.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - isWorkingCopy
```
public boolean isWorkingCopy()
                      throws IfsException
```
    Returns true if this object is a working copy, which is the PENDINGPUBLICOBJECT of a Family's primary VersionSeries.
    
    Returns:
    
    true if this object is a working copy.
    
    Throws:
    
    IfsException - if the operation fails
  - getResolvedPublicObject
```
public PublicObject getResolvedPublicObject()
                                     throws IfsException
```
    Returns the PublicObject to which this object resolves. For the non version classes (for example, Document and Folder) this simply returns this. For the version classes, (Family, VersionSeries, and VersionDescription), this will return a non version-class object as determined by the configuration of the instance of the version class.
    For example, getResolvedPublicObject() on a VersionDescription will return the PublicObject which it is tracking [same as VersionDescription.getPublicObject()].
    For a VersionSeries, this will normally return the latest versioned PublicObject in that series (but this can be overridden). Refer to each version class' javadoc for details.
    
    Returns:
    
    PublicObject that this object resolves to
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getVersionSeries
```
public VersionSeries getVersionSeries()
                               throws IfsException
```
    Returns the Primary VersionSeries with which this object is associated. This is a shortcut to getting the family, and then getting the family's Primary VersionSeries.
    
    Returns:
    
    Primary VersionSeries with which this Object is associated
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getSingletonVersionDescription
```
protected VersionDescription getSingletonVersionDescription()
                                                     throws IfsException
```
    Throws:
    
    IfsException
    
    (Unpublished)
  - verifyVersionSeries
```
protected VersionSeries verifyVersionSeries()
                                     throws IfsException
```
    Throws:
    
    IfsException
    
    (Unpublished)
  - checkVersioned
```
protected void checkVersioned()
                       throws IfsException
```
    Throws:
    
    IfsException
    
    (Unpublished)
  - isVersionable
```
public boolean isVersionable()
                      throws IfsException
```
    Returns true if this class of object is versionable. For PublicObject, this defaults to false. Subclasses override this method.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - listLeftwardRelationships
```
protected Vector listLeftwardRelationships(ClassObject relClass,
                                           SortSpecification sortSpec)
                                    throws IfsException
```
    Throws:
    
    IfsException
    
    (Unpublished)
  - listRightwardRelationships
```
protected Vector listRightwardRelationships(ClassObject relClass,
                                            SortSpecification sortSpec)
                                     throws IfsException
```
    Throws:
    
    IfsException
    
    (Unpublished)
  - hasCategories
```
public boolean hasCategories()
                      throws IfsException
```
    Returns indication as to whether the object has any associated Categories.
    
    Returns:
    
    true if this object has associated Categories; false otherwise
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - hasConfigurationCategories
```
public boolean hasConfigurationCategories()
                                   throws IfsException
```
    Returns indication as to whether the object has any associated ConfigurationCategories.
    
    Returns:
    
    true if this object has associated ConfigurationCategories; false otherwise
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - createDedicatedPolicyPropertyBundle
```
protected PolicyPropertyBundle createDedicatedPolicyPropertyBundle()
                                                            throws IfsException
```
    Deprecated. CM SDK 10gR2: see release notes for changes to Policy framework
    
    Creates a PropertyBundle, with the SecuringPublicObject setting referencing this object.
    
    Returns:
    
    a new PropertyBundle
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - resolveFolderReferenceSortSpecification
```
protected SortSpecification resolveFolderReferenceSortSpecification(LibrarySession session)
                                                             throws IfsException
```
    Forces the SortSpecification (if specified) to be resolved and verified.
    
    Parameters:
    
    session - the current LibrarySession
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - constructPublicObjectVector
```
protected static Vector constructPublicObjectVector(LibrarySession sess,
                                                    Vector vector)
                                             throws IfsException
```
    Throws:
    
    IfsException
    
    (Unpublished)
  - constructPublicObject
```
protected static PublicObject constructPublicObject(LibrarySession sess,
                                                    S_LibraryObjectData data)
                                             throws IfsException
```
    Throws:
    
    IfsException
    
    (Unpublished)
  - constructPublicObjectArray
```
public static PublicObject[] constructPublicObjectArray(LibrarySession sess,
                                                        Long[] ids)
                                                 throws IfsException
```
    Constructs a PublicObject array from an array of object IDs. This will throw an exception if any of the IDs cannot be converted into a PublciObject.
    
    Parameters:
    
    sess - the requesting session
    
    ids - the array of object IDs
    
    Returns:
    
    the array of PublicObjects
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - toPublicObjectArray
```
public static PublicObject[] toPublicObjectArray(LibrarySession sess,
                                                 Long[] ids,
                                                 PublicObject[] objs)
                                          throws IfsException
```
    Constructs a PublicObject array from an array of object IDs.
    The specified array will be used if it is the correct size; otherwise, an array will be constructed on the correct size. This will throw an exception if any of the IDs cannot be converted into a PublicObject.
    
    Parameters:
    
    sess - the requesting session
    
    ids - the array of object IDs
    
    objs - the array type to be returned
    
    Returns:
    
    the array of PublicObjects
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - vectorToPublicObjectArray
```
protected static PublicObject[] vectorToPublicObjectArray(Vector vector)
```
    Converts a Vector of PublicObject to an array of PublicObject.
    
    Parameters:
    
    vector - A Vector containing PublicObjects
    
    Returns:
    
    an array of PublicObjects
    
    (Unpublished)
  - vectorPublicObjectElement
```
protected static PublicObject vectorPublicObjectElement(Vector vector,
                                                        int index)
                                                 throws IndexOutOfBoundsException
```
    Returns a PublicObject from a specified Vector of PublicObject and an index.
    
    Parameters:
    
    vector - A Vector containing PublicObject
    
    index - An index into the Vector of PublicObject
    
    Returns:
    
    the requested PublicObject
    
    Throws:
    
    IndexOutOfBoundsException - if index is invalid
    
    (Unpublished)
  - delete
```
public void delete()
            throws IfsException
```
    Mark an object for delete. This feature is not supported in PRODUCTION 9.0.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - undelete
```
public void undelete()
              throws IfsException
```
    cancel "mark delete" status for an object. This feature is not supported in PRODUCTION 9.0.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - isDeleted
```
public boolean isDeleted()
                  throws IfsException
```
    isDeleted() - returns true if the object is marked for deletion, false otherwise
    
    Returns:
    
    true if the object is marked for deletion, false otherwise
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getDefaultAccessLevel
```
public AccessLevel getDefaultAccessLevel()
                                  throws IfsException
```
    Returns the access level defined for "World" access; i.e. the minimum access granted implicitly to all users.
    
    Returns:
    
    the AccessLevel set for "World"
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getEffectiveAccessLevel
```
public AccessLevel getEffectiveAccessLevel()
                                    throws IfsException
```
    Get the access level on this object for the current user.
    
    Returns:
    
    the AccessLevel set for the current user
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getEffectiveAccessLevel
```
public AccessLevel getEffectiveAccessLevel(DirectoryObject obj)
                                    throws IfsException
```
    Get the access level on this object for the specified user.
    
    Parameters:
    
    obj - specified user on which to check Access Control
    
    Returns:
    
    the AccessLevel set for the specified user
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - checkEffectiveAccess
```
public boolean checkEffectiveAccess(AccessLevel level)
                             throws IfsException
```
    Checks to see if current user has the specified access level on this object.
    
    Parameters:
    
    level - specified level
    
    Returns:
    
    true if current user has at least the specified access
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - checkEffectiveAccess
```
public boolean checkEffectiveAccess(DirectoryObject obj,
                                    AccessLevel level)
                             throws IfsException
```
    Check to see if specified user has the specified access level on this object.
    
    Parameters:
    
    obj - the object being checked
    
    level - specified level.
    
    Returns:
    
    true if specified user has at least the specified access.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - grantAccess
```
public AccessControlEntry grantAccess(AccessControlEntryDefinition def)
                               throws IfsException
```
    Add or extend an AccessControlEntryDefinition for this object. This will extend the access for the referenced user by the permissions set in the AccessControlEntryDefinition object. If the user already has all of the permissions specified in the AccessControlEntryDefinition's AccessLevel object, this operation does nothing (no exception thrown). NOTE if this object is currently sharing an ACL with another object, then this operation may cause the ACL to be no longer shared. In that case, the ACE created by this operation is not returned (null is returned). This may be addressed in a future release.
    
    Parameters:
    
    def - AccessControlEntryDefinition definition
    
    Returns:
    
    the AccessControlEntry created by the operation
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - revokeAccess
```
public AccessControlEntry revokeAccess(AccessControlEntryDefinition def)
                                throws IfsException
```
    Remove or restrict an AccessControlEntryDefinition for this object. This will restrict the access for the referenced user by the permissions set in the AccessControlEntryDefinition object. If the user already does not have any of the permissions specified in the AccessControlEntryDefinition's AccessLevel object, this oepration does nothing (no exception thrown). NOTE if this object is currently sharing an ACL with another object, then this operation may cause the ACL to be no longer shared. In that case, the ACE created by this operation is not returned (null is returned). This may be addressed in a future release.
    
    Parameters:
    
    def - AccessControlEntryDefinition definition
    
    Returns:
    
    the AccessControlEntry created by the operation
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - addAccess
```
protected AccessControlEntry addAccess(AccessControlEntryDefinition def)
                                throws IfsException
```
    addAccess - USed by grantAccess() and revokeAccess() to add a AccessControlEntry for this object.
    
    Parameters:
    
    def - AccessControlEntryDefinition definition
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - postSecurityChangedEvent
```
public void postSecurityChangedEvent()
                              throws IfsException
```
    Post an event that notes that the security has been changed on an object, forcing all sessions to re-examine whether the target object should be discoverable.
    
    Throws:
    
    IfsException - if operation fails
    
    (Unpublished)
  - getVersionNumber
```
public long getVersionNumber()
                      throws IfsException
```
    returns the sequential number of this revision within the primary version series.
    This method is one of many versioning convenience methods on PublicObject. These methods are valid only when this public object is referenced by a single VersionDescription in the primaryVersionSeries (simple versioning). For more complex versioning models, you must use the methods on the version classes (Family, et. al).
    
    Returns:
    
    the sequential revision number.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - revokeAllAccess
```
public void revokeAllAccess()
                     throws IfsException
```
    Removes all AccessControlEntryDefinitions for this object. Any grants that have been specifically issued for this object to specific users or user entities are removed.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - hasMessageList
```
public boolean hasMessageList()
                       throws IfsException
```
    Returns indication as to whether the object has an associated MessageList category.
    
    Returns:
    
    true if this object has an associated MessageList category; false otherwise
    
    Throws:
    
    IfsException - if the operation fails
  - hasAttachmentRelation
```
public boolean hasAttachmentRelation()
                              throws IfsException
```
    Returns indication as to whether the object has an associated AttachmentRelation category.
    
    Returns:
    
    true if this object has an associated AttachmentRelation category; false otherwise
    
    Throws:
    
    IfsException - if the operation fails
  - hasActivityRecord
```
public boolean hasActivityRecord()
                          throws IfsException
```
    Returns indication as to whether the object has an associated ActivityRecord category.
    
    Returns:
    
    true if this object has an associated ActivityRecord category; false otherwise
    
    Throws:
    
    IfsException - if the operation fails
  - hasActor
```
public boolean hasActor()
                 throws IfsException
```
    Returns indication as to whether the object has an associated Actor category.
    
    Returns:
    
    true if this object has an associated Actor category; false otherwise
    
    Throws:
    
    IfsException - if the operation fails
  - getMessageList
```
public MessageList getMessageList()
                           throws IfsException
```
    Returns the MessageList category if one exists.
    
    Returns:
    
    associated MessageList category, or null none exist
    
    Throws:
    
    IfsException - if the operation fails
  - getAttachmentRelation
```
public AttachmentRelation getAttachmentRelation()
                                         throws IfsException
```
    Returns the AttachmentRelation category if one exists.
    
    Returns:
    
    associated AttachmentRelation category, or null none exist
    
    Throws:
    
    IfsException - if the operation fails
  - getActivityRecord
```
public ActivityRecord getActivityRecord()
                                 throws IfsException
```
    Returns the ActivityRecord category if one exists.
    
    Returns:
    
    associated ActivityRecord category, or null none exist
    
    Throws:
    
    IfsException - if the operation fails
  - getActor
```
public Actor getActor()
               throws IfsException
```
    Returns the Actor category if one exists.
    
    Returns:
    
    associated Actor category, or null none exist
    
    Throws:
    
    IfsException - if the operation fails

Class PublicObject

Field Summary

Fields inherited from class oracle.ifs.beans.LibraryObject

Constructor Summary

Method Summary

Methods inherited from class oracle.ifs.beans.LibraryObject

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

Methods inherited from interface oracle.ifs.common.Traceable

Field Detail

CLASS_NAME

NAME_ATTRIBUTE

DESCRIPTION_ATTRIBUTE

OWNER_ATTRIBUTE

ACL_ATTRIBUTE

FAMILY_ATTRIBUTE

RESOLVEDPUBLICOBJECT_ATTRIBUTE

CREATEDATE_ATTRIBUTE

CREATOR_ATTRIBUTE

LASTMODIFYDATE_ATTRIBUTE

LASTMODIFIER_ATTRIBUTE

DELETOR_ATTRIBUTE

POLICYLISTS_ATTRIBUTE

POLICYBUNDLE_ATTRIBUTE

PROPERTYBUNDLE_ATTRIBUTE

SECURINGPUBLICOBJECT_ATTRIBUTE

EXPIRATIONDATE_ATTRIBUTE

LOCKOBJECT_ATTRIBUTE

PRIMARYPARENTFOLDER_ATTRIBUTE

FLAGS_ATTRIBUTE

LOCKENTRIES_ATTRIBUTE

FLAG_NOINFERIOR

FLAG_NOSELECT

FLAG_MARKED

FLAG_UNMARKED

FLAG_NTFS_HIDDEN

FLAG_NTFS_SYSTEM

FLAG_NTFS_ARCHIVE

FLAG_NTFS_READONLY

FLAG_CATEGORY_EXISTS

FLAG_CONFIGURATIONCATEGORY_EXISTS

Constructor Detail

PublicObject

Method Detail

hasNameAttribute

hasPropertyBundleAttribute

getDefinitionForSimplePropertyUpdates

getCreateDate

getCreator

getDeletor

getLastModifier

getDescription

setDescription

getLastModifyDate

getOwner

isOwner

setOwner

setOwnerByName

setAcl

getAcl

getSecuringPublicObject

setSecuringPublicObject

addCategory

createCategories

getCategories

getCategories

getCategory

getCategories

hasCategory

getFirstCategory

getRelations

getExpirationDate

setExpirationDate

getFlags

setFlags

updateFlags

addFlags

clearFlags

getLockEntries

getLockEntries