com.arsdigita.kernel
Class ResourceType

java.lang.Object
  extended bycom.arsdigita.domain.DomainObject
      extended bycom.arsdigita.kernel.ResourceType
Direct Known Subclasses:
ApplicationType, PortletType

public class ResourceType
extends DomainObject

XXX JAVADOC XXX

Version:
$Id: //core-platform/dev/src/com/arsdigita/kernel/ResourceType.java#10 $
Author:
Jim Parsons <jparsons@redhat.com>
See Also:
Resource, ResourceTypeCollection

Field Summary
static String BASE_DATA_OBJECT_TYPE
           
protected static ResourceTypeConfig s_defaultConfig
           
static String versionId
           
 
Constructor Summary
protected ResourceType(DataObject dataObject)
           
protected ResourceType(String dataObjectType)
           
protected ResourceType(String dataObjectType, String title, String resourceObjectType)
           
 
Method Summary
 void addRelevantPrivilege(PrivilegeDescriptor privilege)
          Add an entry to the list of relevant privileges for this ResourceType.
 void addRelevantPrivilege(String privilegeName)
          Add an entry to the list of relevant privileges for this ResourceType.
static ResourceType createResourceType(String title, String resourceObjectType)
           
protected  String getBaseDataObjectType()
          Returns the base data object type for this domain object class.
 ResourceTypeConfig getConfig()
           
static Iterator getConfigs()
           
 ResourceConfigComponent getCreateComponent(RequestLocal parentResource)
           
 ResourceConfigFormSection getCreateFormSection(RequestLocal parentResource)
           
 String getDescription()
           
 BigDecimal getID()
          Gets the value of the ID property.
 ResourceConfigComponent getModifyComponent(RequestLocal resource)
           
 ResourceConfigFormSection getModifyFormSection(RequestLocal resource)
           
 Collection getRelevantPrivileges()
          Get the list of relevant privileges for this ResourceType.
 String getResourceObjectType()
           
 String getTitle()
           
 boolean hasConfig()
           
static boolean isInstalled(String resourceObjectType)
           
static void registerResourceTypeConfig(String resourceObjectType, ResourceTypeConfig config)
           
 void removeRelevantPrivilege(PrivilegeDescriptor privilege)
          Remove an entry from the list of relevant privileges for this ResourceType.
 void removeRelevantPrivilege(String privilegeName)
          Remove an entry from the list of relevant privileges for this ResourceType.
static ResourceTypeCollection retrieveAllResourceTypes()
           
static ResourceType retrieveResourceType(BigDecimal id)
           
static ResourceType retrieveResourceType(DataObject dataObject)
           
static ResourceType retrieveResourceType(OID oid)
           
static ResourceType retrieveResourceTypeForResource(String resourceObjectType)
           
 void setDescription(String description)
           
protected  void setResourceObjectType(String objectType)
           
 void setTitle(String title)
           
 
Methods inherited from class com.arsdigita.domain.DomainObject
add, add, addToAssociation, afterDelete, afterSave, beforeDelete, beforeSave, clear, delete, disconnect, equals, get, getObjectType, getOID, getSession, hashCode, initialize, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, set, setAssociation, setAssociation, specializeDataObject, specializeDataObject, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values

BASE_DATA_OBJECT_TYPE

public static final String BASE_DATA_OBJECT_TYPE
See Also:
Constant Field Values

s_defaultConfig

protected static ResourceTypeConfig s_defaultConfig
Constructor Detail

ResourceType

protected ResourceType(DataObject dataObject)

ResourceType

protected ResourceType(String dataObjectType)

ResourceType

protected ResourceType(String dataObjectType,
                       String title,
                       String resourceObjectType)
Method Detail

getBaseDataObjectType

protected String getBaseDataObjectType()
Description copied from class: DomainObject
Returns the base data object type for this domain object class. Intended to be overrided by subclasses whenever the subclass will only work if their primary data object is of a certain base type.

Overrides:
getBaseDataObjectType in class DomainObject
Returns:
The fully qualified name ("modelName.typeName") of the base data object type for this domain object class, or null if there is no restriction on the data object type for the primary data object encapsulated by this class.

createResourceType

public static ResourceType createResourceType(String title,
                                              String resourceObjectType)

retrieveResourceType

public static ResourceType retrieveResourceType(BigDecimal id)

retrieveResourceType

public static ResourceType retrieveResourceType(OID oid)

retrieveResourceType

public static ResourceType retrieveResourceType(DataObject dataObject)

retrieveResourceTypeForResource

public static ResourceType retrieveResourceTypeForResource(String resourceObjectType)

retrieveAllResourceTypes

public static ResourceTypeCollection retrieveAllResourceTypes()

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getRelevantPrivileges

public Collection getRelevantPrivileges()

Get the list of relevant privileges for this ResourceType.

Returns:
A Collection of PrivilegeDescriptors

addRelevantPrivilege

public void addRelevantPrivilege(PrivilegeDescriptor privilege)

Add an entry to the list of relevant privileges for this ResourceType.


addRelevantPrivilege

public void addRelevantPrivilege(String privilegeName)

Add an entry to the list of relevant privileges for this ResourceType.


removeRelevantPrivilege

public void removeRelevantPrivilege(PrivilegeDescriptor privilege)

Remove an entry from the list of relevant privileges for this ResourceType.


removeRelevantPrivilege

public void removeRelevantPrivilege(String privilegeName)

Remove an entry from the list of relevant privileges for this ResourceType.


getResourceObjectType

public String getResourceObjectType()

setResourceObjectType

protected void setResourceObjectType(String objectType)

getID

public BigDecimal getID()
Gets the value of the ID property.

Returns:
the value of the ID property.

isInstalled

public static boolean isInstalled(String resourceObjectType)

registerResourceTypeConfig

public static final void registerResourceTypeConfig(String resourceObjectType,
                                                    ResourceTypeConfig config)

getConfigs

public static final Iterator getConfigs()

getConfig

public final ResourceTypeConfig getConfig()

hasConfig

public final boolean hasConfig()

getCreateFormSection

public final ResourceConfigFormSection getCreateFormSection(RequestLocal parentResource)

getModifyFormSection

public final ResourceConfigFormSection getModifyFormSection(RequestLocal resource)

getCreateComponent

public final ResourceConfigComponent getCreateComponent(RequestLocal parentResource)

getModifyComponent

public ResourceConfigComponent getModifyComponent(RequestLocal resource)


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2337 UTC