oracle.ifs.beans

Class Category

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.PublicObject

oracle.ifs.beans.TiePublicObject

oracle.ifs.beans.Category

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, PublicObjectInterface, Traceable

Direct Known Subclasses:

TieCategory

public class Category
extends TiePublicObject

A Category class is used to add custom meta-data to PublicObjects on a per instance basis. In addition, Categories can be added across different PublicObject classes.

Category subclasses can contain their own custom data, which effectively contain data about the PublicObject with which the Category instance is associated. A PublicObject can be associated with any Category, which allows different sets of data to be associated with instances of the same PublicObject subclass. Additionally, PublicObjects can be associated with multiple instances of Category subclasses.

Version:

1.0

Author:

Dave Long

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASSOCIATEDPUBLICOBJECT_ATTRIBUTE The PublicObject that is associated with this Category.
static String	CLASS_NAME This class name for this class.

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

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected static Category	constructCategory(LibrarySession sess, S_LibraryObjectData data) Returns a Category object from a Category data object.
protected static Category[]	constructCategoryArray(LibrarySession sess, Long[] ids) Construct a Category array from an array of object IDs.
protected static Vector	constructCategoryVector(LibrarySession sess, Vector vector) Returns Category Vector from a Vector of Category.
PublicObject	getAssociatedPublicObject() Gets the PublicObject associated with this Category.
protected long	getFlagUpdatesForCreate(PublicObject assoc, long flags) Deprecated. 9.2.4.0: this method is no longer relevant
protected long	getFlagUpdatesForFree(PublicObject assoc, long flags) Deprecated. 9.2.4.0: this method is no longer relevant
protected boolean	isValidEventType(AuditEvent event) Checks to see if the event type in the process of being posted on the target LibraryObject is consistent with the target.
void	moveCategory(PublicObject targetAssoc) Remove the Category from the current associated PublicObject, and re-associate it with the specified PublicObject.
protected void	verifyCategoryFlagNotSet(long flags, long flagValue, String className) Deprecated. 9.2.4.0: this method is no longer relevant

Methods inherited from class oracle.ifs.beans.PublicObject

addAccess, addAttachment, addCategory, addFlags, addMessageList, addRelationship, auditPublicObjectLocked, auditPublicObjectUnlocked, canAcquireManualLock, canReleaseDavLock, canReleaseLock, canReleaseManualLock, capabilities, checkAuditViewCapability, checkCapabilities, checkCapability, checkEffectiveAccess, checkEffectiveAccess, checkLockAccess, checkParentFolderCapability, checkVersioned, clearFlags, constructPublicObject, constructPublicObjectArray, constructPublicObjectVector, containsLockEntry, copy, coreAutoFolderingEnabled, createCategories, createDedicatedPolicyPropertyBundle, delete, deriveEffectiveAccessLevel, findAttachmentRelation, findOrAddActivityRecord, findOrAddActivityRecord, findOrAddActor, findOrAddActor, findOrAddMessageList, findOrAddMessageList, free, getAcl, getActivityRecord, getActor, getAllFolderPaths, getAllFolderPaths, getAllFolderPaths, getAnyFolderPath, getAnyFolderPath, getAnyFolderPath, getAttachmentRelation, getAttachmentRelations, getAttachments, getCapabilities, getCategories, getCategories, getCategories, getCategories, getCategories, getCategory, getConsumedStorage, getCreateDate, getCreator, getDefaultAccessLevel, getDefinitionForSimplePropertyUpdates, getDeletor, getDescription, getEffectiveAccessLevel, getEffectiveAccessLevel, getExpirationDate, getFamily, getFirstCategory, getFirstVersion, getFlags, getFolderReferences, getFolderReferences, getFolderReferencesSortSpecification, getLastModifier, getLastModifyDate, getLastVersion, getLeftwardRelationshipObjects, getLeftwardRelationshipObjects, getLeftwardRelationships, getLeftwardRelationships, getLeftwardRelationshipsCount, getLeftwardRelationshipsCount, getLinks, getLockEntries, getLockEntries, getLockObject, getLockRestrictions, getLockTypeAuditProperties, getMessageList, getNextVersion, getOwner, getPolicyBundle, getPolicyLists, getPreviousVersion, getPrimaryFolderPath, getPrimaryParentFolder, getPrimaryParentFolder, getRelations, getReservationComment, getReservationDate, getReservor, getResolvedPublicObject, getRestrictingLockEntries, getRightwardRelationshipObjects, getRightwardRelationshipObjects, getRightwardRelationships, getRightwardRelationships, getSecuringPublicObject, getSingletonVersionDescription, getVersionNumber, getVersions, getVersionSeries, getWorkingCopy, grantAccess, handleCopy, handleCreate, handleUnlockAll, hasActivityRecord, hasActor, hasAttachmentRelation, hasCategories, hasCategory, hasConfigurationCategories, hasMessageList, hasNameAttribute, hasPropertyBundleAttribute, isAttachment, isDeleted, isLatestVersion, isLocked, isLockingSupported, isOwner, isReserved, isReservedByCurrentUser, isVersionable, isVersioned, isWorkingCopy, listLeftwardRelationships, listRightwardRelationships, lock, lock, lock, lock, newVersion, postCopy, postCreate, postSecurityChangedEvent, postUpdate, preCopy, preCreate, preFree, preUpdate, putPolicy, reassociateLinks, removeAllPolicies, removeAttachment, 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, verifyAddRelationshipCapability, verifyCapabilities, verifyCapability, verifyDeleteCapability, verifyLockCapability, verifyRemoveRelationshipCapability, verifyUnlockCapability, 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, 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)

ASSOCIATEDPUBLICOBJECT_ATTRIBUTE

public static final String ASSOCIATEDPUBLICOBJECT_ATTRIBUTE

The PublicObject that is associated with this Category. This allows different sets of data to be associated with instances of the same PublicObject subclass.

See Also:

Constant Field Values

(Published)

Constructor Detail

Category

protected Category(LibrarySession session,
                   Long id,
                   Long classId,
                   S_LibraryObjectData data)
            throws IfsException

Constructs a Category object - standard variant.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data components

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

getAssociatedPublicObject

public PublicObject getAssociatedPublicObject()
                                       throws IfsException

Gets the PublicObject associated with this Category.

Returns:

the PublicObject

Throws:

IfsException - if operation fails

(Published)

constructCategoryVector

protected static Vector constructCategoryVector(LibrarySession sess,
                                                Vector vector)
                                         throws IfsException

Returns Category Vector from a Vector of Category.

Parameters:

sess - current LibrarySession

vector - Vector of Category objects.

Throws:

IfsException - if the operation fails

(Unpublished)

constructCategory

protected static Category constructCategory(LibrarySession sess,
                                            S_LibraryObjectData data)
                                     throws IfsException

Returns a Category object from a Category data object.

Parameters:

sess - current LibrarySession

data - the object containing Category data

Throws:

IfsException - if the operation fails

(Unpublished)

constructCategoryArray

protected static Category[] constructCategoryArray(LibrarySession sess,
                                                   Long[] ids)
                                            throws IfsException

Construct a Category array from an array of object IDs. This will throw an exception if any of the IDs cannot be converted into a Category.

Parameters:

sess - the requesting session

ids - the array of object IDs

Returns:

the array of Categorys

Throws:

IfsException - if operation fails.

(Unpublished)

getFlagUpdatesForCreate

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

Deprecated. 9.2.4.0: this method is no longer relevant

Extensibility point to indicate updates that should be made to the associated PublicObject's FLAGS attribute as a result of creating this 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

Deprecated. 9.2.4.0: this method is no longer relevant

Extensibility point to indicate updates that should be made to the associated PublicObject's FLAGS attribute as a result of freeing this 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.

verifyCategoryFlagNotSet

protected void verifyCategoryFlagNotSet(long flags,
                                        long flagValue,
                                        String className)
                                 throws IfsException

Deprecated. 9.2.4.0: this method is no longer relevant

Verify that the specified flag is not already set in the specified flags value.

Parameters:

flags - the current value of the flags attribute

flagValue - the flag to check

className - the class name of the category that is being checked

Throws:

IfsException - if the operation fails.

isValidEventType

protected boolean isValidEventType(AuditEvent event)
                            throws IfsException

Description copied from class: LibraryObject

Checks to see if the event type in the process of being posted on the target LibraryObject is consistent with the target.

Overrides:

isValidEventType in class LibraryObject

Parameters:

event - the event being posted on this object

Returns:

true if the type is consistent; false otherwise

Throws:

IfsException - if the operation fails

moveCategory

public void moveCategory(PublicObject targetAssoc)
                  throws IfsException

Remove the Category from the current associated PublicObject, and re-associate it with the specified PublicObject.

Throws:

IfsException - if the operation fails.