Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## oracle.ifs.beans
Class DefinitionObject

    java.lang.Object
      oracle.ifs.beans.LibraryObject
          oracle.ifs.beans.TieLibraryObject
              oracle.ifs.beans.PublicObject
                  oracle.ifs.beans.TiePublicObject
                      oracle.ifs.beans.ApplicationObject
                          oracle.ifs.beans.TieApplicationObject
                              oracle.ifs.beans.PropertyBundle
                                  oracle.ifs.beans.TiePropertyBundle
                                      oracle.ifs.beans.DefinitionObject

All Implemented Interfaces:
  IfsEventHandler, LibraryObjectInterface, PublicObjectInterface, Traceable

Direct Known Subclasses:
  TieDefinitionObject

    public class DefinitionObject

extends TiePropertyBundle

A DefinitionObject is used to persistently store a LibraryObjectDefinition.

(Unpublished)

Field Summary
`static java.lang.String` | `CLASS_ATTRIBUTE` The name of the attribute which references the ClassObject for which the definition applies.
`static java.lang.String` | `CLASS_NAME` The name of the ClassObject representing this class.
`static java.lang.String` | `EMBEDDED_ATTRIBUTE` The name of the attribute which indicates whether the DefinitionObject is embedded in another DefinitionObject.

Fields inherited from class oracle.ifs.beans.PublicObject
`ACL_ATTRIBUTE, CREATEDATE_ATTRIBUTE, CREATOR_ATTRIBUTE, DELETOR_ATTRIBUTE, DESCRIPTION_ATTRIBUTE, EXPIRATIONDATE_ATTRIBUTE, FAMILY_ATTRIBUTE, FLAG_CATEGORY_EXISTS, FLAG_CONFIGURATIONCATEGORY_EXISTS, FLAG_MARKED, FLAG_NOINFERIOR, FLAG_NOSELECT, FLAG_NTFS_ARCHIVE, FLAG_NTFS_HIDDEN, FLAG_NTFS_READONLY, FLAG_NTFS_SYSTEM, FLAG_UNMARKED, FLAGS_ATTRIBUTE, LASTMODIFIER_ATTRIBUTE, LASTMODIFYDATE_ATTRIBUTE, LOCKENTRIES_ATTRIBUTE, LOCKOBJECT_ATTRIBUTE, NAME_ATTRIBUTE, OWNER_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PRIMARYPARENTFOLDER_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE, RESOLVEDPUBLICOBJECT_ATTRIBUTE, SECURINGPUBLICOBJECT_ATTRIBUTE`

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

Constructor Summary
`protected` | `DefinitionObject(LibrarySession session, java.lang.Long id, java.lang.Long classId, S_LibraryObjectData data)` Construct a DefinitionObject object.

Method Summary
`LibraryObjectDefinition` | `createDefinition()` Create a LibraryObjectDefinition from the properties of this DefintiionObject.
`ClassObject` | `getDefiningClass()` Returns the ClassObject for which the definition applies.
`boolean` | `isEmbedded()` Return indication as to whether this instance is embedded as part of another DefinitionObject.
`protected void` | `postCreate(LibraryObjectDefinition lodef)` Extensibility point to perform actions after the creation of a DefinitionObject.
`protected void` | `postUpdate(LibraryObjectDefinition lodef)` Extensibility point to perform actions after the update of a DefinitionObject.
`protected void` | `preCreate(LibraryObjectDefinition lodef)` Extensibility point to perform actions prior to the creation of a DefinitionObject.
`protected void` | `preFree(LibraryObjectDefinition lodef)` Extensibility point to perform actions prior to the permanent deletion of a DefinitionObject.
`protected void` | `preUpdate(LibraryObjectDefinition lodef)` Extensibility point to perform actions prior to the update of a DefinitionObject.

