com.oberon.ooql.sdk
Class ViewUserColumn

java.lang.Object
  com.oberon.ooql.sdk.ViewUserColumn

public class ViewUserColumn
extends java.lang.Object

View - Column instance associated to a specific user

Since:

4.0

Version:

3.1

Nested Class Summary

static class

ViewUserColumn.Value Value element: combines the effective value with display value

Constructor Summary

ViewUserColumn(Column column, java.util.Vector<java.lang.Object> filterArgs, Framework framework)
Constructor

ViewUserColumn(Column column, java.util.Vector<java.lang.Object> filterArgs, Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters)
Constructor

Method Summary

static ViewUserColumn	fromXML(org.jdom.Element rootElement) Create a ViewUserColumn object from XML element tree
Column	getColumn() Deprecated.
java.lang.String	getFormat() Get the Column format
java.lang.String	getGetLink() Get the OOQL Link selector for the Column content.
java.lang.String	getGetObject() Get the OOQL ObjectObj selector for the Column content.
java.lang.String	getLabel() Return the Column label
java.lang.String	getName() Return the Column name
ViewUserColumn.Value[]	getValues() Get the Column values
double	getWidth() Get the Column width
boolean	isHidden() Check if the Column is hidden
boolean	isModifiable() Check if the Column data are modifiable by framework user
void	setLabel(java.lang.String label) Set the Column label
void	setValues(ViewUserColumn.Value[] values) Set the Column values
java.lang.String	toString() Show the View Column status for the current framework user
org.jdom.Element	toXML() Return the ViewUserColumn object properties as XML element tree

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ViewUserColumn

public ViewUserColumn(Column column,
                      java.util.Vector<java.lang.Object> filterArgs,
                      Framework framework)
               throws OberonException

Constructor

Parameters:

column - the View Column

filterArgs - extra arguments used to compute the user access

framework - the user framework

Throws:

OberonException

ViewUserColumn

public ViewUserColumn(Column column,
                      java.util.Vector<java.lang.Object> filterArgs,
                      Framework framework,
                      java.util.Hashtable<java.lang.String,java.lang.Integer> counters)

Constructor

Parameters:

column - the View Column

filterArgs - extra arguments used to compute the user access

framework - the user framework

counters - administrative object synch counters (if null read them from database)

Method Detail

isModifiable

public boolean isModifiable()

Check if the Column data are modifiable by framework user

setValues

public void setValues(ViewUserColumn.Value[] values)

Set the Column values

getValues

public ViewUserColumn.Value[] getValues()

Get the Column values

getColumn

@Deprecated
public Column getColumn()

Deprecated.

Return the View Column definition

getName

public java.lang.String getName()

Return the Column name

Since:

4.1

setLabel

public void setLabel(java.lang.String label)

Set the Column label

Since:

4.1

getLabel

public java.lang.String getLabel()

Return the Column label

Since:

4.1

getFormat

public java.lang.String getFormat()

Get the Column format

Since:

4.1

getWidth

public double getWidth()

Get the Column width

Returns:

the Item width

Since:

4.1

isHidden

public boolean isHidden()

Check if the Column is hidden

Returns:

the multiple selection flag

Since:

4.1

getGetObject

public java.lang.String getGetObject()

Get the OOQL ObjectObj selector for the Column content.

Returns:

the ObjectObj selector in OOQL format

Since:

4.1

getGetLink

public java.lang.String getGetLink()

Get the OOQL Link selector for the Column content.

Returns:

the Link selector in OOQL format

Since:

4.1

toString

public java.lang.String toString()

Show the View Column status for the current framework user

Overrides:

toString in class java.lang.Object

toXML

public org.jdom.Element toXML()

Return the ViewUserColumn object properties as XML element tree

Since:

4.1

fromXML

public static ViewUserColumn fromXML(org.jdom.Element rootElement)
                              throws OberonException

Create a ViewUserColumn object from XML element tree

Throws:

OberonException

Since:

4.1