com.plumtree.portaluiinfrastructure.profile
Class Property

java.lang.Object
  com.plumtree.portaluiinfrastructure.profile.Property

public final class Property
extends java.lang.Object

Author:

jennifersu Helper class that describes a Property in the User Profile Layout.

Constructor Summary

Property(int _id, java.lang.String _name, int _type, java.lang.Object _value, int _picktype, int _isHREF, int _isMandatory, int _isMultiValued, int _isReadOnly, int _isVisible, int _refClassID, java.lang.Object[][] _arrPickList)

Method Summary

int	GetID() Gets the ID of this Property object.
java.lang.String	GetName() Gets the name of this Property object.
java.lang.Object[][]	GetPickListValues() Get the picklist values from the property object
int	GetPickType() Gets the pick type of this Property object
int	GetRefClassID()
java.lang.String	GetRefName()
int	GetType() Gets the type of this Property object.
java.lang.Object	GetValue() Returns the value of this Property object.
boolean	IsHREF()
boolean	IsMandatory()
boolean	IsMultiValued()
boolean	IsReadOnly()
boolean	IsVisible()
void	SetRefName(java.lang.String refName)
void	SetValue(java.lang.Object _value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Property

public Property(int _id,
                java.lang.String _name,
                int _type,
                java.lang.Object _value,
                int _picktype,
                int _isHREF,
                int _isMandatory,
                int _isMultiValued,
                int _isReadOnly,
                int _isVisible,
                int _refClassID,
                java.lang.Object[][] _arrPickList)

Parameters:

_id -

_name -

_type -

_value -

_picktype -

_isHREF -

_isMandatory -

_isMultiValued -

_isReadOnly -

_isVisible -

_refClassID -

_arrPickList -

Method Detail

GetID

public int GetID()

Gets the ID of this Property object.

Returns:

The id of this Property object.

GetName

public java.lang.String GetName()

Gets the name of this Property object.

Returns:

The name of this Property object.

GetPickListValues

public java.lang.Object[][] GetPickListValues()

Get the picklist values from the property object

Returns:

Object[][] an object array of the picklist values. If there is nothing it returns null

GetPickType

public int GetPickType()

Gets the pick type of this Property object

Returns:

int The pick type for this object property

GetType

public int GetType()

Gets the type of this Property object.

Returns:

The type of this Property object. Will be one of PT_PROPERTY_TYPES.

GetValue

public java.lang.Object GetValue()

Returns the value of this Property object.

Returns:

The value of this Property object.

IsHREF

public boolean IsHREF()

Returns:

true if the Property is treated as an HREF

IsMandatory

public boolean IsMandatory()

IsMultiValued

public boolean IsMultiValued()

Returns:

true if the Property supports multiple values

IsReadOnly

public boolean IsReadOnly()

Returns:

true if the Property is read-only

IsVisible

public boolean IsVisible()

Returns:

true if the Property is visible in the UI

SetRefName

public void SetRefName(java.lang.String refName)

Parameters:

refName -

GetRefClassID

public int GetRefClassID()

Returns:

class ID of the reference type

GetRefName

public java.lang.String GetRefName()

Returns:

name of the reference value

SetValue

public void SetValue(java.lang.Object _value)

Parameters:

_value -