oracle.ifs.core.beans

Class AutoFolderingActionSpecification

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.core.beans.AutoFolderingActionSpecification

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieAutoFolderingActionSpecification

public class AutoFolderingActionSpecification
extends TieSystemObject

An AutoFolderingActionSpecification represents the AutoFolderingAction used for auto foldering operations.

Author:

Dragos Harabor

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTOFOLDERINGACTIONCLASSNAME_ATTRIBUTE The name of the attribute that holds fully-qualified class name of the AutoFolderingAction class.
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	DESCRIPTION_ATTRIBUTE The name of the attribute that holds the description of this AutoFolderingActionSpecification.
static String	INTERNAL_ATTRIBUTE The name of the attribute that indicates whether the AutoFolderingAction reference implements the internal interface.
static String	NAME_ATTRIBUTE The name of the attribute that holds the name of this AutoFolderingActionSpecification.

Fields inherited from class oracle.ifs.beans.SystemObject

ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PROPERTYBUNDLE_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	AutoFolderingActionSpecification(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs a AutoFolderingActionSpecification object.

Method Summary

Modifier and Type	Method and Description
static AutoFolderingActionSpecification[]	findAll(LibrarySession session) Returns the set of defined AutoFolderingActionSpecifications.
static AutoFolderingActionSpecification	findByName(LibrarySession session, String name) Returns the a AutoFolderingActionSpecification matching the specified name.
AutoFolderingAction	getAutoFolderingAction() Gets the AutoFolderingAction instance implementation corresponding to the AutoFolderingActionClassName.
String	getAutoFolderingActionClassName() Gets the fully-qualified class name of the AutoFolderingAction class.
String	getDescription() Gets the description of this AutoFolderingActionSpecification.
static LibraryObjectLookupCache	getLibraryObjectLookupCache(LibrarySession session) Returns the LibraryObjectLookupCache used by find AutoFolderingActionSpecification instances by name.
void	handleEvent(IfsEvent event) Handles the specified event.
boolean	hasNameAttribute() Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.
boolean	isInternal() Gets the indication as to whether the AutoFolderingAction reference implements the internal interface.
protected void	preFree(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the permanent deletion ("free") of a object.

Methods inherited from class oracle.ifs.beans.SystemObject

addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasPropertyBundleAttribute, isActive, postCreate, postUpdate, preCreate, preUpdate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists

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, getDefinitionForSimplePropertyUpdates, 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, 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

The name of the ClassObject representing this class.

See Also:

Constant Field Values

(Published)

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

The name of the attribute that holds the name of this AutoFolderingActionSpecification. (String[700])

See Also:

Constant Field Values

DESCRIPTION_ATTRIBUTE

public static final String DESCRIPTION_ATTRIBUTE

The name of the attribute that holds the description of this AutoFolderingActionSpecification. (String[2000])

See Also:

Constant Field Values

AUTOFOLDERINGACTIONCLASSNAME_ATTRIBUTE

public static final String AUTOFOLDERINGACTIONCLASSNAME_ATTRIBUTE

The name of the attribute that holds fully-qualified class name of the AutoFolderingAction class. (String[700])

See Also:

Constant Field Values

INTERNAL_ATTRIBUTE

public static final String INTERNAL_ATTRIBUTE

The name of the attribute that indicates whether the AutoFolderingAction reference implements the internal interface. (Boolean)

See Also:

Constant Field Values

Constructor Detail

AutoFolderingActionSpecification

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

Constructs a AutoFolderingActionSpecification object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

hasNameAttribute

public boolean hasNameAttribute()
                         throws IfsException

Description copied from class: LibraryObject

Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.

Overrides:

hasNameAttribute in class LibraryObject

Returns:

true if the object has a NAME attribute.

Throws:

IfsException - if operation fails.

getDescription

public String getDescription()
                      throws IfsException

Gets the description of this AutoFolderingActionSpecification.

Returns:

the object description

Throws:

IfsException - if operation fails

getAutoFolderingActionClassName

public String getAutoFolderingActionClassName()
                                       throws IfsException

Gets the fully-qualified class name of the AutoFolderingAction class.

Returns:

the class name of the AutoFolderingAction

Throws:

IfsException - if operation fails

isInternal

public boolean isInternal()
                   throws IfsException

Gets the indication as to whether the AutoFolderingAction reference implements the internal interface.

Returns:

true if AutoFolderingAction implements internal interface; false otherwise

Throws:

IfsException - if operation fails

getLibraryObjectLookupCache

public static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySession session)
                                                            throws IfsException

Returns the LibraryObjectLookupCache used by find AutoFolderingActionSpecification instances by name.

Parameters:

session - the session context

Returns:

the LibraryObjectLookupCache

Throws:

IfsException - if the operation fails.

findAll

public static AutoFolderingActionSpecification[] findAll(LibrarySession session)
                                                  throws IfsException

Returns the set of defined AutoFolderingActionSpecifications.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of AutoFolderingActionSpecifications; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

public static AutoFolderingActionSpecification findByName(LibrarySession session,
                                                          String name)
                                                   throws IfsException

Returns the a AutoFolderingActionSpecification matching the specified name.

AutoFolderingActionSpecification names are case sensitive, so this operations requires an exact match with respect to case.

Parameters:

session - the session context

name - the AutoFolderingActionSpecification name

Returns:

the AutoFolderingActionSpecification matching the specified name; or null if there exists no matching AutoFolderingActionSpecification

Throws:

IfsException - if the operation fails.

preFree

protected void preFree(LibraryObjectDefinition lodef)
                throws IfsException

Description copied from class: LibraryObject

Extensibility point to perform actions prior to the permanent deletion ("free") of a object.

This method is typically overridden by subclasses that perform other operations prior to the target object being freed in order to all delete or modify objects related to the target object. Subclasses are expected to invoke super.preFree.

Overrides:

preFree in class LibraryObject

Parameters:

lodef - object definition used to hold options related to the free operation

Throws:

IfsException - if operation fails.

getAutoFolderingAction

public final AutoFolderingAction getAutoFolderingAction()
                                                 throws IfsException

Gets the AutoFolderingAction instance implementation corresponding to the AutoFolderingActionClassName.

This implementation is cached for use by the session associated with this instance. There is no guarantee that there is only one implementation in use for the session if the session is used in multiple threads.

Returns:

the AutoFolderingAction implementation

Throws:

IfsException - if the operation fails

(Unpublished)

handleEvent

public void handleEvent(IfsEvent event)
                 throws IfsException

Description copied from class: LibraryObject

Handles the specified event.

Specified by:

handleEvent in interface IfsEventHandler

Overrides:

handleEvent in class LibraryObject

Parameters:

event - the event

Throws:

IfsException - if the operation fails