Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sapportals.wcm.repository.service.appproperties
Class AppProperty

[contained in: com.sap.netweaver.bc.rf.service.par - bc.rf.repository.service.appproperties_api.jar] 
java.lang.Object
  |
  +--com.sapportals.wcm.repository.service.appproperties.AppProperty
All Implemented Interfaces:
IAppProperty
public class AppProperty
extends java.lang.Object
implements IAppProperty

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

Copyright (c) SAP AG 2001-2004

Field Summary
protected  boolean enableCopy
           
protected  boolean isMultivalued
           
protected  IPropertyName name
           
protected  PropertyType type
           
protected  java.lang.String userID
           
protected  java.lang.Object value
           
protected  java.util.List values
           
 
Constructor Summary
AppProperty(IPropertyName name, java.lang.Boolean value, java.lang.String userID, boolean enableCopy)
           
AppProperty(IPropertyName name, java.util.Date value, java.lang.String userID, boolean enableCopy)
           
AppProperty(IPropertyName name, java.lang.Integer value, java.lang.String userID, boolean enableCopy)
           
AppProperty(IPropertyName name, java.lang.Long value, java.lang.String userID, boolean enableCopy)
           
AppProperty(IPropertyName name, PropertyType type, java.util.List values, java.lang.String userID, boolean enableCopy)
           
AppProperty(IPropertyName name, java.lang.String value, java.lang.String userID, boolean enableCopy)
           
AppProperty(IPropertyName name, XMLMarkup value, java.lang.String userID, boolean enableCopy)
           
 
Method Summary
 java.lang.Boolean getBooleanValue()
          Get the property value if the type is PropertyType.BOOLEAN or null otherwise.
 java.util.Date getDateValue()
          Get the property value if the type is PropertyType.DATE or null otherwise.
 java.lang.Integer getIntegerValue()
          Get the property value if the type is PropertyType.INTEGER or null otherwise.
 java.lang.Long getLongValue()
          Get the property value if the type is PropertyType.LONG or null otherwise.
 long getPropertyID()
           
 IPropertyName getPropertyName()
          Returns the property name
 java.lang.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
 java.lang.String getUserID()
          Returns the user ID if the property is personalized, null otherwise
 java.lang.String getValueAsString()
          Get the property value converted to a string.
 java.util.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
 void setPropertyID(long id)
           
 java.lang.String toString()
           
protected  void validateType(java.lang.Object v)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

name

protected IPropertyName name

value

protected java.lang.Object value

type

protected PropertyType type

userID

protected java.lang.String userID

enableCopy

protected boolean enableCopy

isMultivalued

protected boolean isMultivalued

values

protected java.util.List values
Constructor Detail

AppProperty

public AppProperty(IPropertyName name,
                   java.lang.String value,
                   java.lang.String userID,
                   boolean enableCopy)
            throws WcmException

AppProperty

public AppProperty(IPropertyName name,
                   java.util.Date value,
                   java.lang.String userID,
                   boolean enableCopy)
            throws WcmException

AppProperty

public AppProperty(IPropertyName name,
                   java.lang.Integer value,
                   java.lang.String userID,
                   boolean enableCopy)
            throws WcmException

AppProperty

public AppProperty(IPropertyName name,
                   java.lang.Long value,
                   java.lang.String userID,
                   boolean enableCopy)
            throws WcmException

AppProperty

public AppProperty(IPropertyName name,
                   java.lang.Boolean value,
                   java.lang.String userID,
                   boolean enableCopy)
            throws WcmException

AppProperty

public AppProperty(IPropertyName name,
                   XMLMarkup value,
                   java.lang.String userID,
                   boolean enableCopy)
            throws WcmException

AppProperty

public AppProperty(IPropertyName name,
                   PropertyType type,
                   java.util.List values,
                   java.lang.String userID,
                   boolean enableCopy)
            throws WcmException
Method Detail

getPropertyName

public IPropertyName getPropertyName()
Description copied from interface: IAppProperty
Returns the property name
Specified by:
getPropertyName in interface IAppProperty
Following copied from interface: com.sapportals.wcm.repository.service.appproperties.IAppProperty
Returns:
The property name object

getType

public PropertyType getType()
Description copied from interface: IAppProperty
Returns the property data type
Specified by:
getType in interface IAppProperty
Following copied from interface: com.sapportals.wcm.repository.service.appproperties.IAppProperty
Returns:
The property type constant

isMultivalued

public boolean isMultivalued()
Description copied from interface: IAppProperty
Returns true if it is a multi-valued property
Specified by:
isMultivalued in interface IAppProperty
Following copied from interface: com.sapportals.wcm.repository.service.appproperties.IAppProperty
Returns:
multivalued

getUserID

public java.lang.String getUserID()
Description copied from interface: IAppProperty
Returns the user ID if the property is personalized, null otherwise
Specified by:
getUserID in interface IAppProperty
Following copied from interface: com.sapportals.wcm.repository.service.appproperties.IAppProperty
Returns:
The user ID

getValueAsString

public java.lang.String getValueAsString()
Description copied from interface: IAppProperty
Get the property value converted to a string.
Specified by:
getValueAsString in interface IAppProperty
Following copied from interface: com.sapportals.wcm.repository.service.appproperties.IAppProperty
Returns:
A String value or null if it is a multi-valued property

getBooleanValue

public java.lang.Boolean getBooleanValue()
Description copied from interface: IAppProperty
Get the property value if the type is PropertyType.BOOLEAN or null otherwise.
Specified by:
getBooleanValue in interface IAppProperty
Following copied from interface: com.sapportals.wcm.repository.service.appproperties.IAppProperty
Returns:
The value

getIntegerValue

public java.lang.Integer getIntegerValue()
Description copied from interface: IAppProperty
Get the property value if the type is PropertyType.INTEGER or null otherwise.
Specified by:
getIntegerValue in interface IAppProperty
Following copied from interface: com.sapportals.wcm.repository.service.appproperties.IAppProperty
Returns:
The value

getLongValue

public java.lang.Long getLongValue()
Description copied from interface: IAppProperty
Get the property value if the type is PropertyType.LONG or null otherwise.
Specified by:
getLongValue in interface IAppProperty
Following copied from interface: com.sapportals.wcm.repository.service.appproperties.IAppProperty
Returns:
The value

getDateValue

public java.util.Date getDateValue()
Description copied from interface: IAppProperty
Get the property value if the type is PropertyType.DATE or null otherwise.
Specified by:
getDateValue in interface IAppProperty
Following copied from interface: com.sapportals.wcm.repository.service.appproperties.IAppProperty
Returns:
The value

getStringValue

public java.lang.String getStringValue()
Description copied from interface: IAppProperty
Get the property value if the type is PropertyType.STRING or PropertyType.XML, or null otherwise.
Specified by:
getStringValue in interface IAppProperty
Following copied from interface: com.sapportals.wcm.repository.service.appproperties.IAppProperty
Returns:
The value

getValues

public java.util.List getValues()
                         throws WcmException
Description copied from interface: IAppProperty
Returns a list of property values if the property is defined as multi-valued, null otherwise
Specified by:
getValues in interface IAppProperty
Following copied from interface: com.sapportals.wcm.repository.service.appproperties.IAppProperty
Returns:
values
Throws:
WcmException - Exception raised in failure situation

isCopyEnabled

public boolean isCopyEnabled()
Description copied from interface: IAppProperty
Returns a flag indicating of the properties should be copied if copy() is called on the resource
Specified by:
isCopyEnabled in interface IAppProperty
Following copied from interface: com.sapportals.wcm.repository.service.appproperties.IAppProperty
Returns:
Boolean value

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

setPropertyID

public void setPropertyID(long id)

getPropertyID

public long getPropertyID()

validateType

protected void validateType(java.lang.Object v)
                     throws WcmException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.