Methods inherited from class oracle.ifs.beans.PropertyBundle
`applyProperties, constructEquivalentParameterTable, constructEquivalentParameterTable, constructEquivalentParameterTable, constructPropertyBundle, constructPropertyBundleVector, getProperties, getProperties, getProperty, getPropertyByUpperCaseName, getPropertyValue, getPropertyValueByUpperCaseName, getPropertyValues, putPropertyValue, putPropertyValue, removeAllPropertyValues, removePropertyValue, resetProperties, vectorPropertyBundleElement, vectorToPropertyBundleArray`

Methods inherited from class oracle.ifs.beans.ApplicationObject
`constructApplicationObject, constructApplicationObjectVector`

Methods inherited from class oracle.ifs.beans.PublicObject
`addAccess, addCategory, addFlags, addRelationship, auditPublicObjectLocked, auditPublicObjectUnlocked, canAcquireManualLock, canReleaseDavLock, canReleaseLock, canReleaseManualLock, capabilities, checkAuditViewCapability, checkCapabilities, checkCapability, checkEffectiveAccess, checkEffectiveAccess, checkLockAccess, checkVersioned, clearFlags, constructPublicObject, constructPublicObjectArray, constructPublicObjectVector, copy, coreAutoFolderingEnabled, createCategories, createDedicatedPolicyPropertyBundle, delete, deriveEffectiveAccessLevel, free, getAcl, getAllFolderPaths, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getAnyFolderPath, getCapabilities, getCategories, getCategories, getCategories, getCategories, getCategories, getCategory, getConsumedStorage, getCreateDate, getCreator, getDefaultAccessLevel, getDeletor, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFirstVersion, getFlags, getFolderReferences, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLastVersion, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLeftwardRelationshipsCount, getLeftwardRelationshipsCount, getLinks, getLockEntries, getLockEntries, getLockObject, getLockRestrictions, getLockTypeAuditProperties, getNextVersion, getOwner, getPolicyBundle, getPolicyLists, getPreviousVersion, getPrimaryFolderPath, getPrimaryParentFolder, getPrimaryParentFolder, getReservationComment, getReservationDate, getReservor, getResolvedPublicObject, getRestrictingLockEntries, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, getSingletonVersionDescription, getVersionNumber, getVersions, getVersionSeries, getWorkingCopy, grantAccess, handleCopy, handleCreate, handleUnlockAll, hasCategories, hasConfigurationCategories, hasNameAttribute, isDeleted, isLatestVersion, isLocked, isLockingSupported, isOwner, isReserved, isReservedByCurrentUser, isVersionable, isVersioned, isWorkingCopy, listLeftwardRelationships, listRightwardRelationships, lock, lock, lock, lock, newVersion, postCopy, preCopy, putPolicy, reassociateLinks, removeAllPolicies, removePolicy, removePolicy, removeRelationship, reserveNext, resetFolderReferences, resolveFolderReferenceSortSpecification, revokeAccess, revokeAllAccess, setAcl, setDescription, setExpirationDate, setFlags, setFolderReferencesSortSpecification, setLockEntries, setLockEntrySecurity, setOwner, setOwnerByName, setPolicyBundle, setPolicyLists, setSecuringPublicObject, toPublicObjectArray, undelete, unlock, unlock, unlockAll, unReserve, updateFlags, updateLock, vectorPublicObjectElement, vectorToPublicObjectArray, verifyDeleteCapability, verifyLockCapability, verifyUnlockCapability, verifyVersionSeries`

Methods inherited from class oracle.ifs.beans.LibraryObject
`auditCreated, auditUpdated, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, deriveDomainUniqueName, dispose, equals, free, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCopyContext, getCreateContext, getData, getDefinition, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isTraced, isValidEventType, lockRows, lookupInstanceLabel, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeProperty, 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, verifySystemUserAccess, verifyTargetObject`

Methods inherited from class java.lang.Object
`clone, equals, 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 java.lang.String CLASS_NAME

  Description copied from class: `DefinitionObject`
  The name of the ClassObject representing this class.

  See Also:
    Constant Field Values
  (Published)

### CLASS_ATTRIBUTE

    public static final java.lang.String CLASS_ATTRIBUTE

  Description copied from class: `DefinitionObject`
  The name of the attribute which references the ClassObject for which the definition applies.

  See Also:
    Constant Field Values
  (Published)

### EMBEDDED_ATTRIBUTE

    public static final java.lang.String EMBEDDED_ATTRIBUTE

  Description copied from class: `DefinitionObject`
  The name of the attribute which indicates whether the DefinitionObject is embedded in another DefinitionObject.

  See Also:
    Constant Field Values
  (Published)

Constructor Detail

### DefinitionObject

    protected DefinitionObject(LibrarySession session,
                               java.lang.Long id,
                               java.lang.Long classId,
                               S_LibraryObjectData data)
                        throws IfsException

  Construct a DefinitionObject object.

  Parameters:
    `session` - current LibrarySession
    `id` - object id
    `classId` - class id
    `data` - data component
  Throws:
    `IfsException` - if the operation fails
  (Unpublished)

Method Detail

### getDefiningClass

    public ClassObject getDefiningClass()
                                 throws IfsException

  Description copied from class: `DefinitionObject`
  Returns the ClassObject for which the definition applies.

  Returns:
    the ClassObject for which the definition applies.
  Throws:
    `IfsException` - if the operation fails
  (Published)

### isEmbedded

    public boolean isEmbedded()
                       throws IfsException

  Description copied from class: `DefinitionObject`
  Return indication as to whether this instance is embedded as part of another DefinitionObject.

  Returns:
    true if the instance is embedded as part of another DefinitionObject.
  Throws:
    `IfsException` - if the operation fails.
  (Published)

### preCreate

    protected void preCreate(LibraryObjectDefinition lodef)
                      throws IfsException

  Description copied from class: `DefinitionObject`
  Extensibility point to perform actions prior to the creation of a DefinitionObject.

  This performs validation, primarily on the target definition.

  Overrides:
    `preCreate` in class `PublicObject`
  Parameters:
    `lodef` - object definition that will be used to create the object
  Throws:
    `IfsException` - if operation fails.
  (Unpublished)

### postCreate

    protected void postCreate(LibraryObjectDefinition lodef)
                       throws IfsException

  Description copied from class: `DefinitionObject`
  Extensibility point to perform actions after the creation of a DefinitionObject.

  Creates the properties.

  Overrides:
    `postCreate` in class `PublicObject`
  Parameters:
    `lodef` - object definition that was used to create the object
  Throws:
    `IfsException` - if operation fails.
  (Unpublished)

### preUpdate

    protected void preUpdate(LibraryObjectDefinition lodef)
                      throws IfsException

  Description copied from class: `DefinitionObject`
  Extensibility point to perform actions prior to the update of a DefinitionObject.

  Overrides:
    `preUpdate` in class `PublicObject`
  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

  Description copied from class: `DefinitionObject`
  Extensibility point to perform actions after the update of a DefinitionObject.

  Overrides:
    `postUpdate` in class `PublicObject`
  Parameters:
    `lodef` - object definition used to define how the target object was updated
  Throws:
    `IfsException` - if operation fails.
  (Unpublished)

### preFree

    protected void preFree(LibraryObjectDefinition lodef)
                    throws IfsException

  Description copied from class: `DefinitionObject`
  Extensibility point to perform actions prior to the permanent deletion of a DefinitionObject.

  Frees the properties that comprise the target definition.

  Overrides:
    `preFree` in class `PublicObject`
  Parameters:
    `lodef` - object definition used to hold options related to the free operation; can be null
  Throws:
    `IfsException` - if operation fails.
  (Unpublished)

### createDefinition

    public LibraryObjectDefinition createDefinition()
                                             throws IfsException

  Description copied from class: `DefinitionObject`
  Create a LibraryObjectDefinition from the properties of this DefintiionObject.

  The definition returned should be nearly identical to the defintiion specified in the `setTargetDefinition` on the DefinitionObjectDefintiion.

  Returns:
    the definition that represents target instance's properties
  Throws:
    `IfsException` - if operation fails.
  (Unpublished)

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD