oracle.ifs.server

Class S_SchemaObject

java.lang.Object

oracle.ifs.server.S_LibraryObject

oracle.ifs.server.S_TieLibraryObject

oracle.ifs.server.S_SchemaObject

All Implemented Interfaces:

IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SchemaObjectInterface, Traceable

Direct Known Subclasses:

S_TieSchemaObject

public class S_SchemaObject
extends S_TieLibraryObject
implements SchemaObjectInterface

The S_SchemaObject class is the server side implementation of the iFS SCHEMAOBJECT class

Version:

1.0

Author:

Dave Long

(Published)

Nested Class Summary

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

S_LibraryObject.MapInfo

Field Summary

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_SchemaObject(S_LibrarySession session, Long classId) Construct a S_SchemaObject object.
protected	S_SchemaObject(S_LibrarySession session, S_LibraryObjectData data) Construct a S_SchemaObject object.

Method Summary

Modifier and Type	Method and Description
protected S_SchemaCategory	addCategory(SchemaCategoryDefinition catdef) Add a SchemaCategory to the target object.
protected void	cascadeFree(OperationState opState, S_LibraryObjectDefinition def) cascade operations to be performed before freeing an object.
protected void	deriveDefinition(S_LibraryObjectDefinition sdef) Add to the S_LibraryObjectDefinition for this class.
protected void	extendedPreInsert(OperationState opState, S_LibraryObjectDefinition sdef) Performs pre-insert actions.
protected void	extendedPreUpdate(OperationState opState, S_LibraryObjectDefinition sdef) Update any system attributes appropriate for creating this object
S_SchemaCategory[]	getCategories() Get all schema categories associated with this instance.
S_SchemaCategory[]	getCategories(S_ClassObject classobj) Returns the associated SchemaCategory objects that are instances of the ClassObject (or one of its subclasses) specified.
S_SchemaCategory[]	getCategories(SortSpecification sort) Get all Schemacategories associated with this instance.
protected void	handleCascade(OperationState opState, S_LibraryObject source, int cascadeType, S_LibraryObjectDefinition sdef, Object customArg) handle a cascaded operation initiated by (usually) another object.
boolean	hasNameAttribute() Override of hasNameAttribute(), to always return true for SchemaObjects
protected void	verifyCanCreate(S_LibraryObjectDefinition def) Verifies that the instance can be created.
protected void	verifyCanFree() Verifies that the instance can be freed.
protected void	verifyCanUpdate() Verifies that the instance can be updated.

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, extendedPostInsert, extendedPostUpdate, extendedPreCopy, extendedPreFree, findPolicyFromPropertyBundleAv, free, free, getAttribute, getAttributeByUpperCaseName, getAuditCertificateName, getAuditDomainContext, getAuditDomainContextFolder, getAuditEventFolderContext, getClassData, getClassId, getClassName, getClassObject, getContentStorageManager, getData, getDefinition, getEffectivePolicyActionContexts, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getId, getLibraryConnection, getName, getObjectReferenceAttribute, getPropertyBundle, getPropertyValue, getResourceString, getResourceString, getService, getSession, getSessionInterface, getTraceLogger, handleEvent, hashCode, insertReferenceAttributes, insertRow, insertRows, invalidateState, invokeOperation, invokePolicyMethod, isAuditCertificateSecured, isBroadcastCreateEventEnabled, isInstanceOf, isPersistent, issueCascade, isTraced, lockRows, postEvent, 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

Constructor Detail

S_SchemaObject

protected S_SchemaObject(S_LibrarySession session,
                         S_LibraryObjectData data)
                  throws IfsException

Construct a S_SchemaObject object. This is the standard variant.

Parameters:

session - current LibrarySession

data - Data component

Throws:

IfsException

(Unpublished)

S_SchemaObject

protected S_SchemaObject(S_LibrarySession session,
                         Long classId)
                  throws IfsException

Construct a S_SchemaObject object. This variant is used for objects taht have not been created in the database yet.

Parameters:

session - current LibrarySession

Throws:

IfsException

(Unpublished)

Method Detail

deriveDefinition

protected void deriveDefinition(S_LibraryObjectDefinition sdef)
                         throws IfsException

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

Overrides:

deriveDefinition in class S_LibraryObject

Parameters:

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

Throws:

IfsException - if operation fails.

(Published)

hasNameAttribute

public boolean hasNameAttribute()
                         throws IfsException

Override of hasNameAttribute(), to always return true for SchemaObjects

Overrides:

hasNameAttribute in class S_LibraryObject

Returns:

true (as SchemaObjects have a NAME attribute).

Throws:

IfsException - if operation fails.

(Published)

verifyCanCreate

protected void verifyCanCreate(S_LibraryObjectDefinition def)
                        throws IfsException

Verifies that the instance can be created. This is called as part of the createInstance sequence, but still requires admin-mode.

Overrides:

verifyCanCreate in class S_LibraryObject

Parameters:

def - the definition

Throws:

IfsException - if the operation fails

(Unpublished)

verifyCanUpdate

protected void verifyCanUpdate()
                        throws IfsException

Verifies that the instance can be updated. This is called as part of the update() sequence, but still requires admin-mode.

Overrides:

verifyCanUpdate in class S_LibraryObject

Throws:

IfsException - if the operation fails

(Unpublished)

verifyCanFree

protected void verifyCanFree()
                      throws IfsException

Verifies that the instance can be freed. This is called as part of the free() sequence, but still requires admin-mode.

Overrides:

verifyCanFree in class S_LibraryObject

Throws:

IfsException - if the operation fails

(Unpublished)

extendedPreInsert

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

Performs pre-insert actions.

Overrides:

extendedPreInsert in class S_LibraryObject

Parameters:

opState - current operation state

sdef - the definition for the insert operation

Throws:

IfsException - if the operation fails

(Published)

extendedPreUpdate

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

Update any system attributes appropriate for creating this object

Overrides:

extendedPreUpdate in class S_LibraryObject

Parameters:

opState - the operation state

sdef - current object definition to be updated with system attributes

Throws:

IfsException - if operation fails.

(Published)

handleCascade

protected void handleCascade(OperationState opState,
                             S_LibraryObject source,
                             int cascadeType,
                             S_LibraryObjectDefinition sdef,
                             Object customArg)
                      throws IfsException

handle a cascaded operation initiated by (usually) another object. This is overridden by classes to add custom handlers. It is ok if no class handles the cascade (that is implied to mean "no action needed").

Overrides:

handleCascade in class S_LibraryObject

Parameters:

opState - originating operation state

source - object initiating this cascade request (not necessarily the original object)

cascadeType - type of cascade request

sdef - original Definition object

customArg - any custom parameter.

Throws:

IfsException - if operation fails.

(Unpublished)

cascadeFree

protected void cascadeFree(OperationState opState,
                           S_LibraryObjectDefinition def)
                    throws IfsException

cascade operations to be performed before freeing an object. This is overridden by classes that need to perform operations before successfully freeing the rows for the freed instance.

Overrides:

cascadeFree in class S_LibraryObject

Parameters:

opState - originating operation state

def - original Definition object

Throws:

IfsException - if operation fails.

(Unpublished)

addCategory

protected S_SchemaCategory addCategory(SchemaCategoryDefinition catdef)
                                throws IfsException

Add a SchemaCategory to the target object.

Parameters:

catdef - the SchemaCategoryDefinition object that describes the system category to create

Returns:

the newly created SchemaCategory

Throws:

IfsException - if operation fails.

(Unpublished)

getCategories

public S_SchemaCategory[] getCategories()
                                 throws IfsException

Get all schema categories associated with this instance.

Returns:

the array of system category objects.

Throws:

IfsException - if the operation fails

(Published)

getCategories

public S_SchemaCategory[] getCategories(S_ClassObject classobj)
                                 throws IfsException

Returns the associated SchemaCategory objects that are instances of the ClassObject (or one of its subclasses) specified. Returns null if no SchemaCategory objects are associated.

Parameters:

classobj - the class of SchemaCategory

Returns:

array of SchemaCategory objects associated with the target object.

Throws:

IfsException - if operation fails.

(Published)

getCategories

public S_SchemaCategory[] getCategories(SortSpecification sort)
                                 throws IfsException

Get all Schemacategories associated with this instance.

Returns:

the array of Schemacategory objects.

Throws:

IfsException - if the operation fails

(Published)