|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.ifs.beans.LibraryObject | +--oracle.ifs.beans.TieLibraryObject | +--oracle.ifs.beans.SchemaObject | +--oracle.ifs.beans.TieSchemaObject | +--oracle.ifs.beans.ClassObject
A ClassObject represents a class whose instances are persistently stored and managed by the iFS server.
When installed, iFS creates a number of ClassObjects. Some of these are used internally; others are for commonly-encountered data types in content management applications. A content management application can use these provided ClassObjects, or create its own by subclassing them.
Each ClassObject may define one or more Attributes for its data. In addition to these, a ClassObject inherits its superclass's Attributes.
Any time a ClassObject is created, altered, or removed, the in-progress Transaction is implicitly committed.
ClassObjectDefinition
Field Summary | |
static java.lang.String |
ABSTRACT_ATTRIBUTE
An indicator of whether this ClassObject is abstract. |
static java.lang.String |
BEANCLASSPATH_ATTRIBUTE
The fully-qualified classname of the Beans Java class used to represent instances of this ClassObject in the repository SDK. |
static java.lang.String |
CLASS_NAME
The class name for this class. |
static java.lang.String |
CLASSACL_ATTRIBUTE
The ClassAccessControlList that determines which users and/or groups can create instances of this ClassObject. |
static java.lang.String |
DATABASEOBJECTNAME_ATTRIBUTE
The base name for database objects used to store data for instances of this ClassObject. |
static java.lang.String |
DESCRIPTION_ATTRIBUTE
A textual description of this ClassObject. |
static java.lang.String |
FINAL_ATTRIBUTE
An indicator of whether this ClassObject is final. |
static java.lang.String |
PARTITIONED_ATTRIBUTE
An indicator of whether the database table that stores data for instances of this ClassObject is partitioned. |
static java.lang.String |
SELECTORCLASSPATH_ATTRIBUTE
The fully-qualified classname of the Beans Java class used to represent instances of this ClassObject in the repository SDK. |
static java.lang.String |
SERVERCLASSPATH_ATTRIBUTE
The fully-qualified classname of the Server Java class used to represent instances of this ClassObject in the repository service. |
static java.lang.String |
SUPERCLASS_ATTRIBUTE
The ClassObject that is the superclass of this ClassObject. |
static java.lang.String |
UNIQUENAME_ATTRIBUTE
A system-set attribute used to ensure each ClassObject has a unique Name. |
Fields inherited from class oracle.ifs.beans.SchemaObject |
ACTIVE_ATTRIBUTE, NAME_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE |
Method Summary | |
Attribute |
addAttribute(AttributeDefinition def)
Adds an Attribute to this ClassObject. |
Attribute |
getAttributeFromLabel(java.lang.String label)
returns the Attribute, based on the specified Attribute Label. |
java.lang.String |
getBeanClasspath()
Gets the fully-qualified name of the Java class instantiated to represent instances of this ClassObject within a document management application. |
ClassAccessControlList |
getClassAcl()
Gets the ClassAccessControlList of this ClassObject. |
static ClassObject |
getClassObjectFromLabel(LibrarySession sess,
java.lang.String label)
returns a ClassObject, based on a specified Label. |
java.lang.String |
getDatabaseObjectName()
Returns the Database Object Name. |
java.lang.String |
getDescription()
Returns the description of a Class Object. |
ClassObject[] |
getDirectSubclasses()
Gets the direct subclasses of this ClassObject. |
ClassObject |
getDirectSubclasses(int index)
Gets the specified direct subclass of this ClassObject. |
Attribute[] |
getEffectiveClassAttributes()
Gets the effective Attributes of this ClassObject. |
Attribute |
getEffectiveClassAttributes(int index)
Gets the specified effective Attribute of this ClassObject. |
Attribute |
getEffectiveClassAttributes(java.lang.String attributeName)
Gets the specified effective Attribute of this ClassObject. |
Attribute[] |
getExtendedClassAttributes()
Gets the extended Attributes of this ClassObject. |
Attribute[] |
getExtendedClassAttributes(ClassObject superclass)
Gets an array of the Attributes that this ClassObject has and that the specified superclass does not have. |
Attribute |
getExtendedClassAttributes(int index)
Gets the specified extended Attribute of this ClassObject. |
Attribute |
getExtendedClassAttributes(java.lang.String attributeName)
Gets the specified extended Attribute of this ClassObject. |
AttributeValue |
getInheritedPropertyValue(java.lang.String name)
gets named property, if any, by searching in the target ClassObject's PropertyBundle, or in one of its superclasses PropertyBundle. |
java.lang.String |
getLabel()
returns the Label for this Attribute, based on the Attribute's name and class. |
java.lang.String |
getSelectorClasspath()
Returns the SelectorClassPath Attribute of the Library Object. |
java.lang.String |
getServerClasspath()
Returns the ServerClassPath Attribute of the Library Object. |
ClassObject[] |
getSubclasses()
Gets the subclasses of this ClassObject. |
ClassObject |
getSubclasses(int index)
Gets the specified subclass of this ClassObject. |
ClassObject |
getSuperclass()
Gets the superclass of this ClassObject. |
boolean |
isAbstract()
Determines if this is an abstract object. |
boolean |
isAttribute(java.lang.String attrName)
Gets whether this ClassObject has an Attribute with the specified name. |
boolean |
isDirectSubclassOf(ClassObject classObject)
Gets whether this ClassObject is a direct subclass of the specified ClassObject. |
boolean |
isFinal()
Determines if this is object cannot be sub-classed. |
boolean |
isSubclassOf(ClassObject classObject)
Gets whether this ClassObject is a subclass of the specified ClassObject. |
boolean |
isVersionable()
Gets whether instances of this ClassObject are versionable. |
void |
putPolicy(Policy policy)
Adds a Policy to the policy bundle PropertyBundle of this ClassObject. |
void |
removeAllPolicies()
Removes all Policy objects from this ClassObject's policy bundle PropertyBundle, leaving an empty PropertyBundle. |
void |
removeAttribute(Attribute attribute)
Removes an Attribute from this ClassObject. |
void |
removePolicy(Policy policy)
Removes a Policy from this ClassObject's policy bundle PropertyBundle. |
void |
removePolicy(java.lang.String opname)
Removes a Policy from this ClassObject's policy bundle PropertyBundle. |
void |
setBeanClasspath(java.lang.String javaClassName)
Sets the fully-qualified name of the Java class instantiated to represent instances of this ClassObject within a document management application. |
void |
setClassAcl(ClassAccessControlList acl)
Sets the ClassAccessControlList of this ClassObject. |
void |
setDescription(java.lang.String description)
Sets the description of this ClassObject. |
void |
setPolicyBundle(PolicyPropertyBundle bundle)
Sets the policy bundle PropertyBundle of this ClassObject. |
void |
setSelectorClasspath(java.lang.String path)
Sets the Selector Class Path attribute. |
void |
setServerClasspath(java.lang.String path)
Sets the Server Class Path attribute. |
Methods inherited from class oracle.ifs.beans.SchemaObject |
getPolicyBundle, getPropertyBundle, hasNameAttribute, isActive, putProperty, putProperty, removeAllProperties, removeProperty, setActive, setPropertyBundle |
Methods inherited from class oracle.ifs.beans.LibraryObject |
equals, free, free, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getClassId, getClassObject, getDefinition, getId, getName, getSession, handleEvent, invokeServerMethod, isInstanceOf, isTraced, lookupInstanceLabel, postEvent, postEvent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setName, toString, trace, update |
Methods inherited from interface oracle.ifs.common.LibraryObjectInterface |
getId |
Methods inherited from interface oracle.ifs.common.Traceable |
getTraceLogger, isTraced, trace |
Field Detail |
public static final java.lang.String CLASS_NAME
public static final java.lang.String SUPERCLASS_ATTRIBUTE
public static final java.lang.String DESCRIPTION_ATTRIBUTE
public static final java.lang.String SERVERCLASSPATH_ATTRIBUTE
public static final java.lang.String BEANCLASSPATH_ATTRIBUTE
public static final java.lang.String SELECTORCLASSPATH_ATTRIBUTE
public static final java.lang.String DATABASEOBJECTNAME_ATTRIBUTE
public static final java.lang.String CLASSACL_ATTRIBUTE
public static final java.lang.String ABSTRACT_ATTRIBUTE
public static final java.lang.String FINAL_ATTRIBUTE
public static final java.lang.String PARTITIONED_ATTRIBUTE
public static final java.lang.String UNIQUENAME_ATTRIBUTE
Method Detail |
public java.lang.String getLabel() throws IfsException
getLabel
in class LibraryObject
IfsException
- if operation fails.public static ClassObject getClassObjectFromLabel(LibrarySession sess, java.lang.String label) throws IfsException
sess
- The LibrarySessionlabel
- The LabelIfsException
- if operation fails.public Attribute getAttributeFromLabel(java.lang.String label) throws IfsException
label
- the Attribute labelIfsException
- if operation fails.public java.lang.String getBeanClasspath() throws IfsException
IfsException
- if the operation failspublic void setDescription(java.lang.String description) throws IfsException
description
- the descriptionIfsException
- if the operation failspublic void setBeanClasspath(java.lang.String javaClassName) throws IfsException
javaClassName
- the classnameIfsException
- if the operation failspublic ClassAccessControlList getClassAcl() throws IfsException
IfsException
- if the operation failspublic void setClassAcl(ClassAccessControlList acl) throws IfsException
acl
- the ClassAccessControlListIfsException
- if the operation failspublic void setPolicyBundle(PolicyPropertyBundle bundle) throws IfsException
setPolicyBundle
in class SchemaObject
bundle
- the policy bundleIfsException
- if the operation failspublic void putPolicy(Policy policy) throws IfsException
If this ClassObject doesn't have a policy bundle, this method will throw an exception.
putPolicy
in class SchemaObject
policy
- the Policy to addIfsException
- if the operation failspublic void removePolicy(java.lang.String opname) throws IfsException
This method does not cause a "dedicated" PropertyBundle to be created.
removePolicy
in class SchemaObject
opname
- the operation name of the Policy to removeIfsException
- if the operation failspublic void removePolicy(Policy policy) throws IfsException
This method does not cause a "dedicated" PropertyBundle to be created.
removePolicy
in class SchemaObject
policy
- the Policy to removeIfsException
- if the operation failspublic void removeAllPolicies() throws IfsException
This method does not cause a "dedicated" PropertyBundle to be created.
removeAllPolicies
in class SchemaObject
IfsException
- if the operation failspublic Attribute addAttribute(AttributeDefinition def) throws IfsException
def
- the AttributeDefinition of the new AttributeIfsException
- (IFS-30820) if the operation failspublic void removeAttribute(Attribute attribute) throws IfsException
attribute
- the Attribute to removeIfsException
- (IFS-30821) if the operation failspublic Attribute[] getEffectiveClassAttributes() throws IfsException
The effective Attributes of a ClassObject are both the Attributes introduced by the ClassObject itself as well as the Attributes the ClassObject inherits from its superclasses.
IfsException
- if the operation failspublic Attribute getEffectiveClassAttributes(int index) throws IfsException
The effective Attributes of a ClassObject are both the Attributes introduced by the ClassObject itself as well as the Attributes the ClassObject inherits from its superclasses.
index
- the zero-based indexIfsException
- if the operation failspublic Attribute getEffectiveClassAttributes(java.lang.String attributeName) throws IfsException
The effective Attributes of a ClassObject are both the Attributes introduced by the ClassObject itself as well as the Attributes the ClassObject inherits from its superclasses.
attributeName
- the Attribute nameIfsException
- if the operation failspublic Attribute[] getExtendedClassAttributes() throws IfsException
The extended Attributes of a ClassObject are only the Attributes introduced by the ClassObject itself, and do not include any Attributes the ClassObject inherits from its superclasses.
IfsException
- if the operation failspublic Attribute[] getExtendedClassAttributes(ClassObject superclass) throws IfsException
superclass
- a superclass of this ClassObjectIfsException
- (IFS-19001) if superclass
is
nullIfsException
- (IFS-19005) if superclass
is
not a superclass of this ClassObjectIfsException
- if the operation otherwise failspublic Attribute getExtendedClassAttributes(int index) throws IfsException
The extended Attributes of a ClassObject are only the Attributes introduced by the ClassObject itself, and do not include any Attributes the ClassObject inherits from its superclasses.
index
- the zero-based indexIfsException
- if the operation failspublic Attribute getExtendedClassAttributes(java.lang.String attributeName) throws IfsException
The extended Attributes of a ClassObject are only the Attributes introduced by the ClassObject itself, and do not include any Attributes the ClassObject inherits from its superclasses.
attributeName
- the Attribute nameIfsException
- if the operation failspublic boolean isAttribute(java.lang.String attrName) throws IfsException
the
- Attribute nameIfsException
- if the operation failspublic ClassObject getSuperclass() throws IfsException
IfsException
- if the operation failspublic ClassObject[] getDirectSubclasses() throws IfsException
The direct subclasses are the ClassObjects that directly extend this ClassObject.
IfsException
- if the operation failspublic ClassObject getDirectSubclasses(int index) throws IfsException
The direct subclasses are the ClassObjects that directly extend this ClassObject.
index
- the zero-based indexIfsException
- if the operation failspublic ClassObject[] getSubclasses() throws IfsException
The subclasses are the ClassObjects that directly extend this ClassObject and their subclasses, sub-subclasses, etc.
IfsException
- if the operation failspublic ClassObject getSubclasses(int index) throws IfsException
The subclasses are the ClassObjects that directly extend this ClassObject and their subclasses, sub-subclasses, etc.
index
- the zero-based indexIfsException
- if the operation failspublic boolean isDirectSubclassOf(ClassObject classObject) throws IfsException
classObject
- the ClassObject to testclassObject
IfsException
- (IFS-19001) if classObject
is nullpublic boolean isSubclassOf(ClassObject classObject) throws IfsException
classObject
- the ClassObject to testclassObject
IfsException
- (IFS-19001) if classObject
is nullpublic boolean isVersionable() throws IfsException
IfsException
- if the operation failspublic AttributeValue getInheritedPropertyValue(java.lang.String name) throws IfsException
name
- Property nameIfsException
- if the operation failspublic java.lang.String getDescription() throws IfsException
IfsException
- if the operation failspublic java.lang.String getServerClasspath() throws IfsException
IfsException
- if the operation failspublic void setServerClasspath(java.lang.String path) throws IfsException
path
- The server class pathIfsException
- if the operation fails.public java.lang.String getSelectorClasspath() throws IfsException
IfsException
- if the operation failspublic void setSelectorClasspath(java.lang.String path) throws IfsException
path
- The selector class pathIfsException
- if the operation fails.public java.lang.String getDatabaseObjectName() throws IfsException
IfsException
- if the operation fails.public boolean isAbstract() throws IfsException
IfsException
- if the operation fails.public boolean isFinal() throws IfsException
IfsException
- if the operation fails.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |