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 ConfigurationCategory

    java.lang.Object
      oracle.ifs.beans.LibraryObject
          oracle.ifs.beans.TieLibraryObject
              oracle.ifs.beans.PublicObject
                  oracle.ifs.beans.TiePublicObject
                      oracle.ifs.beans.Category
                          oracle.ifs.beans.TieCategory
                              oracle.ifs.beans.ConfigurationCategory

All Implemented Interfaces:
  IfsEventHandler, LibraryObjectInterface, PublicObjectInterface, Traceable

Direct Known Subclasses:
  TieConfigurationCategory

    public class ConfigurationCategory

extends TieCategory

A ConfigurationCategory is used to define behavior for the PublicObject with which the category is associated.

Typically ConfigurationCategory instances are associated with a Folder to modify the behavior of the items contained in that folder, and contained in its subfolders.

(Published)

Field Summary
`static java.lang.String` | `CLASS_NAME` The name of the ClassObject representing this class.
`static java.lang.String` | `ENABLED_ATTRIBUTE` The name of the Boolean attribute that indicates whether or not the options defined by this ConfigurationCategory are enabled.
`static java.lang.String` | `FINAL_ATTRIBUTE` The name of the Boolean attribute that indicates whether or not sub-objects can override this ConfigurationCategory.
`static java.lang.String` | `PARENTCONFIGURATION_ATTRIBUTE` The name of the Attribute used to reference the ConfigurationCategory that exists of the same type on the closest ancestor to the current object's associated PublicObject.

Fields inherited from class oracle.ifs.beans.Category
`ASSOCIATEDPUBLICOBJECT_ATTRIBUTE`

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` | `ConfigurationCategory(LibrarySession session, java.lang.Long id, java.lang.Long classId, S_LibraryObjectData data)` Construct a ConfigurationCategory object.

Method Summary
`protected long` | `getFlagUpdatesForCreate(PublicObject assoc, long flags)` Extensibility point to indicate updates that should be made to the associated PublicObject's FLAGS attribute as a result of creating this Category.
`protected long` | `getFlagUpdatesForFree(PublicObject assoc, long flags)` Extensibility point to indicate updates that should be made to the associated PublicObject's FLAGS attribute as a result of freeing this Category.
`ConfigurationCategory` | `getParentConfigurationCategory()` Gets the ConfigurationCategory that exists of the same type on the closest ancestor to the current object's associated PublicObject.
`boolean` | `isEnabled()` Returns whether or not the options defined by this ConfigurationCategory are enabled.
`boolean` | `isFinal()` Returns whether or not sub-objects may override this ConfigurationCategory.
`void` | `moveConfiguration(PublicObject targetAssoc)` Remove the configuration from the current associated PublicObject, and establish an equivalent configuration on the specified target.

Methods inherited from class oracle.ifs.beans.Category
`constructCategory, constructCategoryArray, constructCategoryVector, getAssociatedPublicObject, moveCategory, postCreate, preFree, updateFlagsUponCreate, updateFlagsUponFree`

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, postUpdate, preCopy, preCreate, preUpdate, 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
`applyProperties, 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, getPropertyValue, 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: `ConfigurationCategory`
  The name of the ClassObject representing this class.

  See Also:
    Constant Field Values
  (Published)

### ENABLED_ATTRIBUTE

    public static final java.lang.String ENABLED_ATTRIBUTE

  Description copied from class: `ConfigurationCategory`
  The name of the Boolean attribute that indicates whether or not the options defined by this ConfigurationCategory are enabled.

  See Also:
    Constant Field Values
  (Published)

### FINAL_ATTRIBUTE

    public static final java.lang.String FINAL_ATTRIBUTE

  Description copied from class: `ConfigurationCategory`
  The name of the Boolean attribute that indicates whether or not sub-objects can override this ConfigurationCategory.

  See Also:
    Constant Field Values
  (Published)

### PARENTCONFIGURATION_ATTRIBUTE

    public static final java.lang.String PARENTCONFIGURATION_ATTRIBUTE

  Description copied from class: `ConfigurationCategory`
  The name of the Attribute used to reference the ConfigurationCategory that exists of the same type on the closest ancestor to the current object's associated PublicObject.

  See Also:
    Constant Field Values
  (Published)

Constructor Detail

### ConfigurationCategory

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

  Construct a ConfigurationCategory object.

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

Method Detail

### isEnabled

    public boolean isEnabled()
                      throws IfsException

  Description copied from class: `ConfigurationCategory`
  Returns whether or not the options defined by this ConfigurationCategory are enabled.

  Returns:
    true if this configuration is enabled
  Throws:
    `IfsException` - if the operation fails.

### isFinal

    public boolean isFinal()
                    throws IfsException

  Description copied from class: `ConfigurationCategory`
  Returns whether or not sub-objects may override this ConfigurationCategory.

  Returns:
    true if this configuration cannot be overridden
  Throws:
    `IfsException` - if the operation fails.

### getParentConfigurationCategory

    public ConfigurationCategory getParentConfigurationCategory()
                                                         throws IfsException

  Description copied from class: `ConfigurationCategory`
  Gets the ConfigurationCategory that exists of the same type on the closest ancestor to the current object's associated PublicObject.

  This may return null, when invoked on a PublicObject that has no ancestors that have a ConfigurationCategory of the target type attached.

  Returns:
    the parent ConfigurationCategory
  Throws:
    `IfsException` - if operation fails.
  (Published)

### moveConfiguration

    public void moveConfiguration(PublicObject targetAssoc)
                           throws IfsException

  Description copied from class: `ConfigurationCategory`
  Remove the configuration from the current associated PublicObject, and establish an equivalent configuration on the specified target.

  Throws:
    `IfsException` - if the operation fails.
  (Unpublished)

### getFlagUpdatesForCreate

    protected long getFlagUpdatesForCreate(PublicObject assoc,
                                           long flags)
                                    throws IfsException

  Description copied from class: `ConfigurationCategory`
  Extensibility point to indicate updates that should be made to the associated PublicObject's FLAGS attribute as a result of creating this Category.

  Overrides:
    `getFlagUpdatesForCreate` in class `Category`
  Parameters:
    `assoc` - our associated PublicObject
    `flags` - the current value of the flags attribute
  Returns:
    the updated value of the flags attribute
  Throws:
    `IfsException` - if the operation fails.

### getFlagUpdatesForFree

    protected long getFlagUpdatesForFree(PublicObject assoc,
                                         long flags)
                                  throws IfsException

  Description copied from class: `ConfigurationCategory`
  Extensibility point to indicate updates that should be made to the associated PublicObject's FLAGS attribute as a result of freeing this Category.

  Overrides:
    `getFlagUpdatesForFree` in class `Category`
  Parameters:
    `assoc` - our associated PublicObject
    `flags` - the current value of the flags attribute
  Returns:
    the updated value of the flags attribute
  Throws:
    `IfsException` - if the operation fails.

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