atg.repository
Interface RepositoryItemDescriptor

All Superinterfaces:
DynamicBeanInfo, java.io.Serializable
All Known Subinterfaces:
SecuredRepositoryItemDescriptor
All Known Implementing Classes:
GSAItemDescriptor, ItemDescriptorImpl

public interface RepositoryItemDescriptor
extends DynamicBeanInfo


Field Summary
static java.lang.String CLASS_VERSION
           
 
Method Summary
 void addPropertyDescriptor(RepositoryPropertyDescriptor pPropertyDescriptor)
          Adds a property descriptor to the repository
 java.lang.String encodeCompositeKey(java.lang.String[] pIdValues)
          Encode an array of ID values to be used as a Repository ID
 java.lang.String getItemDescriptorName()
          Returns the name of the RepositoryItemDescriptor
 Repository getRepository()
          Returns the repository for this item descriptor.
 RepositoryView getRepositoryView()
          Returns the default repository view for this item descriptor.
 boolean hasCompositeKey()
          Determine if this item type has a composite ID.
 void removePropertyDescriptor(java.lang.String pPropertyName)
          Removes a property descriptor from the repository
 void updatePropertyDescriptor(RepositoryPropertyDescriptor pPropertyDescriptor)
          Updates the property descriptor in the repository
 
Methods inherited from interface atg.beans.DynamicBeanInfo
areInstances, getBeanDescriptor, getPropertyDescriptor, getPropertyDescriptors, getPropertyNames, hasProperty, isInstance
 

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION
See Also:
Constant Field Values
Method Detail

getRepository

Repository getRepository()
Returns the repository for this item descriptor.


getItemDescriptorName

java.lang.String getItemDescriptorName()
Returns the name of the RepositoryItemDescriptor


getRepositoryView

RepositoryView getRepositoryView()
Returns the default repository view for this item descriptor. Often in a repository, there is one repository view for each item descriptor but all item descriptors must have at least a default repository view.


addPropertyDescriptor

void addPropertyDescriptor(RepositoryPropertyDescriptor pPropertyDescriptor)
                           throws RepositoryException
Adds a property descriptor to the repository

Parameters:
pPropertyDescriptor - the descriptor for the new property to add to the Repository
Throws:
RepositoryException - if there was a problem adding the property descriptor

updatePropertyDescriptor

void updatePropertyDescriptor(RepositoryPropertyDescriptor pPropertyDescriptor)
                              throws RepositoryException
Updates the property descriptor in the repository

Parameters:
pPropertyDescriptor - the descriptor for the property to update
Throws:
RepositoryException - if there was a problem updating the property descriptor

removePropertyDescriptor

void removePropertyDescriptor(java.lang.String pPropertyName)
                              throws RepositoryException
Removes a property descriptor from the repository

Parameters:
pPropertyName - the name of the property
Throws:
RepositoryException - if there was a problem removing the property descriptor

hasCompositeKey

boolean hasCompositeKey()
Determine if this item type has a composite ID.

Returns:
default is false, implementations may override

encodeCompositeKey

java.lang.String encodeCompositeKey(java.lang.String[] pIdValues)
                                    throws RepositoryException
Encode an array of ID values to be used as a Repository ID

Parameters:
pIdValues - Array of ID values
Returns:
the encoded String value of the composite key
Throws:
RepositoryException - unsupported feature