oracle.ifs.server

Class S_Property

java.lang.Object

oracle.ifs.server.S_LibraryObject

oracle.ifs.server.S_TieLibraryObject

oracle.ifs.server.S_SystemObject

oracle.ifs.server.S_TieSystemObject

oracle.ifs.server.S_Property

All Implemented Interfaces:

IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

S_TieProperty

public class S_Property
extends S_TieSystemObject

An S_Property is the server-side representation of a Property.

A Property describes a name/value pair of varying datatype, that can be used for multiple purposes to store iFS values.

Version:

2.0

Author:

Dave Long, David Pitfield

(Published)

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.server.S_LibraryObject

S_LibraryObject.MapInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_Resolved Whether the member variable shadows of the attribute values of this attribute have been populated.
protected AttributeValue	m_Value The attribute value of the Property attribute appropriate for its datatype.

Fields inherited from class oracle.ifs.server.S_LibraryObject

CASCADE_OP_COPY_PUBLICOBJECT_TO_CATEGORY, CASCADE_OP_COPY_PUBLICOBJECT_TO_RIGHT_RELATIONSHIP, CASCADE_OP_DELETE_FAMILY_TO_VERSIONSERIES, CASCADE_OP_DELETE_PUBLICOBJECT_TO_LEFT_RELATIONSHIP, CASCADE_OP_DELETE_PUBLICOBJECT_TO_RIGHT_RELATIONSHIP, CASCADE_OP_DELETE_PUBLICOBJECT_TO_VERSIONDESCRIPTION, CASCADE_OP_DELETE_RELATIONSHIP_TO_LEFT_PUBLICOBJECT, CASCADE_OP_DELETE_RELATIONSHIP_TO_RIGHT_PUBLICOBJECT, CASCADE_OP_DELETE_VERSIONDESCRIPTION_TO_PUBLICOBJECT, CASCADE_OP_DELETE_VERSIONDESCRIPTION_TO_VERSIONSERIES, CASCADE_OP_DELETE_VERSIONSERIES_TO_FAMILY, CASCADE_OP_DELETE_VERSIONSERIES_TO_VERSIONDESCRIPTION, CASCADE_OP_FREE_CATEGORY_TO_PUBLICOBJECT, CASCADE_OP_FREE_CATEGORY_TO_SCHEMAOBJECT, CASCADE_OP_FREE_CATEGORY_TO_SYSTEMOBJECT, CASCADE_OP_FREE_FAMILY_TO_VERSIONSERIES, CASCADE_OP_FREE_PUBLICOBJECT_TO_CATEGORY, CASCADE_OP_FREE_PUBLICOBJECT_TO_LEFT_RELATIONSHIP, CASCADE_OP_FREE_PUBLICOBJECT_TO_RIGHT_RELATIONSHIP, CASCADE_OP_FREE_PUBLICOBJECT_TO_VERSIONDESCRIPTION, CASCADE_OP_FREE_RELATIONSHIP_TO_LEFT_PUBLICOBJECT, CASCADE_OP_FREE_RELATIONSHIP_TO_RIGHT_PUBLICOBJECT, CASCADE_OP_FREE_SCHEMAOBJECT_TO_CATEGORY, CASCADE_OP_FREE_SYSTEMOBJECT_TO_CATEGORY, CASCADE_OP_FREE_VERSIONDESCRIPTION_TO_PUBLICOBJECT, CASCADE_OP_FREE_VERSIONDESCRIPTION_TO_VERSIONSERIES, CASCADE_OP_FREE_VERSIONSERIES_TO_FAMILY, CASCADE_OP_FREE_VERSIONSERIES_TO_VERSIONDESCRIPTION, CASCADE_OP_UNDEFINED, CASCADE_OP_UNDELETE_FAMILY_TO_VERSIONSERIES, CASCADE_OP_UNDELETE_PUBLICOBJECT_TO_LEFT_RELATIONSHIP, CASCADE_OP_UNDELETE_PUBLICOBJECT_TO_RIGHT_RELATIONSHIP, CASCADE_OP_UNDELETE_PUBLICOBJECT_TO_VERSIONDESCRIPTION, CASCADE_OP_UNDELETE_RELATIONSHIP_TO_LEFT_PUBLICOBJECT, CASCADE_OP_UNDELETE_RELATIONSHIP_TO_RIGHT_PUBLICOBJECT, CASCADE_OP_UNDELETE_VERSIONDESCRIPTION_TO_PUBLICOBJECT, CASCADE_OP_UNDELETE_VERSIONDESCRIPTION_TO_VERSIONSERIES, CASCADE_OP_UNDELETE_VERSIONSERIES_TO_FAMILY, CASCADE_OP_UNDELETE_VERSIONSERIES_TO_VERSIONDESCRIPTION, CASCADE_OP_UPDATE_CATEGORY_TO_PUBLICOBJECT, CASCADE_OP_UPDATE_CATEGORY_TO_SCHEMAOBJECT, CASCADE_OP_UPDATE_CATEGORY_TO_SYSTEMOBJECT, CASCADE_OP_UPDATE_PUBLICOBJECT_TO_CATEGORY, CASCADE_OP_UPDATE_SCHEMAOBJECT_TO_CATEGORY, CASCADE_OP_UPDATE_SYSTEMOBJECT_TO_CATEGORY, DEFAULT_RENDERER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	S_Property(S_LibrarySession ssession, Long classId) Constructs an S_Property.
protected	S_Property(S_LibrarySession ssession, S_LibraryObjectData data) Constructs an S_Property.

Method Summary

Modifier and Type	Method and Description
protected void	deriveDefinition(S_LibraryObjectDefinition sdef) Modifies the S_LibraryObjectDefinition for this class.
protected void	extendedPreInsert(OperationState opState, S_LibraryObjectDefinition sdef) Performs validation prior to an insert.
protected void	extendedPreUpdate(OperationState opState, S_LibraryObjectDefinition sdef) Performs validation prior to an update .
AttributeValue	getPropertyValue() Gets the value of the Property.
void	handleEvent(IfsEvent event) Handles the specified event.
void	invalidateState() Invalidate any information cached for this object.

Methods inherited from class oracle.ifs.server.S_SystemObject

addCategory, cascadeFree, createCategories, extendedPostInsert, extendedPostUpdate, getCategories, getCategories, getCategories, handleCascade, removeCategories, updateCategories, verifyCanCreate, verifyCanFree, verifyCanUpdate

Methods inherited from class oracle.ifs.server.S_LibraryObject

added, applyValueDefault, associatedPostFree, associatedPostInsert, associatedPreInsert, canPurge, cascadeCopy, cascadeUpdate, checkRequiredForInsert, checkSettable, clearArrayTypeAttributeValues, clearMapTypeAttributeValues, clonePublicObjectAttribute, constructIdArray, constructIdArray, copy, copy, copyVectorToLibraryObjectArray, createDefaultPolicyPropertyBundle, createDefaultPropertyBundle, createDefaultPropertyBundle, createInstance, deleteRows, deriveOwnerUniqueName, deriveOwnerUniqueName, deriveUppercasedAttribute, determineClassDomain, determinePolicy, determinePolicy, determineValueDefault, determineValueDomain, dispose, DYNInvalidateState, DYNLockRows, equals, equals, executePolicyOperation, extendedPostFree, extendedPreCopy, extendedPreFree, findPolicyFromPropertyBundleAv, free, free, getAttribute, getAttributeByUpperCaseName, getAuditCertificateName, getAuditDomainContext, getAuditEventFolderContext, getClassData, getClassId, getClassName, getClassObject, getContentStorageManager, getData, getDefinition, getEffectivePolicyActionContexts, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getId, getLibraryConnection, getName, getObjectReferenceAttribute, getPropertyBundle, getPropertyValue, getResourceString, getResourceString, getService, getSession, getSessionInterface, getTraceLogger, hashCode, hasNameAttribute, insertReferenceAttributes, insertRow, insertRows, invokeOperation, invokePolicyMethod, isAuditCertificateSecured, isBroadcastCreateEventEnabled, isInstanceOf, isPersistent, issueCascade, isTraced, lockRows, postEvent, postEvent, postFree, postInsert, postUpdate, preFree, preInsert, preUpdate, privilegedUpdate, removed, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, toString, trace, update, updateRows, validateStringArray, verifyCanGetContent, verifyCanSetContent, verifyCanSetPolicy, verifyPersistent, verifyWriteableTransactionInProgress

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

m_Value

protected AttributeValue m_Value

The attribute value of the Property attribute appropriate for its datatype.

(Unpublished)

m_Resolved

protected boolean m_Resolved

Whether the member variable shadows of the attribute values of this attribute have been populated.

(Unpublished)

Constructor Detail

S_Property

protected S_Property(S_LibrarySession ssession,
                     S_LibraryObjectData data)
              throws IfsException

Constructs an S_Property.

Parameters:

ssession - the session

data - the Property data

Throws:

IfsException - if the operation fails

(Unpublished)

S_Property

protected S_Property(S_LibrarySession ssession,
                     Long classId)
              throws IfsException

Constructs an S_Property.

This variant is used for objects that have not yet been created in the database.

Parameters:

ssession - the session

classId - the id of the class of the object being constructed

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

deriveDefinition

protected void deriveDefinition(S_LibraryObjectDefinition sdef)
                         throws IfsException

Modifies the S_LibraryObjectDefinition for this class.

This is called by getDefinition() on S_LibraryObject. It must call super.deriveDefinition() before applying any class-specific changes to the S_LibraryObjectDefinition object.

Overrides:

deriveDefinition in class S_SystemObject

Parameters:

sdef - the S_LibraryObjectDefinition that contains the definition of the target object.

Throws:

IfsException - if operation fails.

(Published)

getPropertyValue

public final AttributeValue getPropertyValue()
                                      throws IfsException

Gets the value of the Property.

Returns:

the value

Throws:

IfsException - if the operation fails

(Published)

extendedPreInsert

protected void extendedPreInsert(OperationState opState,
                                 S_LibraryObjectDefinition sdef)
                          throws IfsException

Performs validation prior to an insert.

Overrides:

extendedPreInsert in class S_SystemObject

Parameters:

opState - current operation state

sdef - the definition of the Property being created

Throws:

IfsException - (IFS-31600) if no values were specified

(Published)

extendedPreUpdate

protected void extendedPreUpdate(OperationState opState,
                                 S_LibraryObjectDefinition sdef)
                          throws IfsException

Performs validation prior to an update .

Overrides:

extendedPreUpdate in class S_SystemObject

Parameters:

opState - the operation state

sdef - the definition of the Property being updated

Throws:

IfsException - (IFS-31600) if no values were specified

(Published)

handleEvent

public void handleEvent(IfsEvent event)
                 throws IfsException

Handles the specified event.

Specified by:

handleEvent in interface IfsEventHandler

Overrides:

handleEvent in class S_LibraryObject

Parameters:

event - the event

Throws:

IfsException - if the operation fails

(Published)

invalidateState

public void invalidateState()
                     throws IfsException

Invalidate any information cached for this object.

In addition to the invalidation performed by our superclasses, indicate that we are not resolved.

Overrides:

invalidateState in class S_LibraryObject

Throws:

IfsException - if operation fails.

(Unpublished)