oracle.ifs.server
Class S_ExportedLibraryObjectDefinition

java.lang.Object
  |
  +--oracle.ifs.server.S_LibraryObjectDefinition
        |
        +--oracle.ifs.server.S_ExportedLibraryObjectDefinition

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class S_ExportedLibraryObjectDefinition

extends S_LibraryObjectDefinition

The S_ExportedLibraryObjectDefinition class is a special subclass of S_LibraryObjectDefinition, used to export and import objects into and out from an iFs repository.

See Also:

Serialized Form

Field Summary

protected java.util.Vector	m_DirectoryObjectIdVector set of referenced DirectoryObject IDs
protected boolean	m_IsContentObject does this def reference a ContentObject?
protected java.util.Vector	m_PublicObjectIdVector set of referenced PublicObject IDs
protected java.util.Vector	m_SchemaObjectIdVector set of referenced SchemaObject IDs
protected LibrarySessionInterface	m_SessionInterface session that can be used to extract referenced objects
protected java.util.Vector	m_SystemObjectIdVector set of referenced SystemObject IDs

Constructor Summary

S_ExportedLibraryObjectDefinition()
Contructor a S_ExportedLibraryObjectDefinition.

S_ExportedLibraryObjectDefinition(java.lang.Long classid)
construct a S_ExportedLibraryObjectDefinition, initializing with a classId.

S_ExportedLibraryObjectDefinition(java.lang.Long classid, LibrarySessionInterface session)
construct a S_ExportedLibraryObjectDefinition, initializing with a classId.

Method Summary

void	addReferencedDirectoryObject(java.lang.Long id) add an id to the referenced DirectoryObject list
void	addReferencedPublicObject(java.lang.Long id) add an id to the referenced PublicObject list
void	addReferencedSchemaObject(java.lang.Long id) add an id to the referenced SchemaObject list
void	addReferencedSystemObject(java.lang.Long id) add an id to the referenced SystemObject list
protected AttributeValue	extractObjectReferences(java.lang.String attrName, AttributeValue av) extract any object references from specified AttributeValue.
DirectoryObjectInterface[]	getDirectoryObjectReferences(LibrarySessionInterface session) return any DirectoryObject references from specified AttributeValue.
PublicObjectInterface[]	getPublicObjectReferences(LibrarySessionInterface session) return any PublicObject references from specified AttributeValue.
SchemaObjectInterface[]	getSchemaObjectReferences(LibrarySessionInterface session) return any SchemaObject references from specified AttributeValue.
SystemObjectInterface[]	getSystemObjectReferences(LibrarySessionInterface session) return any SystemObject references from specified AttributeValue.
boolean	isContentObject() return true if this object describes a ContentObject
void	removeSystemSetAttribute(java.lang.String name) removes a system-set attribute setting for the new instance.
void	removeUserSetAttribute(java.lang.String name) removes a user-set attribute setting for the new instance.
void	setContentObjectIndication(boolean indication) Sets indication that this def describes a ContentObject
void	setSystemSetAttribute(java.lang.String name, AttributeValue value) set a system-set attribute for the new instance.
void	setUserSetAttribute(java.lang.String name, AttributeValue value) set an attribute for the new instance.

Methods inherited from class oracle.ifs.server.S_LibraryObjectDefinition

getAttribute, getAttributes, getClassId, getId, getOption, getSystemSetAttribute, getSystemSetAttributes, getUserSetAttribute, getUserSetAttributes, mergeDefinition, removeAttribute, removeOption, setClassId, setId, setOption, setSystemSetAttribute, setUserSetAttribute

Field Detail

m_SchemaObjectIdVector

protected java.util.Vector m_SchemaObjectIdVector

set of referenced SchemaObject IDs

m_SystemObjectIdVector

protected java.util.Vector m_SystemObjectIdVector

set of referenced SystemObject IDs

m_PublicObjectIdVector

protected java.util.Vector m_PublicObjectIdVector

set of referenced PublicObject IDs

m_DirectoryObjectIdVector

protected java.util.Vector m_DirectoryObjectIdVector

set of referenced DirectoryObject IDs

m_IsContentObject

protected boolean m_IsContentObject

does this def reference a ContentObject?

m_SessionInterface

protected transient LibrarySessionInterface m_SessionInterface

session that can be used to extract referenced objects

Constructor Detail

S_ExportedLibraryObjectDefinition

public S_ExportedLibraryObjectDefinition()
                                  throws IfsException

Contructor a S_ExportedLibraryObjectDefinition.

Throws:

IfsException - if operation fails.

S_ExportedLibraryObjectDefinition

public S_ExportedLibraryObjectDefinition(java.lang.Long classid)
                                  throws IfsException

construct a S_ExportedLibraryObjectDefinition, initializing with a classId. Empty hashtables are created for the attributes, options, and systemOptions. This variant is called in S_LO.getDefinition().

Parameters:

classid - The class ID

Throws:

IfsException - if operation fails.

S_ExportedLibraryObjectDefinition

public S_ExportedLibraryObjectDefinition(java.lang.Long classid,
                                         LibrarySessionInterface session)
                                  throws IfsException

construct a S_ExportedLibraryObjectDefinition, initializing with a classId. Empty hashtables are created for the attributes, options, and systemOptions. This variant is called in S_LO.getDefinition().

Parameters:

classid - The class ID

session - The session

Throws:

IfsException - if operation fails.

Method Detail

setUserSetAttribute

public void setUserSetAttribute(java.lang.String name,
                                AttributeValue value)
                         throws IfsException

set an attribute for the new instance. Extend this method to extract any object references.

Overrides:

setUserSetAttribute in class S_LibraryObjectDefinition

Parameters:

name - The attribute name

value - The attribute value.

Throws:

IfsException - if operation fails.

setSystemSetAttribute

public void setSystemSetAttribute(java.lang.String name,
                                  AttributeValue value)
                           throws IfsException

set a system-set attribute for the new instance. Extend this method to extract any object references.

Overrides:

setSystemSetAttribute in class S_LibraryObjectDefinition

Parameters:

name - The attribute name

value - The attribute value.

Throws:

IfsException - if operation fails.

removeUserSetAttribute

public void removeUserSetAttribute(java.lang.String name)
                            throws IfsException

removes a user-set attribute setting for the new instance. This override prevents the attribute from being removed.

Overrides:

removeUserSetAttribute in class S_LibraryObjectDefinition

Parameters:

name - The name of the user-set Attribute to be removed.

Throws:

IfsException - if operation fails.

removeSystemSetAttribute

public void removeSystemSetAttribute(java.lang.String name)
                              throws IfsException

removes a system-set attribute setting for the new instance. This override prevents the attribute from being removed.

Overrides:

removeSystemSetAttribute in class S_LibraryObjectDefinition

Parameters:

name - The name of the user-set Attribute to be removed.

Throws:

IfsException - if operation fails.

isContentObject

public boolean isContentObject()
                        throws IfsException

return true if this object describes a ContentObject

Returns:

true if this object describes a ContentObject

Throws:

IfsException - if operation fails.

getSchemaObjectReferences

public SchemaObjectInterface[] getSchemaObjectReferences(LibrarySessionInterface session)
                                                  throws IfsException

return any SchemaObject references from specified AttributeValue.

Parameters:

session - The session

Returns:

The array of SchemaObjects

Throws:

IfsException - if operation fails.

getSystemObjectReferences

public SystemObjectInterface[] getSystemObjectReferences(LibrarySessionInterface session)
                                                  throws IfsException

return any SystemObject references from specified AttributeValue.

Parameters:

session - The session

Returns:

The array of SystemObjects

Throws:

IfsException - if operation fails.

getPublicObjectReferences

public PublicObjectInterface[] getPublicObjectReferences(LibrarySessionInterface session)
                                                  throws IfsException

return any PublicObject references from specified AttributeValue.

Parameters:

session - The session

Returns:

The array of PublicObjects

Throws:

IfsException - if operation fails.

getDirectoryObjectReferences

public DirectoryObjectInterface[] getDirectoryObjectReferences(LibrarySessionInterface session)
                                                        throws IfsException

return any DirectoryObject references from specified AttributeValue.

Parameters:

session - The session

Returns:

The array of DirectoryObjects

Throws:

IfsException - if operation fails.

extractObjectReferences

protected AttributeValue extractObjectReferences(java.lang.String attrName,
                                                 AttributeValue av)
                                          throws IfsException

extract any object references from specified AttributeValue.

Parameters:

av - The attribute value.

Throws:

IfsException - if operation fails.

setContentObjectIndication

public void setContentObjectIndication(boolean indication)
                                throws IfsException

Sets indication that this def describes a ContentObject

Parameters:

indication - true if this is a contentObject

Throws:

IfsException - if operation fails.

addReferencedSchemaObject

public void addReferencedSchemaObject(java.lang.Long id)
                               throws IfsException

add an id to the referenced SchemaObject list

Overrides:

addReferencedSchemaObject in class S_LibraryObjectDefinition

Parameters:

id - The object id.

Throws:

IfsException - if operation fails.

addReferencedSystemObject

public void addReferencedSystemObject(java.lang.Long id)
                               throws IfsException

add an id to the referenced SystemObject list

Overrides:

addReferencedSystemObject in class S_LibraryObjectDefinition

Parameters:

id - The object id.

Throws:

IfsException - if operation fails.

addReferencedPublicObject

public void addReferencedPublicObject(java.lang.Long id)
                               throws IfsException

add an id to the referenced PublicObject list

Overrides:

addReferencedPublicObject in class S_LibraryObjectDefinition

Parameters:

id - The object id.

Throws:

IfsException - if operation fails.

addReferencedDirectoryObject

public void addReferencedDirectoryObject(java.lang.Long id)
                                  throws IfsException

add an id to the referenced DirectoryObject list

Overrides:

addReferencedDirectoryObject in class S_LibraryObjectDefinition

Parameters:

id - The object id.

Throws:

IfsException - if operation fails.