com.sapportals.wcm.repository.service.appproperties

Interface IAppProperty

All Known Implementing Classes:

AppProperty

public interface IAppProperty

An application-defined and personalized property of a resource object in any repository.

Copyright (c) SAP AG 2001-2004

Method Summary

Boolean	getBooleanValue() Get the property value if the type is PropertyType.BOOLEAN or null otherwise.
Date	getDateValue() Get the property value if the type is PropertyType.DATE or null otherwise.
Integer	getIntegerValue() Get the property value if the type is PropertyType.INTEGER or null otherwise.
Long	getLongValue() Get the property value if the type is PropertyType.LONG or null otherwise.
IPropertyName	getPropertyName() Returns the property name
String	getStringValue() Get the property value if the type is PropertyType.STRING or PropertyType.XML, or null otherwise.
PropertyType	getType() Returns the property data type
String	getUserID() Returns the user ID if the property is personalized, null otherwise
String	getValueAsString() Get the property value converted to a string.
List	getValues() Returns a list of property values if the property is defined as multi-valued, null otherwise
boolean	isCopyEnabled() Returns a flag indicating of the properties should be copied if copy() is called on the resource
boolean	isMultivalued() Returns true if it is a multi-valued property

Method Detail

getPropertyName

public IPropertyName getPropertyName()

Returns the property name

Returns:

The property name object

getType

public PropertyType getType()

Returns the property data type

Returns:

The property type constant

isMultivalued

public boolean isMultivalued()

Returns true if it is a multi-valued property

Returns:

multivalued

isCopyEnabled

public boolean isCopyEnabled()

Returns a flag indicating of the properties should be copied if copy() is called on the resource

Returns:

Boolean value

getUserID

public String getUserID()

Returns the user ID if the property is personalized, null otherwise

Returns:

The user ID

getValueAsString

public String getValueAsString()

Get the property value converted to a string.

Returns:

A String value or null if it is a multi-valued property

getBooleanValue

public Boolean getBooleanValue()

Get the property value if the type is PropertyType.BOOLEAN or null otherwise.

Returns:

The value

getIntegerValue

public Integer getIntegerValue()

Get the property value if the type is PropertyType.INTEGER or null otherwise.

Returns:

The value

getLongValue

public Long getLongValue()

Get the property value if the type is PropertyType.LONG or null otherwise.

Returns:

The value

getDateValue

public Date getDateValue()

Get the property value if the type is PropertyType.DATE or null otherwise.

Returns:

The value

getStringValue

public String getStringValue()

Get the property value if the type is PropertyType.STRING or PropertyType.XML, or null otherwise.

Returns:

The value

getValues

public List getValues()
               throws WcmException

Returns a list of property values if the property is defined as multi-valued, null otherwise

Returns:

values

Throws:

WcmException - Exception raised in failure situation