com.sap.netweaver.bc.rf.common.property

Class PropertyName

java.lang.Object
  com.sap.netweaver.bc.rf.util.flyweight.FlyWeight
      com.sap.netweaver.bc.rf.util.namespace.Name
          com.sap.netweaver.bc.rf.common.property.PropertyName

All Implemented Interfaces:

IPropertyName, IName, Serializable, Cloneable

public class PropertyName
extends Name
implements IPropertyName, Cloneable, Serializable

Class implementing a property name. This class predefines the system level property names. Don't add any other then system property names here! Each PropertyName follows the flyweight pattern for performance and memory consumption reasons. When define own property names, you are part of that pattern. When you define your own property name class, you should derive from that class to profit from that pattern.

See Also:

Serialized Form

Field Summary

static IPropertyName	COLLECTION Property describing whether or not the resource is a collection
static IPropertyName	CONTENTENCODING Property describing the content encoding of the resource
static IPropertyName	CONTENTLANGUAGE Property describing the content language of the resource
static IPropertyName	CONTENTLENGTH Property describing the content length of the resource
static IPropertyName	CONTENTTYPE Property describing the content type of the resource
static IPropertyName	CREATED Property describing when the resource was created
static IPropertyName	CREATEDBY Property describing the user who created the resource
static IPropertyName	DESCRIPTION Property describing the resource itself
static IPropertyName	DISPLAYNAME Property describing the display name of the resource
static IPropertyName	ETAG Property describing an entity tag reflecting the HTTP entity tag for the unfiltered content of this resource.
static IPropertyName	FOLLOW_LINKS The property with this name has the following semantics: If this property is present on a resource, has type boolean and evaluates to FALSE, then pointers from this resource to others should not be followed.
static IPropertyName	HIDDEN Property describing whether or not the resource is hidden
static IPropertyName	INDEX_CONTENT The property with this name has the following semantics: If this property is present on a resource, has type boolean and evaluates to FALSE, then the content of this resource is not suitable for indexing.
static IPropertyName	LINKTYPE Property describing of which link type a resource is (see namespace for link type ids)
static IPropertyName	MODIFIED Property describing when the resource was last modified
static IPropertyName	MODIFIEDBY Property describing who modified the resource last
static IPropertyName	READONLY Property describing whether or not the resource is read only
static IPropertyName	RESOURCENAME Property describing the repository supplied resource name, i.e. the last RID part
static IPropertyName	RESOURCETYPE Property describing the repository supplied resource type

Fields inherited from interface com.sap.netweaver.bc.rf.util.namespace.IName

NAMESPACE_SEPARATOR

Method Summary

static IPropertyName	getPropertyName(IName name) Get property name (all property names are cached for performance reasons and indexed by their full name).
static IPropertyName	getPropertyName(String fullName) Get property name (all property names are cached for performance reasons and indexed by their full name).
static IPropertyName	getPropertyName(String namespace, String localName) Get property name (all property names are cached for performance reasons and indexed by their full name).

Methods inherited from class com.sap.netweaver.bc.rf.util.namespace.Name

checkConstraints, checkLocalNameConstraints, checkNamespaceConstraints, getFullName, getLocalName, getName, getName, getNamespace, getNamespaceOrNull

Methods inherited from class com.sap.netweaver.bc.rf.util.flyweight.FlyWeight

clone, equals, getAllFlyWeights, getAllFlyWeightsInherited, getFlyWeight, getFlyWeightId, getFlyWeightInherited, hashCode, removeAllFlyWeights, removeAllFlyWeightsInherited, removeFlyWeight, removeFlyWeightInherited, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sap.netweaver.bc.rf.util.namespace.IName

getFullName, getLocalName, getNamespace, getNamespaceOrNull

Field Detail

RESOURCENAME

public static final IPropertyName RESOURCENAME

Property describing the repository supplied resource name, i.e. the last RID part

RESOURCETYPE

public static final IPropertyName RESOURCETYPE

Property describing the repository supplied resource type

CREATED

public static final IPropertyName CREATED

Property describing when the resource was created

CREATEDBY

public static final IPropertyName CREATEDBY

Property describing the user who created the resource

MODIFIED

public static final IPropertyName MODIFIED

Property describing when the resource was last modified

MODIFIEDBY

public static final IPropertyName MODIFIEDBY

Property describing who modified the resource last

COLLECTION

public static final IPropertyName COLLECTION

Property describing whether or not the resource is a collection

LINKTYPE

public static final IPropertyName LINKTYPE

Property describing of which link type a resource is (see namespace for link type ids)

READONLY

public static final IPropertyName READONLY

Property describing whether or not the resource is read only

HIDDEN

public static final IPropertyName HIDDEN

Property describing whether or not the resource is hidden

DISPLAYNAME

public static final IPropertyName DISPLAYNAME

Property describing the display name of the resource

DESCRIPTION

public static final IPropertyName DESCRIPTION

Property describing the resource itself

CONTENTLENGTH

public static final IPropertyName CONTENTLENGTH

Property describing the content length of the resource

CONTENTTYPE

public static final IPropertyName CONTENTTYPE

Property describing the content type of the resource

CONTENTENCODING

public static final IPropertyName CONTENTENCODING

Property describing the content encoding of the resource

CONTENTLANGUAGE

public static final IPropertyName CONTENTLANGUAGE

Property describing the content language of the resource

INDEX_CONTENT

public static final IPropertyName INDEX_CONTENT

The property with this name has the following semantics: If this property is present on a resource, has type boolean and evaluates to FALSE, then the content of this resource is not suitable for indexing. Any crawler visiting this resource shall, under normal operations, not add the content of this resource to any searchable database.

FOLLOW_LINKS

public static final IPropertyName FOLLOW_LINKS

The property with this name has the following semantics: If this property is present on a resource, has type boolean and evaluates to FALSE, then pointers from this resource to others should not be followed. Any crawler visiting this resource shall, under normal operations, not follow any pointers to other resources. For collection resources this property indicates that the children of this collection should not be crawled. For non-hierarchical resources the intention is that any embedded-links property shall be ignored.

ETAG

public static final IPropertyName ETAG

Property describing an entity tag reflecting the HTTP entity tag for the unfiltered content of this resource. If two strong entity tags for a given resource are identical, the contents are identical octet-by-octet. If two weak entitiy tags are identical, the contents are semantically equivalent, but may differ in it's octet representation. Tags are weak if and only if they start with a leading "W/". Note: The ETag of a resource is not a unique identifier.

Method Detail

getPropertyName

public static IPropertyName getPropertyName(IName name)
                                     throws AbstractPropertyException

Get property name (all property names are cached for performance reasons and indexed by their full name). If it isn't available, it will be created automatically.

Parameters:

name - property name

Returns:

propertyName

Throws:

AbstractPropertyException - Exception raised in failure situation

getPropertyName

public static IPropertyName getPropertyName(String fullName)
                                     throws AbstractPropertyException

Get property name (all property names are cached for performance reasons and indexed by their full name). If it isn't available, it will be created automatically.

Parameters:

fullName - property full name

Returns:

propertyName

Throws:

AbstractPropertyException - Exception raised in failure situation

getPropertyName

public static IPropertyName getPropertyName(String namespace,
                                            String localName)
                                     throws AbstractPropertyException

Get property name (all property names are cached for performance reasons and indexed by their full name). If it isn't available, it will be created automatically.

Parameters:

namespace - property namespace

localName - property local name

Returns:

propertyName

Throws:

AbstractPropertyException - Exception raised in failure situation

Access Rights

This class can be accessed from:

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