com.sapportals.wcm.repository

Class PropertyDef

java.lang.Object
  com.sapportals.wcm.WcmObject
      com.sapportals.wcm.repository.PropertyDef

All Implemented Interfaces:

IPropertyDef

public class PropertyDef
extends WcmObject
implements IPropertyDef

Information about the type, name and other attributes of a property.

Copyright (c) SAP AG 2001-2004

Field Summary

Fields inherited from class com.sapportals.wcm.WcmObject

ORDER_TYPE_MANUAL, ORDER_TYPE_NONE

Constructor Summary

protected	PropertyDef(IPropertyDef def) Construct a new PropertyDef
	PropertyDef(PropertyDef def) Construct a new PropertyDef
	PropertyDef(PropertyType type, boolean isMultivalued)
	PropertyDef(PropertyType type, boolean isMultivalued, boolean isRequired, boolean isReadonly, boolean isIndexed, boolean isHidden) Constructs a new PropertyDef
	PropertyDef(PropertyType type, boolean isMultivalued, boolean isRequired, boolean isReadonly, boolean isIndexed, boolean isHidden, Properties attributes) Constructs a new PropertyDef

Method Summary

static IPropertyDef	createContentLanguage()
static IPropertyDef	createContentLength()
static IPropertyDef	createContentType()
static IPropertyDef	createCreatedBy()
static IPropertyDef	createCreationDate()
static IPropertyDef	createDescription()
static IPropertyDef	createDisplayname()
static IPropertyDef	createETag()
static IPropertyDef	createHidden()
static IPropertyDef	createLastModified()
static IPropertyDef	createLastModifiedBy()
static IPropertyDef	createReadOnly()
static IPropertyDef	createResourceType()
boolean	equals(Object propDef) Compare two PropertyDef objects for equality
String	getAttribute(String name) Get the value of an attribute.
Properties	getAttributes() Returns a collection of attributes
PropertyType	getType() Returns the type of the property.
int	hashCode() Hashcode
boolean	isHidden() Returns the value of the Hidden attribute
boolean	isIndexed() Returns the value of the Indexed attribute
boolean	isMultivalued() Returns true if the property is multi-valued.
boolean	isReadonly() Returns the value of the Readonly attribute
boolean	isRequired() Returns the value of the Required attribute
String	toString() String representation of a property def
static PropertyDef	valueOf(PropertyType type, boolean isMultivalued)
static PropertyDef	valueOf(PropertyType type, boolean isMultivalued, boolean isReadOnly, boolean isHidden)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PropertyDef

public PropertyDef(PropertyType type,
                   boolean isMultivalued,
                   boolean isRequired,
                   boolean isReadonly,
                   boolean isIndexed,
                   boolean isHidden)
            throws ResourceException

Constructs a new PropertyDef

Parameters:

type - The property Type

isMultivalued - If the property has multible values

isRequired - If the property can not be deleted

isReadonly - If the property value can not be changed

isIndexed - If the property value is indexed

isHidden - TBD: Description of the incoming method parameter

Throws:

ResourceException - If the property name contains illegal characters (e.g. whitespace)

PropertyDef

public PropertyDef(PropertyType type,
                   boolean isMultivalued,
                   boolean isRequired,
                   boolean isReadonly,
                   boolean isIndexed,
                   boolean isHidden,
                   Properties attributes)
            throws ResourceException

Constructs a new PropertyDef

Parameters:

type - The property Type

isMultivalued - If the property has multible values

isRequired - If the property can not be deleted

isReadonly - If the property value can not be changed

isIndexed - If the property value is indexed

isHidden - TBD: Description of the incoming method parameter

attributes - TBD: Description of the incoming method parameter

Throws:

ResourceException - If the property name contains illegal characters (e.g. whitespace)

PropertyDef

public PropertyDef(PropertyDef def)

Construct a new PropertyDef

Parameters:

def - TBD: Description of the incoming method parameter

PropertyDef

public PropertyDef(PropertyType type,
                   boolean isMultivalued)

PropertyDef

protected PropertyDef(IPropertyDef def)

Construct a new PropertyDef

Parameters:

def - TBD: Description of the incoming method parameter

Method Detail

valueOf

public static final PropertyDef valueOf(PropertyType type,
                                        boolean isMultivalued)

valueOf

public static final PropertyDef valueOf(PropertyType type,
                                        boolean isMultivalued,
                                        boolean isReadOnly,
                                        boolean isHidden)

createCreatedBy

public static IPropertyDef createCreatedBy()

createLastModifiedBy

public static IPropertyDef createLastModifiedBy()

createCreationDate

public static IPropertyDef createCreationDate()

createHidden

public static IPropertyDef createHidden()

createLastModified

public static IPropertyDef createLastModified()

createDescription

public static IPropertyDef createDescription()

createDisplayname

public static IPropertyDef createDisplayname()

createReadOnly

public static IPropertyDef createReadOnly()

createContentLength

public static IPropertyDef createContentLength()

createContentType

public static IPropertyDef createContentType()

createETag

public static IPropertyDef createETag()

createContentLanguage

public static IPropertyDef createContentLanguage()

createResourceType

public static IPropertyDef createResourceType()

hashCode

public int hashCode()

Hashcode

Overrides:

hashCode in class Object

Returns:

TBD: Description of the outgoing return value

equals

public boolean equals(Object propDef)

Compare two PropertyDef objects for equality

Overrides:

equals in class Object

Parameters:

propDef - TBD: Description of the incoming method parameter

Returns:

TBD: Description of the outgoing return value

toString

public String toString()

String representation of a property def

Overrides:

toString in class Object

Returns:

TBD: Description of the outgoing return value

isMultivalued

public boolean isMultivalued()

Returns true if the property is multi-valued.

Specified by:

isMultivalued in interface IPropertyDef

Returns:

A boolean value

isRequired

public boolean isRequired()

Returns the value of the Required attribute

Specified by:

isRequired in interface IPropertyDef

Returns:

A boolean value

getType

public PropertyType getType()

Returns the type of the property.

Specified by:

getType in interface IPropertyDef

Returns:

type

isReadonly

public boolean isReadonly()

Returns the value of the Readonly attribute

Specified by:

isReadonly in interface IPropertyDef

Returns:

readonly

isIndexed

public boolean isIndexed()

Returns the value of the Indexed attribute

Specified by:

isIndexed in interface IPropertyDef

Returns:

indexed

isHidden

public boolean isHidden()

Returns the value of the Hidden attribute

Specified by:

isHidden in interface IPropertyDef

Returns:

hidden

getAttribute

public String getAttribute(String name)

Get the value of an attribute.

Specified by:

getAttribute in interface IPropertyDef

Parameters:

name - Attribute name

Returns:

The value

getAttributes

public Properties getAttributes()

Returns a collection of attributes

Specified by:

getAttributes in interface IPropertyDef

Returns:

All attributes

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM