|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.ifs.beans.LibraryObject
The LibraryObject class is the base class for all persistent Internet File System objects. Functionality common to all such classes is provided by this class.
LibraryObjectDefinition
Method Summary | |
boolean |
equals(LibraryObject item)
Compares whether two LibraryObjects are the same IFS object. |
void |
free()
Permanently deletes this object. |
void |
free(LibraryObjectDefinition def)
Permanently removes this object from the repository, with options. |
AttributeValue |
getAttribute(java.lang.String attr_name)
Returns an AttributeValue object that holds the value of the requested attribute. |
AttributeValue |
getAttributeByUpperCaseName(java.lang.String attr_name)
Returns the attribute value for the specified attribute. |
AttributeValue[] |
getAttributes(java.lang.String[] attrNames)
Returns an array of AttributeValue objects that holds the values of the requested attributes. |
AttributeValue[] |
getAttributesByUpperCaseNames(java.lang.String[] attrNames)
Returns an array of AttributeValue objects that holds the values of the requested attributes. |
java.lang.Long |
getClassId()
Return this object's Class Id. |
ClassObject |
getClassObject()
Returns this object's class. |
LibraryObjectDefinition |
getDefinition()
Creates a LibraryObjectDefinition which represents this object. |
java.lang.Long |
getId()
Returns this object's ID (as a Long). |
java.lang.String |
getLabel()
Returns the Label for this object, based on the object's name. |
java.lang.String |
getName()
Returns the Name of this object, or null of this object does not have a NAME attribute. |
LibrarySession |
getSession()
Returns the LibrarySession in which this object was instantiated. |
void |
handleEvent(IfsEvent event)
Handles the specified event. |
protected boolean |
hasNameAttribute()
Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise. |
java.io.Serializable |
invokeServerMethod(java.lang.String methodName,
java.io.Serializable payload)
Invokes a custom server-side method. |
boolean |
isInstanceOf(ClassObject clss)
Determine if this is an instance of the specified ClassObject. |
boolean |
isTraced(int channel,
int level)
Gets whether tracing is enabled for the specified channel and level. |
java.lang.String |
lookupInstanceLabel()
Lookup the InstanceLabel for this object, and return null if no value is defined. |
void |
postEvent(int eventType,
int eventStatus)
Posts an event of the specified type and status. |
void |
postEvent(int eventType,
int eventSubtype,
int eventStatus,
long longPayload)
Posts an event of the specified type, subtype, and status. |
java.io.Reader |
renderAsReader(java.lang.String rendererType,
java.lang.String rendererName,
java.util.Hashtable options)
Renders this LibraryObject as a Reader. |
java.io.InputStream |
renderAsStream(java.lang.String rendererType,
java.lang.String rendererName,
java.util.Hashtable options)
Renders this LibraryObject as an InputStream. |
void |
setAttribute(AttributeValue attr_value)
Set this object's attribute to the specified value. |
void |
setAttribute(java.lang.String attr_name,
AttributeValue attr_value)
Set this object's attribute to the specified value. |
void |
setAttributes(AttributeValue[] attr_values)
Set this object's attributes to the specified values. |
void |
setAttributes(java.lang.String[] attr_names,
AttributeValue[] values)
Set the values for a list of Attributes in the database. |
void |
setName(java.lang.String name)
Set the Name of this object. |
java.lang.String |
toString()
returns the Name of this object, or null of the object does not have a NAME attribute. |
void |
trace(int channel,
int level,
java.lang.String payload)
Issues a trace request to the trace logger. |
void |
update(LibraryObjectDefinition def)
Updates this object from the attributes and options set in the specified LibraryObjectDefinition. |
Method Detail |
public java.lang.String getName() throws IfsException
IfsException
- if operation fails.protected boolean hasNameAttribute() throws IfsException
IfsException
- if operation fails.public java.lang.String getLabel() throws IfsException
IfsException
- if operation fails.public java.lang.String lookupInstanceLabel() throws IfsException
IfsException
- if operation fails.public java.lang.String toString()
toString
in class java.lang.Object
public void setName(java.lang.String name) throws IfsException
name
- the name of this object.IfsException
- if operation fails.public final AttributeValue getAttribute(java.lang.String attr_name) throws IfsException
attr_name
- the name of the AttributeIfsException
- if operation fails.public final AttributeValue getAttributeByUpperCaseName(java.lang.String attr_name) throws IfsException
toUpperCase
on the attribute name.attr_name
- the attribute name; must be all upper caseIfsException
- if the operation failspublic AttributeValue[] getAttributes(java.lang.String[] attrNames) throws IfsException
attr_names
- the names of the AttributesIfsException
- if operation fails.public AttributeValue[] getAttributesByUpperCaseNames(java.lang.String[] attrNames) throws IfsException
attrNames
- the names of the Attributes; must be all upper caseIfsException
- if operation fails.public void setAttribute(java.lang.String attr_name, AttributeValue attr_value) throws IfsException
attr_name
- the name of the Attributeattr_value
- the desired value of the AttributeIfsException
- if operation fails.public void setAttribute(AttributeValue attr_value) throws IfsException
attr_value
- the desired name & value of the AttributeIfsException
- if operation fails.public void setAttributes(java.lang.String[] attr_names, AttributeValue[] values) throws IfsException
attr_name
- the names of the Attributesvalues
- the desired values of the AttributesIfsException
- if operation fails.public void setAttributes(AttributeValue[] attr_values) throws IfsException
attr_values
- the desired name & values of the AttributesIfsException
- if operation fails.public void update(LibraryObjectDefinition def) throws IfsException
def
- the LibraryObjectDefinition describing the desired updates.IfsException
- if operation fails.public java.io.Serializable invokeServerMethod(java.lang.String methodName, java.io.Serializable payload) throws IfsException
methodName
- the method name.payload
- the method argumentIfsException
- if operation fails.public java.io.InputStream renderAsStream(java.lang.String rendererType, java.lang.String rendererName, java.util.Hashtable options) throws IfsException
The rendererType and rendererName together determine which Renderer implementation is to be used as follows:
If rendererName is not null, the Policy named rendererName for the operation specified by rendererType is obtained. The fully-qualified classname of the Renderer is contained in the IMPLEMENTATION attribute of that Policy.
If rendererName is null, the default Policy for this LibraryObject for the operation specified by rendererType is obtained. The fully- qualified classname of the Renderer is contained in the IMPLEMENTATION attribute of that Policy.
The values in the options Hashtable must be serializable.
rendererType
- the type of the desired RendererrendererName
- the name of the desired Rendereroptions
- any Renderer-specific optionsIfsException
- (IFS-30110) if the operation failspublic java.io.Reader renderAsReader(java.lang.String rendererType, java.lang.String rendererName, java.util.Hashtable options) throws IfsException
The rendererType and rendererName together determine which Renderer implementation is to be used as follows:
If rendererName is not null, the Policy named rendererName for the operation specified by rendererType is obtained. The fully-qualified classname of the Renderer is contained in the IMPLEMENTATION attribute of that Policy.
If rendererName is null, the default Policy for this LibraryObject for the operation specified by rendererType is obtained. The fully- qualified classname of the Renderer is contained in the IMPLEMENTATION attribute of that Policy.
The values in the options Hashtable must be serializable.
rendererType
- the type of the desired RendererrendererName
- the name of the desired Rendereroptions
- any Renderer-specific optionsIfsException
- (IFS-30110) if the operation failspublic LibrarySession getSession() throws IfsException
public boolean equals(LibraryObject item) throws IfsException
IfsException
- if operation fails.public ClassObject getClassObject() throws IfsException
IfsException
- if operation fails.public void free() throws IfsException
IfsException
- if operation fails.public void free(LibraryObjectDefinition def) throws IfsException
IfsException
- if operation fails.public java.lang.Long getId() throws IfsException
getId
in interface LibraryObjectInterface
IfsException
- if operation fails.public java.lang.Long getClassId() throws IfsException
public LibraryObjectDefinition getDefinition() throws IfsException
IfsException
- if operation fails.public boolean isInstanceOf(ClassObject clss) throws IfsException
IfsException
- if operation fails.public final boolean isTraced(int channel, int level) throws IfsException
isTraced
in interface Traceable
channel
- the channel numberlevel
- the levelIfsException
- (IFS-11201) if the channel is invalidpublic final void trace(int channel, int level, java.lang.String payload)
trace
in interface Traceable
channel
- the channel numberlevel
- the levelpayload
- a string containing any additional information to
be placed in the trace logpublic final void postEvent(int eventType, int eventStatus) throws IfsException
eventType
- the event type; must be one of the event type
constants enumerated in IfsEventeventStatus
- the event status; must be one of the event status
constants enumerated in IfsEventIfsException
- if the operation failspublic final void postEvent(int eventType, int eventSubtype, int eventStatus, long longPayload) throws IfsException
eventType
- the event type; must be one of the event type
constants enumerated in IfsEventeventSubtype
- the event subtype; the meaningful values are
eventType
varianteventStatus
- the event status; must be one of the event status
constants enumerated in IfsEventlongPayload
- the long payload; the meaningful values are
eventType
variantIfsException
- if the operation failspublic void handleEvent(IfsEvent event) throws IfsException
handleEvent
in interface IfsEventHandler
event
- the eventIfsException
- if the operation fails
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |