ObjectObj

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

OBEROn SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.oberon.ooql.sdk
Class ObjectObj

java.lang.Object
  com.oberon.ooql.sdk.OBBase
      com.oberon.ooql.sdk.ObjectBase
          com.oberon.ooql.sdk.ObjectObj

All Implemented Interfaces:: java.io.Serializable

public class ObjectObj
extends ObjectBase
implements java.io.Serializable
extends ObjectBase
implements java.io.Serializable

OBEROn object: defines application contextual objects

Version:: 5.0
See Also:: Serialized Form

Field Summary
`static int`	`OBJ_CLONE` Clone a Object
`static int`	`OBJ_CREATE` Create new Object
`static int`	`OBJ_REVISE` Revise a Object
`static int`	`REV_ALL` Object revision sequence: all revisions
`static int`	`REV_FIRST` Object revision sequence: first revision
`static int`	`REV_LAST` Object revision sequence: last revision
`static int`	`REV_NEXT` Object revision sequence: next revision
`static int`	`REV_PREV` Object revision sequence: previous revision

Fields inherited from class com.oberon.ooql.sdk.ObjectBase
bHasAccess, bsOptions, HIST_ADDLINK, HIST_CHANGECLASS, HIST_CHANGEHOLDER, HIST_CHANGELIFECYCLE, HIST_CHANGENAME, HIST_CHANGESPACE, HIST_CHANGETYPE, HIST_CLONE, HIST_CREATE, HIST_CUSTOM, HIST_DELEGATE, HIST_EDIT, HIST_FILEDELETE, HIST_FILEGET, HIST_FILELOCK, HIST_FILEPUT, HIST_FILERENAME, HIST_FILEUNLOCK, HIST_IGNORE, HIST_Length, HIST_LOCK, HIST_PROGRESS, HIST_REFUSE, HIST_REGRESS, HIST_REMOVELINK, HIST_REVISE, HIST_REVOKE, HIST_SETSTAGE, HIST_UNDO, HIST_UNLOCK, HIST_VALIDATE, LINK_HIST, OBJ_HIST

Fields inherited from class com.oberon.ooql.sdk.ObjectBase

bHasAccess, bsOptions, HIST_ADDLINK, HIST_CHANGECLASS, HIST_CHANGEHOLDER, HIST_CHANGELIFECYCLE, HIST_CHANGENAME, HIST_CHANGESPACE, HIST_CHANGETYPE, HIST_CLONE, HIST_CREATE, HIST_CUSTOM, HIST_DELEGATE, HIST_EDIT, HIST_FILEDELETE, HIST_FILEGET, HIST_FILELOCK, HIST_FILEPUT, HIST_FILERENAME, HIST_FILEUNLOCK, HIST_IGNORE, HIST_Length, HIST_LOCK, HIST_PROGRESS, HIST_REFUSE, HIST_REGRESS, HIST_REMOVELINK, HIST_REVISE, HIST_REVOKE, HIST_SETSTAGE, HIST_UNDO, HIST_UNLOCK, HIST_VALIDATE, LINK_HIST, OBJ_HIST

Constructor Summary
`ObjectObj()`
`ObjectObj(boolean imported)` Create a new ObjectObj instance
`ObjectObj(java.lang.String objectID)` Create a new ObjectObj instance
`ObjectObj(java.lang.String className, java.lang.String name, java.lang.String revision)` Create a new ObjectObj instance

Method Summary
`void`	`autocreate(java.lang.String autoNumberName, Framework framework)` Create the new ObjectObj instance on the database using an AutoNumber
`void`	`clone(boolean copyFiles, Framework framework)` Create the new ObjectObj instance on the database, cloning it from this ObjectObj
`void`	`clone(java.lang.String newName, java.lang.String newRevision, boolean copyFiles, Framework framework)` Create the new ObjectObj instance on the database cloning it from this ObjectObj
`void`	`create(Framework framework)` Create the new ObjectObj instance on the database
`void`	`delegate(ObjectDelegation delegation, Framework framework)` Enable one or more delegate Users to perform ObjectObj manipulation in place of the delegator User(s).
`void`	`destroy(Framework framework)` Remove the ObjectObj from the database.
`void`	`execute(java.lang.String methodName, java.util.Vector<?> args, Framework framework)` Execute a ObjectObj method.
`void`	`filedelete(FileOperator fileOperator, Framework framework)` Remove one or more files from ObjectObj
`void`	`fileget(FileOperator fileOperator, Framework framework)` Extract one or more files from the ObjectObj
`void`	`filelock(FileOperator fileOperator, Framework framework)` Lock one or more files attached to the ObjectObj
`void`	`fileput(FileOperator fileOperator, Framework framework)` Attach one or more files to the ObjectObj
`void`	`filerename(FileOperator fileOperator, Framework framework)` Rename / Move one or more files
`void`	`fileunlock(FileOperator fileOperator, Framework framework)` UnLock one or more files attached to the ObjectObj
`void`	`fromXML(org.jdom.Element rootElement)` Load the ObjectObj properties from XML element tree
`void`	`fromXML(org.jdom.Element rootElement, java.lang.String attachmentsPath)` Load the ObjectObj properties from XML element tree
`java.util.Vector<java.lang.String>`	`getActionNames(java.util.Vector<java.lang.Object> filterArgs, Framework framework)` Get the available action `MenuItem`s for this object, according to framework user rights
`java.util.Vector<MenuItem>`	`getActions(java.util.Vector<java.lang.Object> filterArgs, Framework framework)` Get the available action `MenuItem`s for this object, according to framework user rights
`java.lang.String`	`getAutoCreateCommand(java.lang.String autoNumberName)` Return the OOQL command to create this ObjectObj using a AutoNumber
`Class`	`getClass(Framework framework)` Get the ObjectObj's `Class`
`java.lang.String`	`getClassName()` Get the ObjectObj Class or type
`java.lang.String`	`getCloneCommand(boolean copyFiles)` Return the OOQL command to clone this ObjectObj with the settled properties
`java.lang.String`	`getCreateCommand()` Return the OOQL command to create this ObjectObj with the settled properties
`java.lang.String`	`getDefaultFileType()` Get the ObjectObj's default `FileType` for attached files
`ObjectDelegation`	`getDelegation(int index, Framework framework)` Get a ObjectObj's delegation.
`int`	`getDelegationCount(Framework framework)` Get the number of delegations active for this ObjectObj
`java.util.Vector<ObjectDelegation>`	`getDelegations(Framework framework)` Get the ObjectObj's delegations.
`java.lang.String`	`getDescription()` Get the ObjectObj's description
`java.lang.String`	`getFieldValue(java.lang.String fieldName, Framework framework)` Get a ObjectObj's `Field` value directly from DB
`ObjectFile`	`getFile(java.lang.String fileTypeName, java.lang.String fileName, Framework framework)` Get a ObjectObj's attached file.
`java.util.Vector<ObjectFile>`	`getFiles(Framework framework)` Get the ObjectObj's attached files.
`java.util.Vector<ObjectFile>`	`getFileTypeFile(java.lang.String fileTypeName, Framework framework)` Get the ObjectObj's attached files for a specific FileType.
`java.util.Vector<java.lang.String>`	`getFileTypes()` Get the ObjectObj's available `FileType`s for attached files
`byte[]`	`getImage()` Return the ObjectObj's icon
`static byte[]`	`getImage(java.lang.String objectId)` Return a ObjectObj's icon
`java.lang.String`	`getImageData()` Return the ObjectObj's icon codified as base64 string data
`java.lang.String`	`getImageFile()` Return the ObjectObj's icon file path.
`java.lang.String`	`getLifecycle()` Get the ObjectObj's `Lifecycle` name
`Lifecycle`	`getLifecycle(Framework framework)` Get the ObjectObj's `Lifecycle`
`java.util.Vector<Link>`	`getLinks()` Get the ObjectObj's Links [INTERNAL USAGE].
`java.util.Vector<java.lang.String>`	`getLinks(int linkVersus, java.lang.String linkType, Framework framework)` Get the ObjectObj's links
`java.lang.String`	`getLocker()` Get the ObjectObj's locker.
`java.lang.String`	`getName()` Get the ObjectObj's name
`int`	`getNextObjectId()` Get the ObjectObj's next revision internal id [INTERNAL USAGE]
`int`	`getNextObjectSpaceId()` Get the ObjectSpace for the ObjectObj's next revision [INTERNAL USAGE]
`java.lang.String`	`getObjectSpace()` Get the ObjectObj's container (`ObjectSpace`).
`int`	`getObjectSpaceId()` Get the ObjectObj's container (`ObjectSpace`) internal id.
`ObjectStage`	`getObjectStage(Framework framework)` Get the current ObjectObj's stage instance.
`ObjectStage`	`getObjectStage(java.lang.String stageName, Framework framework)` Get an ObjectObj's stage instance.
`java.util.Vector<ObjectStage>`	`getObjectStages(Framework framework)` Get the ObjectObj's stage instances.
`java.lang.String`	`getObjId()` Deprecated.
`java.lang.String`	`getOldClassName()` Get the original ObjectObj Class or type.
`java.lang.String`	`getOldDescription()` Get the original ObjectObj's description.
`java.lang.String`	`getOldLifecycle()` Get the original ObjectObj's `Lifecycle` name.
`java.lang.String`	`getOldName()` Get the original ObjectObj's name.
`java.lang.String`	`getOldObjectSpace()` Get the original ObjectObj's container (`ObjectSpace`).
`java.lang.String`	`getOldRevision()` Get the original ObjectObj's revision.
`java.lang.String`	`getOldStage()` Get the original ObjectObj's `Lifecycle`-`Stage` name.
`java.util.Vector<java.lang.String>`	`getOtherProcesses(Framework framework)` Get a Running processes where this object is involved.
`int`	`getPrevObjectId()` Get the ObjectObj's previous revision internal id [INTERNAL USAGE]
`int`	`getPrevObjectSpaceId()` Get the ObjectSpace for the ObjectObj's previous revision [INTERNAL USAGE]
`java.util.Vector<java.lang.String>`	`getProcesses(Framework framework)` Get a Running processes for this object.
`java.lang.String`	`getProperty(java.lang.String propertyName, java.util.Vector<java.lang.Object> filterArgs, java.lang.String token, Framework framework)` Get a property for this ObjectObj object by its OOQL identifier
`java.lang.String`	`getReviseCommand(boolean copyFiles)` Return the OOQL command to revise this ObjectObj with the settled properties
`java.lang.String`	`getRevision()` Get the ObjectObj's revision
`java.util.Vector<java.lang.String>`	`getRevisions(int revType, Framework framework)` Get the ObjectObj's revisions
`java.lang.String`	`getSaveCommand()` Return the OOQL command to update this ObjectObj with the modified properties.
`java.lang.String`	`getStage()` Get the current ObjectObj's `Lifecycle`-`Stage` name.
`Stage`	`getStage(Framework framework)` Get the current ObjectObj's `Lifecycle`-`Stage`
`java.util.Vector<java.lang.String>`	`getStageNames(Framework framework)` Get the list of Lifecycle-Stage names for this ObjectObj
`java.util.Vector<?>`	`getTargetNames(java.lang.String composedName, java.util.Vector<java.lang.Object> filterArgs, Framework framework)` Return a Vector of target names extracted by using an OOQL selector
`org.jdom.Element`	`getXMLDelegations(Framework framework)` Return the ObjectObj's delegations as XML element tree
`org.jdom.Element`	`getXMLFields(Framework framework)` Return the ObjectObj's `Field` values as XML element tree
`org.jdom.Element`	`getXMLFiles(Framework framework)` Return the ObjectObj's files as XML element tree
`org.jdom.Element`	`getXMLFiles(java.lang.String getFilePath, Framework framework)` Return the ObjectObj's files as XML element tree and download the content to the specified path
`org.jdom.Element`	`getXMLObjectStages(Framework framework)` Return the ObjectObj's stages as XML element tree
`boolean`	`hasImage()` Test if the object has an image
`void`	`ignore(java.lang.String validationName, java.lang.String note, Framework framework)` Ignore a Validation defined at current `Lifecycle`-`Stage`.
`boolean`	`isFilePresent(java.lang.String fileTypeName, Framework framework)` Check if the ObjectObj has attached files for a specific FileType.
`boolean`	`isImported()` Check if the ObjectObj data are imported from `Dump` file
`boolean`	`isLocked()` Check if the ObjectObj is locked
`void`	`link(boolean fullLoad, Framework framework)` Open the ObjectObj and read its properties from the database
`void`	`link(Framework framework)` Open the ObjectObj and read its properties from the database
`void`	`lock(Framework framework)` Lock the ObjectObj.
`void`	`move(java.lang.String objectSpaceName, Framework framework)` Move the ObjectObj from current ObjectSpace to another
`void`	`navigate(Navigator navigator, java.io.DataOutputStream outStream, Framework framework)` Navigate throw the ObjectObj in/out `Link`s
`void`	`navigate(Navigator navigator, Framework framework)` Navigate throw the ObjectObj in/out `Link`s
`static ObjectObj`	`open(java.lang.String objectID, boolean fullLoad, Framework framework)` Open an ObjectObj and read its properties from the database
`static ObjectObj`	`open(java.lang.String objectID, Framework framework)` Open an ObjectObj and read all properties from the database
`static ObjectObj`	`open(java.lang.String className, java.lang.String name, java.lang.String revision, boolean fullLoad, Framework framework)` Open an ObjectObj and read its properties from the database
`static ObjectObj`	`open(java.lang.String className, java.lang.String name, java.lang.String revision, java.lang.String objectSpaceName, boolean fullLoad, Framework framework)` Open an ObjectObj and read its properties from the database
`void`	`progress(Framework framework)` Promote the ObjectObj to the next `Stage` defined on its `Lifecycle`
`void`	`refuse(java.lang.String validationName, java.lang.String note, Framework framework)` Refuse a Validation defined at current `Lifecycle`-`Stage`.
`void`	`regress(Framework framework)` Regress the ObjectObj to the previous `Stage` defined on its `Lifecycle`
`void`	`resetDelegations()` Force reload `ObjectDelegation`s from DB
`void`	`resetHistory()` Force reload the Object History from DB
`void`	`resetObjectFiles()` Force reload `ObjectFile`s from DB
`void`	`resetObjectStages()` Force reload `ObjectStage`s from DB
`void`	`revise(boolean copyFiles, Framework framework)` Create the new ObjectObj instance on the database revising this ObjectObj
`void`	`revise(java.lang.String newRevision, boolean copyFiles, Framework framework)` Create the new ObjectObj instance on the database revising this ObjectObj
`void`	`revoke(ObjectDelegation delegation, Framework framework)` Disable one or more delegate Users to perform ObjectObj manipulation in place of the delegator User(s).
`void`	`setClass(Class classobj)` Set the ObjectObj's Class [INTERNAL USAGE]
`void`	`setClass(java.lang.String className)` Set the ObjectObj Class or type
`void`	`setDefaultFileType(java.lang.String defaultFileType)` Set the ObjectObj's default `FileType` [INTERNAL USAGE]
`void`	`setDescription(java.lang.String description)` Set the ObjectObj's description
`void`	`setFileTypes(java.util.Vector<java.lang.String> fileTypes)` Set the ObjectObj's `FileType`s [INTERNAL USAGE]
`void`	`setImage(byte[] image)` Set the ObjectObj's icon;
`void`	`setImageData(java.lang.String base64ImageData)` Set the ObjectObj's icon from a base64 string data;
`void`	`setImageFile(java.lang.String fileName)` Set the ObjectObj's icon importing it from a file;
`void`	`setLifecycle(Lifecycle lifecycle)` Set the ObjectObj's Lifecycle [INTERNAL USAGE]
`void`	`setLifecycle(java.lang.String lifecycleName)` Set the ObjectObj's Lifecycle
`void`	`setLinks(java.util.Vector<Link> links)` Set the ObjectObj's Links [INTERNAL USAGE].
`void`	`setLocker(java.lang.String userName)` Set the ObjectObj's locker [INTERNAL USAGE].
`void`	`setName(java.lang.String name)` Set the ObjectObj's name
`void`	`setNextObjectId(int objectId)` Set the ObjectObj's next revision internal id [INTERNAL USAGE]
`void`	`setNextObjectSpaceId(int objectSpaceId)` Set the ObjectSpace for the ObjectObj's next revision [INTERNAL USAGE]
`void`	`setObjectFiles(java.util.Vector<ObjectFile> files)` Set the ObjectObj's attached files [INTERNAL USAGE].
`void`	`setObjectSpace(java.lang.String objectSpaceName)` Set the ObjectObj's container (ObjectSpace)
`void`	`setObjectSpaceId(int objectSpaceId)` Set the ObjectObj's container (ObjectSpace) [INTERNAL USAGE]
`void`	`setObjectStages(java.util.Vector<ObjectStage> stages)` Set the ObjectObj's stage instances [INTERNAL USAGE].
`void`	`setPrevObjectId(int objectId)` Set the ObjectObj's previous revision internal id [INTERNAL USAGE]
`void`	`setPrevObjectSpaceId(int objectSpaceId)` Set the ObjectSpace for the ObjectObj's previous revision [INTERNAL USAGE]
`void`	`setRevision(java.lang.String revision)` Set the ObjectObj's revision
`void`	`setStage(java.lang.String stageName)` Set the ObjectObj's Lifecycle-Stage
`void`	`setstage(java.lang.String stageName, Framework framework)` Force the ObjectObj to a specific `Stage` defined on its current `Lifecycle`
`void`	`show(Selector selector, java.io.DataOutputStream outStream, Framework framework)` Show the ObjectObj's properties
`void`	`show(Selector selector, Framework framework)` Show the ObjectObj's properties
`void`	`synchronize(java.lang.String syncFrom, java.util.Vector<java.lang.String> syncTo, boolean force, boolean add, Framework framework)` Synchronize the attached files.
`org.jdom.Element`	`toBasicXML(Framework framework)` Return the ObjectObj basic properties (id, Class name, name, revision) as XML element tree
`java.lang.String`	`toString()` Return the ObjectObj basic properties as String
`java.lang.String`	`toString(Framework framework)` Return the ObjectObj properties as a single String
`org.jdom.Element`	`toXML(boolean getImage, boolean getHistory, java.lang.String getFilePath, boolean getValidations, Framework framework)` Return the ObjectObj properties as XML element tree
`org.jdom.Element`	`toXML(Framework framework)` Return the ObjectObj simple properties as XML element tree
`void`	`undo(Framework framework)` Undo the last changes on field values
`void`	`undo(int iterNum, Framework framework)` Undo the changes on field values, recourse till the specific number of iteration
`void`	`unlink(Framework framework)` Close the ObjectObj: disconnect the memory instance from the database instance
`void`	`unlock(boolean unlockFiles, Framework framework)` UnLock the ObjectObj.
`void`	`unlock(Framework framework)` UnLock the ObjectObj and all its attached files A User can unlock a ObjectObj if he has unlock permission on it and the he is the locker.
`void`	`validate(java.lang.String validationName, java.lang.String note, Framework framework)` Validate (approve) a Validation defined at current `Lifecycle`-`Stage`.
`void`	`write(Framework framework)` Update the ObjectObj to the database

Methods inherited from class com.oberon.ooql.sdk.ObjectBase
addAltHolder, addHistory, formatHistory, formatXMLHistory, getAltHolders, getAltHoldersAsString, getCrtDate, getCurrentIteration, getFieldNames, getFieldValue, getFieldValues, getHistory, getHistory, getHistoryFromXML, getHistoryOptionAsString, getHistoryOptionId, getHolder, getID, getIteration, getModDate, getOldAltHolders, getOldHolder, getSyncCounter, getXMLHistory, removeAllHistory, removeAltHolder, removeHistory, resetFieldValues, resetID, setCrtDate, setFieldValue, setFieldValue, setFieldValue, setFieldValues, setHistory, setHolder, setID, setModDate, setSyncCounter, show, updateAltHolders

Methods inherited from class com.oberon.ooql.sdk.ObjectBase

addAltHolder, addHistory, formatHistory, formatXMLHistory, getAltHolders, getAltHoldersAsString, getCrtDate, getCurrentIteration, getFieldNames, getFieldValue, getFieldValues, getHistory, getHistory, getHistoryFromXML, getHistoryOptionAsString, getHistoryOptionId, getHolder, getID, getIteration, getModDate, getOldAltHolders, getOldHolder, getSyncCounter, getXMLHistory, removeAllHistory, removeAltHolder, removeHistory, resetFieldValues, resetID, setCrtDate, setFieldValue, setFieldValue, setFieldValue, setFieldValues, setHistory, setHolder, setID, setModDate, setSyncCounter, show, updateAltHolders

Methods inherited from class com.oberon.ooql.sdk.OBBase
`addChange, addUniqueChange, ChangesFromXML, ChangesToXML, getChanges, getChangesAsString, getId, isLinked, removeChange, resetChanges, setId, setLinked`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

OBJ_CREATE

public static final int OBJ_CREATE

Create new Object

See Also:: Constant Field Values

OBJ_CLONE

public static final int OBJ_CLONE

Clone a Object

See Also:: Constant Field Values

OBJ_REVISE

public static final int OBJ_REVISE

Revise a Object

See Also:: Constant Field Values

REV_ALL

public static final int REV_ALL

Object revision sequence: all revisions

See Also:: Constant Field Values

REV_PREV

public static final int REV_PREV

Object revision sequence: previous revision

See Also:: Constant Field Values

REV_NEXT

public static final int REV_NEXT

Object revision sequence: next revision

See Also:: Constant Field Values

REV_FIRST

public static final int REV_FIRST

Object revision sequence: first revision

See Also:: Constant Field Values

REV_LAST

public static final int REV_LAST

Object revision sequence: last revision

See Also:: Constant Field Values

Constructor Detail

ObjectObj

public ObjectObj()

ObjectObj

public ObjectObj(boolean imported)

Create a new ObjectObj instance

Parameters:: imported - true if the ObjectObj data are imported from Dump file [INTERNAL USAGE]

ObjectObj

public ObjectObj(java.lang.String objectID)

Create a new ObjectObj instance

Parameters:: objectID - the ObjectObj ID

ObjectObj

public ObjectObj(java.lang.String className,
                 java.lang.String name,
                 java.lang.String revision)
          throws OberonException

Create a new ObjectObj instance

Parameters:: className - the ObjectObj's Class name; name - the ObjectObj's name; revision - the ObjectObj's revision
Throws:: OberonException

Method Detail

open

public static ObjectObj open(java.lang.String objectID,
                             Framework framework)
                      throws OberonException

Open an ObjectObj and read all properties from the database

Parameters:: objectID - the ObjectObj ID; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions

open

public static ObjectObj open(java.lang.String objectID,
                             boolean fullLoad,
                             Framework framework)
                      throws OberonException

Open an ObjectObj and read its properties from the database

Parameters:: objectID - the ObjectObj ID; fullLoad - if false skips the image/icon and the Field values; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions

open

public static ObjectObj open(java.lang.String className,
                             java.lang.String name,
                             java.lang.String revision,
                             boolean fullLoad,
                             Framework framework)
                      throws OberonException

Open an ObjectObj and read its properties from the database

Parameters:: className - the ObjectObj's Class name; name - the ObjectObj's name; revision - the ObjectObj's revision; fullLoad - if false skips the image/icon and the Field values; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions

open

public static ObjectObj open(java.lang.String className,
                             java.lang.String name,
                             java.lang.String revision,
                             java.lang.String objectSpaceName,
                             boolean fullLoad,
                             Framework framework)
                      throws OberonException

Open an ObjectObj and read its properties from the database

Parameters:: className - the ObjectObj's Class name; name - the ObjectObj's name; revision - the ObjectObj's revision; objectSpaceName - the ObjectSpace's name; fullLoad - if false skips the image/icon and the Field values; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions
Since:: 1.3

link

public void link(Framework framework)
          throws OberonException

Open the ObjectObj and read its properties from the database

Parameters:: framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions

link

public void link(boolean fullLoad,
                 Framework framework)
          throws OberonException

Open the ObjectObj and read its properties from the database

Parameters:: fullLoad - if true load also the image/icon and the Field values; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions

create

public void create(Framework framework)
            throws OberonException

Create the new ObjectObj instance on the database

Parameters:: framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or trigger exceptions

autocreate

public void autocreate(java.lang.String autoNumberName,
                       Framework framework)
                throws OberonException

Create the new ObjectObj instance on the database using an AutoNumber

Parameters:: autoNumberName - the AutoNumber name; framework - the current framework The new ObjectObj will have the Class,Lifecycle and ObjectSpace associated to the AutoNumber. The name will be the next AutoNumber's value, while the revision will depend on the Lifecycle's revision rule.
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or trigger exceptions

clone

public void clone(boolean copyFiles,
                  Framework framework)
           throws OberonException

Create the new ObjectObj instance on the database, cloning it from this ObjectObj

Parameters:: copyFiles - if true all attached files will be replicated; framework - the current framework The Class will be the same;
new name and new revision must be settled separately
Lifecycle and ObjectSpace can be settled separately
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or trigger exceptions
Since:: 4.0

clone

public void clone(java.lang.String newName,
                  java.lang.String newRevision,
                  boolean copyFiles,
                  Framework framework)
           throws OberonException

Create the new ObjectObj instance on the database cloning it from this ObjectObj

Parameters:: newName - the new ObjectObj's name; newRevision - the new ObjectObj's revision; copyFiles - if true all attached files will be replicated; framework - the current framework The Class will be the same; Lifecycle and ObjectSpace can be settled separately
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or trigger exceptions

revise

public void revise(boolean copyFiles,
                   Framework framework)
            throws OberonException

Create the new ObjectObj instance on the database revising this ObjectObj

Parameters:: copyFiles - if true all attached files will be replicated; framework - the current framework The Class and name will be the same;
new revision, Lifecycle and ObjectSpace can be settled separately
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or trigger exceptions

revise

public void revise(java.lang.String newRevision,
                   boolean copyFiles,
                   Framework framework)
            throws OberonException

Create the new ObjectObj instance on the database revising this ObjectObj

Parameters:: newRevision - the new ObjectObj's revision; copyFiles - if true all attached files will be replicated; framework - the current framework The Class and name will be the same; Lifecycle and ObjectSpace can be settled separately
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or trigger exceptions

write

public void write(Framework framework)
           throws OberonException

Update the ObjectObj to the database

Parameters:: framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or trigger exceptions

undo

public void undo(Framework framework)
          throws OberonException

Undo the last changes on field values

Parameters:: framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or trigger exceptions
Since:: 3.0

undo

public void undo(int iterNum,
                 Framework framework)
          throws OberonException

Undo the changes on field values, recourse till the specific number of iteration

Parameters:: iterNum - the iteration number; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or trigger exceptions
Since:: 3.0

lock

public void lock(Framework framework)
          throws OberonException

Lock the ObjectObj. A User can lock a ObjectObj if he has lock permission on it and the ObjectObj isn't already locked.
If a ObjectObj is locked only the locker User can edit its properties or manage its attached files

Parameters:: framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or trigger exceptions

unlock

public void unlock(boolean unlockFiles,
                   Framework framework)
            throws OberonException

UnLock the ObjectObj. A User can unlock a ObjectObj if he has unlock permission on it and the he is the locker.
If a ObjectObj is locked only the locker User can edit its properties or manage its attached files.

Parameters:: unlockFiles - if true unlock all attached files; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or trigger exceptions

unlock

public void unlock(Framework framework)
            throws OberonException

UnLock the ObjectObj and all its attached files A User can unlock a ObjectObj if he has unlock permission on it and the he is the locker.
If a ObjectObj is locked only the locker User can edit its properties or manage its attached files.

Parameters:: framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or trigger exceptions

move

public void move(java.lang.String objectSpaceName,
                 Framework framework)
          throws OberonException

Move the ObjectObj from current ObjectSpace to another

Parameters:: objectSpaceName - the new ObjectSpace name; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or trigger exceptions

unlink

public void unlink(Framework framework)
            throws OberonException

Close the ObjectObj: disconnect the memory instance from the database instance

Parameters:: framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or trigger exceptions

destroy

public void destroy(Framework framework)
             throws OberonException

Remove the ObjectObj from the database. All Links and attached files will be destroyed too.

Parameters:: framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or trigger exceptions

fileput

public void fileput(FileOperator fileOperator,
                    Framework framework)
             throws java.io.IOException,
                    OberonException

Attach one or more files to the ObjectObj

Parameters:: fileOperator - contains all file informations (FileSpace,FileType,file name, overwrite and lock options ...); framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or Trigger exceptions or IO exceptions; java.io.IOException
See Also:: ObjectFile

fileget

public void fileget(FileOperator fileOperator,
                    Framework framework)
             throws java.io.IOException,
                    OberonException

Extract one or more files from the ObjectObj

Parameters:: fileOperator - contains all file informations (FileType,file name,lock option ...); framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or Trigger exceptions or IO exceptions; java.io.IOException

filerename

public void filerename(FileOperator fileOperator,
                       Framework framework)
                throws OberonException

Rename / Move one or more files

Parameters:: fileOperator - contains all file informations (FileSpace,FileType,file name and their new values); framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or Trigger exceptions or IO exceptions

filedelete

public void filedelete(FileOperator fileOperator,
                       Framework framework)
                throws OberonException

Remove one or more files from ObjectObj

Parameters:: fileOperator - contains all file informations (FileSpace,FileType,file name ...); framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or Trigger exceptions or IO exceptions

filelock

public void filelock(FileOperator fileOperator,
                     Framework framework)
              throws OberonException

Lock one or more files attached to the ObjectObj

Parameters:: fileOperator - contains all file informations (FileSpace,FileType,file name ...); framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or Trigger exceptions or IO exceptions

fileunlock

public void fileunlock(FileOperator fileOperator,
                       Framework framework)
                throws OberonException

UnLock one or more files attached to the ObjectObj

Parameters:: fileOperator - contains all file informations (FileSpace,FileType,file name ...); framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or Trigger exceptions or IO exceptions

synchronize

public void synchronize(java.lang.String syncFrom,
                        java.util.Vector<java.lang.String> syncTo,
                        boolean force,
                        boolean add,
                        Framework framework)
                 throws OberonException

Synchronize the attached files. Replicate the files from a LocalArea (syncFrom) to the FileSpace and to other LocalAreas:
- files are first copied to the FileSpace if they are more recent or if the force flag is true
- files are replicated from FileSpace to the LocalArea in the syncTo list if they are more recent or if the force flag is true
If both syncFrom and syncTo are not defined the full synchronization is made

Parameters:: syncFrom - the reference LocalArea name (if empty use the FileSpace as reference); syncTo - vector of destination LocalArea names; force - replace files also if they are more recent; add - add file if it doesn't exist; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights

navigate

public void navigate(Navigator navigator,
                     Framework framework)
              throws OberonException,
                     java.io.IOException

Navigate throw the ObjectObj in/out Links

Parameters:: navigator - contains all navigation conditions (LinkType and Class patterns,filters,selectors ...); framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions; java.io.IOException

navigate

public void navigate(Navigator navigator,
                     java.io.DataOutputStream outStream,
                     Framework framework)
              throws OberonException,
                     java.io.IOException

Navigate throw the ObjectObj in/out Links

Parameters:: navigator - contains all navigation conditions (LinkType and Class patterns,filters,selectors ...); outStream - the stream for the results (if null the result is stored into the framework); framework - the current framework
Throws:: java.io.IOException - when the output stream returns an exception; OberonException - usually due to DB SQL exceptions
Since:: 4.0

setstage

public void setstage(java.lang.String stageName,
                     Framework framework)
              throws OberonException

Force the ObjectObj to a specific Stage defined on its current Lifecycle

Parameters:: stageName - the Stage name; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or Trigger exceptions

progress

public void progress(Framework framework)
              throws OberonException

Promote the ObjectObj to the next Stage defined on its Lifecycle

Parameters:: framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or Trigger exceptions

regress

public void regress(Framework framework)
             throws OberonException

Regress the ObjectObj to the previous Stage defined on its Lifecycle

Parameters:: framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or Trigger exceptions

validate

public void validate(java.lang.String validationName,
                     java.lang.String note,
                     Framework framework)
              throws OberonException

Validate (approve) a Validation defined at current Lifecycle-Stage. When all Validations are Validated or Ignored for a specific Stage path the ObjectObj can be (auto)promoted to the relative fork Stage.

Parameters:: validationName - the Validation name; note - add a comment to the Validation; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or Trigger exceptions
See Also:: ObjectValidation

ignore

public void ignore(java.lang.String validationName,
                   java.lang.String note,
                   Framework framework)
            throws OberonException

Ignore a Validation defined at current Lifecycle-Stage. The Ignore status is equivalent to the Validate status for the Stage (fork) progress but is conceptually different for force that Validation represents.
When all Validations are Validated or Ignored for a specific Stage path the ObjectObj can be (auto)promoted to the relative fork Stage.

Parameters:: validationName - the Validation name; note - add a comment to the Validation; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or Trigger exceptions
See Also:: ObjectValidation

refuse

public void refuse(java.lang.String validationName,
                   java.lang.String note,
                   Framework framework)
            throws OberonException

Refuse a Validation defined at current Lifecycle-Stage.

Parameters:: validationName - the Validation name; note - add a comment to the Validation; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or Trigger exceptions
See Also:: ObjectValidation

execute

public void execute(java.lang.String methodName,
                    java.util.Vector<?> args,
                    Framework framework)
             throws OberonException

Execute a ObjectObj method.

Parameters:: methodName - the name of Program associated as methods (directly or indirectly) to the ObjectObj's Class; args - the Program arguments; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights or Program exceptions

delegate

public void delegate(ObjectDelegation delegation,
                     Framework framework)
              throws OberonException

Enable one or more delegate Users to perform ObjectObj manipulation in place of the delegator User(s). The access is valid if and only if the delegator is enabled to perform the same operation.

Parameters:: delegation - the delegation properties; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights

revoke

public void revoke(ObjectDelegation delegation,
                   Framework framework)
            throws OberonException

Disable one or more delegate Users to perform ObjectObj manipulation in place of the delegator User(s).

Parameters:: delegation - the delegation properties; framework - the current framework
Throws:: OberonException - usually due to DB SQL exceptions or to limited user access rights

show

public void show(Selector selector,
                 Framework framework)
          throws java.io.IOException,
                 OberonException

Show the ObjectObj's properties

Parameters:: selector - selection parameters (if null return all the object properties); framework - the current framework
Throws:: java.io.IOException; OberonException
Since:: 4.0
See Also:: Framework.getResult()

show

public void show(Selector selector,
                 java.io.DataOutputStream outStream,
                 Framework framework)
          throws java.io.IOException,
                 OberonException

Show the ObjectObj's properties

Specified by:: show in class ObjectBase

Parameters:: selector - selection parameters (if null return all the object properties); outStream - the stream for the results (if null the result is stored into the framework); framework - the current framework
Throws:: java.io.IOException - when the output stream return an exception; OberonException - for all other problems
See Also:: Framework.getResult()

isImported

public boolean isImported()

Check if the ObjectObj data are imported from Dump file

getObjId

@Deprecated
public java.lang.String getObjId()

Deprecated.

setClass

public void setClass(java.lang.String className)

Set the ObjectObj Class or type

Parameters:: className - the Class name

getOldClassName

public java.lang.String getOldClassName()

Get the original ObjectObj Class or type. (Ignore changes made with the setClass(String) method)

getClassName

public java.lang.String getClassName()

Get the ObjectObj Class or type

setClass

public void setClass(Class classobj)

Set the ObjectObj's Class [INTERNAL USAGE]

getClass

public Class getClass(Framework framework)
               throws OberonException

Get the ObjectObj's Class

Parameters:: framework - the current framework
Throws:: OberonException
Since:: 4.0

setName

public void setName(java.lang.String name)
             throws OberonException

Set the ObjectObj's name

Throws:: OberonException

getOldName

public java.lang.String getOldName()

Get the original ObjectObj's name. (Ignore changes made with the setName(String) method)

getName

public java.lang.String getName()

Get the ObjectObj's name

Specified by:: getName in class OBBase

setRevision

public void setRevision(java.lang.String revision)

Set the ObjectObj's revision

getOldRevision

public java.lang.String getOldRevision()

Get the original ObjectObj's revision. (Ignore changes made with the setRevision(String) method)

getRevision

public java.lang.String getRevision()

Get the ObjectObj's revision

setDescription

public void setDescription(java.lang.String description)

Set the ObjectObj's description

Specified by:: setDescription in class ObjectBase

getOldDescription

public java.lang.String getOldDescription()

Get the original ObjectObj's description. (Ignore changes made with the setDescription(String) method)

getDescription

public java.lang.String getDescription()

Get the ObjectObj's description

Specified by:: getDescription in class ObjectBase

setImage

public void setImage(byte[] image)

Set the ObjectObj's icon;

Parameters:: image - the image data

getImage

public byte[] getImage()

Return the ObjectObj's icon

Returns:: the image data

setImageFile

public void setImageFile(java.lang.String fileName)

Set the ObjectObj's icon importing it from a file;

Parameters:: fileName - the image file absolute path

getImageFile

public java.lang.String getImageFile()

Return the ObjectObj's icon file path. The path is not stored on DB

Returns:: the image file absolute path previously settled
See Also:: setImageFile(String)

setImageData

public void setImageData(java.lang.String base64ImageData)

Set the ObjectObj's icon from a base64 string data;

Parameters:: base64ImageData - the base64 image data

getImageData

public java.lang.String getImageData()

Return the ObjectObj's icon codified as base64 string data

Returns:: the base64 string representing the image data

hasImage

public boolean hasImage()

Test if the object has an image

Since:: 4.0

getImage

public static byte[] getImage(java.lang.String objectId)
                       throws OberonException

Return a ObjectObj's icon

Parameters:: objectId - the ObjectObj's Id
Returns:: the image data
Throws:: OberonException

getFieldValue

public java.lang.String getFieldValue(java.lang.String fieldName,
                                      Framework framework)
                               throws java.sql.SQLException,
                                      OberonException

Get a ObjectObj's Field value directly from DB

Specified by:: getFieldValue in class ObjectBase

Parameters:: fieldName - the Field name; framework - the current framework
Throws:: java.sql.SQLException; OberonException

setLocker

public void setLocker(java.lang.String userName)

Set the ObjectObj's locker [INTERNAL USAGE]. To lock the ObjectObj use the method

Parameters:: userName - the locker User name

getLocker

public java.lang.String getLocker()

Get the ObjectObj's locker.

Returns:: the locker User name or empty is the ObjectObj is not locked
See Also:: lock(Framework), unlock(Framework)

isLocked

public boolean isLocked()

Check if the ObjectObj is locked

See Also:: lock(Framework), unlock(Framework)

setDefaultFileType

public void setDefaultFileType(java.lang.String defaultFileType)

Set the ObjectObj's default FileType [INTERNAL USAGE]

getDefaultFileType

public java.lang.String getDefaultFileType()

Get the ObjectObj's default FileType for attached files

setObjectSpace

public void setObjectSpace(java.lang.String objectSpaceName)

Set the ObjectObj's container (ObjectSpace)

Parameters:: objectSpaceName - the ObjectSpace name

getObjectSpace

public java.lang.String getObjectSpace()

Get the ObjectObj's container (ObjectSpace).

getOldObjectSpace

public java.lang.String getOldObjectSpace()

Get the original ObjectObj's container (ObjectSpace). (Ignore changes made with the setObjectSpace(String) method)

setObjectSpaceId

public void setObjectSpaceId(int objectSpaceId)

Set the ObjectObj's container (ObjectSpace) [INTERNAL USAGE]

Parameters:: objectSpaceId - the ObjectSpace internal id

getObjectSpaceId

public int getObjectSpaceId()

Get the ObjectObj's container (ObjectSpace) internal id.

setLifecycle

public void setLifecycle(java.lang.String lifecycleName)

Set the ObjectObj's Lifecycle

Parameters:: lifecycleName - the Lifecycle name

getOldLifecycle

public java.lang.String getOldLifecycle()

Get the original ObjectObj's Lifecycle name. (Ignore changes made with the setLifecycle(String) method)

getLifecycle

public java.lang.String getLifecycle()

Get the ObjectObj's Lifecycle name

setLifecycle

public void setLifecycle(Lifecycle lifecycle)

Set the ObjectObj's Lifecycle [INTERNAL USAGE]

getLifecycle

public Lifecycle getLifecycle(Framework framework)
                       throws OberonException

Get the ObjectObj's Lifecycle

Parameters:: framework - the current framework
Throws:: OberonException
Since:: 4.0

setStage

public void setStage(java.lang.String stageName)

Set the ObjectObj's Lifecycle-Stage

Parameters:: stageName - the Stage name

getOldStage

public java.lang.String getOldStage()

Get the original ObjectObj's Lifecycle-Stage name. (Ignore changes made with the setStage(String) method)

getStage

public java.lang.String getStage()

Get the current ObjectObj's Lifecycle-Stage name.

getStageNames

public java.util.Vector<java.lang.String> getStageNames(Framework framework)

Get the list of Lifecycle-Stage names for this ObjectObj

Parameters:: framework - the current framework
Returns:: vector of Lifecycle-Stage names
Since:: 4.0

getStage

public Stage getStage(Framework framework)
               throws OberonException

Get the current ObjectObj's Lifecycle-Stage

Parameters:: framework - the current framework
Throws:: OberonException
Since:: 4.0

resetObjectStages

public void resetObjectStages()

Force reload ObjectStages from DB

Since:: 4.0

setObjectStages

public void setObjectStages(java.util.Vector<ObjectStage> stages)

Set the ObjectObj's stage instances [INTERNAL USAGE].

Parameters:: stages - vector of ObjectStages
Since:: 4.0

getObjectStages

public java.util.Vector<ObjectStage> getObjectStages(Framework framework)

Get the ObjectObj's stage instances.

Parameters:: framework - the current framework
Returns:: vector of ObjectStages
Since:: 4.0

getObjectStage

public ObjectStage getObjectStage(Framework framework)

Get the current ObjectObj's stage instance.

Parameters:: framework - the current framework
Since:: 4.0

getObjectStage

public ObjectStage getObjectStage(java.lang.String stageName,
                                  Framework framework)

Get an ObjectObj's stage instance.

Parameters:: stageName - the ObjectStage name; framework - the current framework
Since:: 4.0

setPrevObjectSpaceId

public void setPrevObjectSpaceId(int objectSpaceId)

Set the ObjectSpace for the ObjectObj's previous revision [INTERNAL USAGE]

Parameters:: objectSpaceId - the ObjectSpace internal id

getPrevObjectSpaceId

public int getPrevObjectSpaceId()

Get the ObjectSpace for the ObjectObj's previous revision [INTERNAL USAGE]

Returns:: the ObjectSpace internal id

setPrevObjectId

public void setPrevObjectId(int objectId)

Set the ObjectObj's previous revision internal id [INTERNAL USAGE]

Parameters:: objectId - the previous revision internal id

getPrevObjectId

public int getPrevObjectId()

Get the ObjectObj's previous revision internal id [INTERNAL USAGE]

Returns:: the previous revision internal id

setNextObjectSpaceId

public void setNextObjectSpaceId(int objectSpaceId)

Set the ObjectSpace for the ObjectObj's next revision [INTERNAL USAGE]

Parameters:: objectSpaceId - the ObjectSpace internal id

getNextObjectSpaceId

public int getNextObjectSpaceId()

Get the ObjectSpace for the ObjectObj's next revision [INTERNAL USAGE]

Returns:: the ObjectSpace internal id

setNextObjectId

public void setNextObjectId(int objectId)

Set the ObjectObj's next revision internal id [INTERNAL USAGE]

Parameters:: objectId - the next revision internal id

getNextObjectId

public int getNextObjectId()

Get the ObjectObj's next revision internal id [INTERNAL USAGE]

Returns:: the next revision internal id

getRevisions

public java.util.Vector<java.lang.String> getRevisions(int revType,
                                                       Framework framework)
                                                throws OberonException

Get the ObjectObj's revisions

Parameters:: revType - revision type ( can be one of REV_ALL,REV_FIRST,REV_PREV,REV_NEXT,REV_LAST ); framework - the current framework
Returns:: vector of revision Object Id(s)
Throws:: OberonException
Since:: 4.0

setFileTypes

public void setFileTypes(java.util.Vector<java.lang.String> fileTypes)

Set the ObjectObj's FileTypes [INTERNAL USAGE]

getFileTypes

public java.util.Vector<java.lang.String> getFileTypes()

Get the ObjectObj's available FileTypes for attached files

resetObjectFiles

public void resetObjectFiles()

Force reload ObjectFiles from DB

isFilePresent

public boolean isFilePresent(java.lang.String fileTypeName,
                             Framework framework)

Check if the ObjectObj has attached files for a specific FileType.

Parameters:: fileTypeName - the FileType name; framework - the current framework

setObjectFiles

public void setObjectFiles(java.util.Vector<ObjectFile> files)

Set the ObjectObj's attached files [INTERNAL USAGE]. To attach files use the method

Parameters:: files - vector of ObjectFiles

getFiles

public java.util.Vector<ObjectFile> getFiles(Framework framework)

Get the ObjectObj's attached files.

Parameters:: framework - the current framework
Returns:: vector of ObjectFiles

getFileTypeFile

public java.util.Vector<ObjectFile> getFileTypeFile(java.lang.String fileTypeName,
                                                    Framework framework)

Get the ObjectObj's attached files for a specific FileType.

Parameters:: fileTypeName - the FileType name; framework - the current framework
Returns:: vector of ObjectFiles

getFile

public ObjectFile getFile(java.lang.String fileTypeName,
                          java.lang.String fileName,
                          Framework framework)

Get a ObjectObj's attached file.

Parameters:: fileTypeName - the FileType name; fileName - the file name; framework - the current framework

resetDelegations

public void resetDelegations()

Force reload ObjectDelegations from DB

getDelegations

public java.util.Vector<ObjectDelegation> getDelegations(Framework framework)

Get the ObjectObj's delegations.

Parameters:: framework - the current framework
Returns:: vector of ObjectDelegations
Since:: 4.0

getDelegation

public ObjectDelegation getDelegation(int index,
                                      Framework framework)

Get a ObjectObj's delegation.

Parameters:: index - the delegation index in the delegation table; framework - the current framework
See Also:: delegate(ObjectDelegation, Framework), revoke(ObjectDelegation, Framework)

getDelegationCount

public int getDelegationCount(Framework framework)

Get the number of delegations active for this ObjectObj

Parameters:: framework - the current framework
See Also:: ObjectDelegation

getProcesses

public java.util.Vector<java.lang.String> getProcesses(Framework framework)

Get a Running processes for this object.

Parameters:: framework - the current framework
Returns:: vector of Process IDs
Since:: 2.1

getOtherProcesses

public java.util.Vector<java.lang.String> getOtherProcesses(Framework framework)

Get a Running processes where this object is involved.

Parameters:: framework - the current framework
Returns:: vector of Process IDs
Since:: 4.2

