oracle.ifs.beans

Class PolicyList

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.beans.PolicyList

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TiePolicyList

public class PolicyList
extends TieSystemObject

PolicyList represents a set of PolicyListElements, in defining a set of policy behavior for LibraryObjects.

The order of the PolicyListElements is significant, and determines the executing of policy code as part of an iFS operation.

Version:

1.0

Author:

Dave Long

See Also:

PolicyListElement, Policy

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME This class name for this class.
static String	NAME_ATTRIBUTE The name of the PolicyList.

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	PolicyList(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a PolicyList object - standard variant.

Method Summary

Modifier and Type	Method and Description
static PolicyList[]	findAll(LibrarySession session) Returns the set of defined PolicyLists.
static PolicyList	findByName(LibrarySession session, String name) Returns the a PolicyList matching the specified name.
static LibraryObjectLookupCache	getLibraryObjectLookupCache(LibrarySessionInterface session) Returns the LibraryObjectLookupCache used by find PolicyList instances by name.
PolicyListElement[]	getPolicyListElements() Returns an array of PolicyListElement objects that are part of this PolicyList.

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, handleEvent, handleFree, handleUpdate, hashCode, hasNameAttribute, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, preFree, 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 the PolicyList.

See Also:

Constant Field Values

(Published)

Constructor Detail

PolicyList

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

Construct a PolicyList object - standard variant.

Parameters:

session - current Session

id - object ID

classId - the class ID

data - attributes

Throws:

IfsException

(Unpublished)

Method Detail

getPolicyListElements

public PolicyListElement[] getPolicyListElements()
                                          throws IfsException

Returns an array of PolicyListElement objects that are part of this PolicyList.

Returns:

array of PolicyListElements

Throws:

IfsException - if operation fails.

(Published)

getLibraryObjectLookupCache

public static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySessionInterface session)
                                                            throws IfsException

Returns the LibraryObjectLookupCache used by find PolicyList instances by name.

Parameters:

session - the session context

Returns:

the LibraryObjectLookupCache

Throws:

IfsException - if the operation fails.

findAll

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

Returns the set of defined PolicyLists.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of PolicyLists; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

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

Returns the a PolicyList matching the specified name.

Parameters:

session - the session context

name - the PolicyList name

Returns:

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

Throws:

IfsException - if the operation fails.