com.centrasite.control.registry.items.accessors
Class RegistryObjectSlotAccessor

java.lang.Object
  extended by com.centrasite.control.discovery.AbstractPropertyAccessor
      extended by com.centrasite.control.discovery.ReadWritePropertyAccessor
          extended by com.centrasite.control.registry.items.accessors.RegistryObjectSlotAccessor
All Implemented Interfaces:
PropertyAccessor, AllowsSortingUsingXQuery

public class RegistryObjectSlotAccessor
extends ReadWritePropertyAccessor
implements AllowsSortingUsingXQuery

Provide access to arbitrary slots of a RegistryObject


Constructor Summary
RegistryObjectSlotAccessor(com.centrasite.jaxr.type.CentraSiteSlotDescription slotDescription)
           
RegistryObjectSlotAccessor(java.lang.String slotName)
           
 
Method Summary
 java.lang.String getDescription()
           
 java.lang.String getDisplayName(java.util.Locale locale)
          Obtain a localized display name for the property accessed using this PropertyAccessor
 java.lang.String getPropertyName()
          Obtain name of property being accessed via this accessor.
 java.lang.String getSortPath(java.lang.String objectTypeValue)
          This method returns the xpath that will be used in XQuery for sorting on the property accessed by the PropertyAccessor implementing this interface.
 java.lang.String getValue(Item item)
          Get value of property for given Item
 boolean isRequired()
           
 void setValue(Item item, java.lang.String value)
          Set value of property for given Item
 
Methods inherited from class com.centrasite.control.discovery.ReadWritePropertyAccessor
isReadOnly
 
Methods inherited from class com.centrasite.control.discovery.AbstractPropertyAccessor
editProperty, getActivatingMessage, getCommands, getDescription, getReferencedItem, getSelectReferencedItemDescriptor, isComplexProperty, isDateProperty, isIntProperty, isTextEditAllowed, selectReferencedItem
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RegistryObjectSlotAccessor

public RegistryObjectSlotAccessor(com.centrasite.jaxr.type.CentraSiteSlotDescription slotDescription)

RegistryObjectSlotAccessor

public RegistryObjectSlotAccessor(java.lang.String slotName)
Method Detail

getPropertyName

public java.lang.String getPropertyName()
Description copied from interface: PropertyAccessor
Obtain name of property being accessed via this accessor.

Specified by:
getPropertyName in interface PropertyAccessor
Returns:
The string being returned is an internal string NOT being constructed by means of I18N infrastructure. It may be used internally for storing user-specific settings for example selected columns in a table. This selection should not depend on the language!

getDisplayName

public java.lang.String getDisplayName(java.util.Locale locale)
Description copied from class: AbstractPropertyAccessor
Obtain a localized display name for the property accessed using this PropertyAccessor

Specified by:
getDisplayName in interface PropertyAccessor
Overrides:
getDisplayName in class AbstractPropertyAccessor
Returns:
the localized display name

getDescription

public java.lang.String getDescription()

getValue

public java.lang.String getValue(Item item)
                          throws java.lang.Exception
Description copied from interface: PropertyAccessor
Get value of property for given Item

Specified by:
getValue in interface PropertyAccessor
Throws:
java.lang.Exception

setValue

public void setValue(Item item,
                     java.lang.String value)
              throws java.lang.Exception
Description copied from interface: PropertyAccessor
Set value of property for given Item

Specified by:
setValue in interface PropertyAccessor
Throws:
java.lang.Exception

isRequired

public boolean isRequired()
Overrides:
isRequired in class ReadWritePropertyAccessor

getSortPath

public java.lang.String getSortPath(java.lang.String objectTypeValue)
Description copied from interface: AllowsSortingUsingXQuery
This method returns the xpath that will be used in XQuery for sorting on the property accessed by the PropertyAccessor implementing this interface. Note: the xpath expression must contain $ro representing the registry object being searched

Specified by:
getSortPath in interface AllowsSortingUsingXQuery
Parameters:
objectTypeValue - the value of the object type or ObjectTypePredicate.ALL_OBJECT_TYPES
Returns:
The xpath to the sortable property.