setLinks

public void setLinks(java.util.Vector<Link> links)

Set the ObjectObj's Links [INTERNAL USAGE].

Parameters:: links - vector of Links

getLinks

public java.util.Vector<Link> getLinks()

Get the ObjectObj's Links [INTERNAL USAGE]. To extract the ObjectObj's Links use the method

Returns:: vector of Links

getLinks

public java.util.Vector<java.lang.String> getLinks(int linkVersus,
                                                   java.lang.String linkType,
                                                   Framework framework)
                                            throws OberonException

Get the ObjectObj's links

Parameters:: linkVersus - the link versus ( can be one of Navigator.NAVIGATE_BOTH,Navigator.NAVIGATE_TO,Navigator.NAVIGATE_FROM ); linkType - the LinkType's name ( empty value = all linktypes ); framework - the current framework
Returns:: vector of Link Id(s)
Throws:: OberonException
Since:: 4.0

getActions

public java.util.Vector<MenuItem> getActions(java.util.Vector<java.lang.Object> filterArgs,
                                             Framework framework)
                                      throws OberonException

Get the available action MenuItems for this object, according to framework user rights

Parameters:: filterArgs - extra arguments used to compute the available actions; framework - the current framework
Returns:: vector of MenuItem elements
Throws:: OberonException
Since:: 2.5

getActionNames

public java.util.Vector<java.lang.String> getActionNames(java.util.Vector<java.lang.Object> filterArgs,
                                                         Framework framework)
                                                  throws OberonException

Get the available action MenuItems for this object, according to framework user rights

Parameters:: filterArgs - extra arguments used to compute the available actions; framework - the current framework
Returns:: vector of MenuItem names
Throws:: OberonException
Since:: 2.5

resetHistory

public void resetHistory()

Force reload the Object History from DB

getProperty

public java.lang.String getProperty(java.lang.String propertyName,
                                    java.util.Vector<java.lang.Object> filterArgs,
                                    java.lang.String token,
                                    Framework framework)

Get a property for this ObjectObj object by its OOQL identifier

Specified by:: getProperty in class OBBase

Parameters:: propertyName - OOQL property identifier/name (example: class , locker ...); filterArgs - extra arguments used to compute properties; token - separator token for complex properties; framework - the current framework
Returns:: the property value

getTargetNames

public java.util.Vector<?> getTargetNames(java.lang.String composedName,
                                          java.util.Vector<java.lang.Object> filterArgs,
                                          Framework framework)

Return a Vector of target names extracted by using an OOQL selector

Specified by:: getTargetNames in class OBBase

Parameters:: composedName - OOQL property identifier/name (example: field, filetype.file, .. ); filterArgs - extra arguments used to compute properties; framework - the current framework
Returns:: a Vector of target names, used to extract their (sub)properties values

getXMLFields

public org.jdom.Element getXMLFields(Framework framework)

Return the ObjectObj's Field values as XML element tree

Parameters:: framework - the current framework

getXMLObjectStages

public org.jdom.Element getXMLObjectStages(Framework framework)

Return the ObjectObj's stages as XML element tree

Parameters:: framework - the current framework
Since:: 4.0

getXMLDelegations

public org.jdom.Element getXMLDelegations(Framework framework)

Return the ObjectObj's delegations as XML element tree

Parameters:: framework - the current framework

getXMLFiles

public org.jdom.Element getXMLFiles(Framework framework)

Return the ObjectObj's files as XML element tree

Parameters:: framework - the current framework

getXMLFiles

public org.jdom.Element getXMLFiles(java.lang.String getFilePath,
                                    Framework framework)

Return the ObjectObj's files as XML element tree and download the content to the specified path

Parameters:: getFilePath - the path where download the file content; framework - the current framework

toBasicXML

public org.jdom.Element toBasicXML(Framework framework)

Return the ObjectObj basic properties (id, Class name, name, revision) as XML element tree

Parameters:: framework - the current framework

toXML

public org.jdom.Element toXML(Framework framework)

Return the ObjectObj simple properties as XML element tree

Parameters:: framework - the current framework

toXML

public org.jdom.Element toXML(boolean getImage,
                              boolean getHistory,
                              java.lang.String getFilePath,
                              boolean getValidations,
                              Framework framework)

Return the ObjectObj properties as XML element tree

Parameters:: getImage - true to include "imagedata" element with the base64 encoded image data; getHistory - true to include the history table; getFilePath - if not empty/null extracts the file content to the specified path; getValidations - true to include the Validation status; framework - the current framework

fromXML

public void fromXML(org.jdom.Element rootElement)

Load the ObjectObj properties from XML element tree

fromXML

public void fromXML(org.jdom.Element rootElement,
                    java.lang.String attachmentsPath)

Load the ObjectObj properties from XML element tree

toString

public java.lang.String toString()

Return the ObjectObj basic properties as String

Overrides:: toString in class java.lang.Object

Since:: 3.0

toString

public java.lang.String toString(Framework framework)

Return the ObjectObj properties as a single String

Parameters:: framework - the current framework

getCreateCommand

public java.lang.String getCreateCommand()

Return the OOQL command to create this ObjectObj with the settled properties

getAutoCreateCommand

public java.lang.String getAutoCreateCommand(java.lang.String autoNumberName)

Return the OOQL command to create this ObjectObj using a AutoNumber

Parameters:: autoNumberName - the AutoNumber name

getCloneCommand

public java.lang.String getCloneCommand(boolean copyFiles)

Return the OOQL command to clone this ObjectObj with the settled properties

Parameters:: copyFiles - true to replicate the attached files

getReviseCommand

public java.lang.String getReviseCommand(boolean copyFiles)

Return the OOQL command to revise this ObjectObj with the settled properties

Parameters:: copyFiles - true to replicate the attached files

getSaveCommand

public java.lang.String getSaveCommand()

Return the OOQL command to update this ObjectObj with the modified properties.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

OBEROn SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.oberon.ooql.sdk Class ObjectObj

OBJ_CREATE

OBJ_CLONE

OBJ_REVISE

REV_ALL

REV_PREV

REV_NEXT

REV_FIRST

REV_LAST

ObjectObj

ObjectObj

ObjectObj

ObjectObj

open

open

open

open

link

link

create

autocreate

clone

clone

revise

revise

write

undo

undo

lock

unlock

unlock

move

unlink

destroy

fileput

fileget

filerename

filedelete

filelock

fileunlock

synchronize

navigate

navigate

setstage

progress

regress

validate

ignore

refuse

execute

delegate

revoke

show

show

isImported

getObjId

setClass

getOldClassName

getClassName

setClass

getClass

setName

getOldName

getName

setRevision

getOldRevision

getRevision

setDescription

getOldDescription

getDescription

setImage

getImage

setImageFile

getImageFile

setImageData

getImageData

hasImage

getImage

getFieldValue

setLocker

com.oberon.ooql.sdk
Class ObjectObj