com.arsdigita.web
Class ApplicationType

java.lang.Object
  extended bycom.arsdigita.domain.DomainObject
      extended bycom.arsdigita.kernel.ResourceType
          extended bycom.arsdigita.web.ApplicationType

public class ApplicationType
extends ResourceType

The persistent type information of an Application.

Version:
$Id: //core-platform/dev/src/com/arsdigita/web/ApplicationType.java#8 $
Author:
Justin Ross <jross@redhat.com>
See Also:
Application, ApplicationTypeCollection

Field Summary
static String BASE_DATA_OBJECT_TYPE
           
static String versionId
           
 
Fields inherited from class com.arsdigita.kernel.ResourceType
s_defaultConfig
 
Constructor Summary
  ApplicationType(DataObject dataObject)
           
protected ApplicationType(String dataObjectType)
           
protected ApplicationType(String dataObjectType, PackageType packageType, String title, String applicationObjectType)
          Creates a legacy-compatible application type.
  ApplicationType(String title, String applicationObjectType)
          Creates a new application type.
protected ApplicationType(String objectType, String title, String applicationObjectType)
           
protected ApplicationType(String dataObjectType, String key, String title, String applicationObjectType)
          Creates a legacy-compatible application type.
 
Method Summary
 void addRelevantPrivilege(PrivilegeDescriptor privilege)
          Add an entry to the list of relevant privileges for this ApplicationType.
 void addRelevantPrivilege(String privilegeName)
          Add an entry to the list of relevant privileges for this ApplicationType.
 void addStylesheet(Stylesheet stylesheet)
          Deprecated. with no replacement.
static ApplicationType createApplicationType(PackageType packageType, String title, String applicationObjectType)
          Creates a legacy-compatible application type using the passed in package type.
static ApplicationType createApplicationType(String key, String title, String applicationObjectType)
          Creates a legacy-compatible application type.
 String getApplicationObjectType()
           
protected  String getBaseDataObjectType()
          Returns the base data object type for this domain object class.
 String getDescription()
           
 BigDecimal getID()
          Gets the value of the ID property.
 PackageType getPackageType()
           
 String getProfile()
           
 Collection getRelevantPrivileges()
          Get the list of relevant privileges for this ApplicationType.
 String getStylesheet()
           
 String getTitle()
           
 boolean hasEmbeddedView()
           
 boolean hasFullPageView()
           
 boolean isSingleton()
          Tell whether this ApplicationType is a singleton.
 boolean isWorkspaceApplication()
           
 void removeRelevantPrivilege(PrivilegeDescriptor privilege)
          Remove an entry from the list of relevant privileges for this ApplicationType.
 void removeRelevantPrivilege(String privilegeName)
          Remove an entry from the list of relevant privileges for this ApplicationType.
static ApplicationTypeCollection retrieveAllApplicationTypes()
           
static ApplicationType retrieveApplicationType(BigDecimal id)
           
static ApplicationType retrieveApplicationType(DataObject dataObject)
           
static ApplicationType retrieveApplicationType(OID oid)
           
static ApplicationType retrieveApplicationTypeForApplication(String applicationObjectType)
           
protected  void setApplicationObjectType(String objectType)
           
 void setDescription(String description)
           
 void setDispatcherClass(String className)
          Deprecated. with no replacement.
protected  void setEmbeddedView(boolean hasEmbeddedView)
          Deprecated. with no replacement.
protected  void setFullPageView(boolean hasFullPageView)
          Deprecated. with no replacement.
protected  void setPackageType(PackageType packageType)
          Deprecated. with no replacement.
protected  void setProfile(String profile)
           
 void setSingleton(boolean isSingleton)
          Deprecated. with no replacement.
 void setTitle(String title)
           
 void setWorkspaceApplication(boolean isWorkspaceApplication)
          Deprecated. with no replacement.
 
Methods inherited from class com.arsdigita.kernel.ResourceType
createResourceType, getConfig, getConfigs, getCreateComponent, getCreateFormSection, getModifyComponent, getModifyFormSection, getResourceObjectType, hasConfig, isInstalled, registerResourceTypeConfig, retrieveAllResourceTypes, retrieveResourceType, retrieveResourceType, retrieveResourceType, retrieveResourceTypeForResource, setResourceObjectType
 
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
Constructor Detail

ApplicationType

public ApplicationType(DataObject dataObject)

ApplicationType

protected ApplicationType(String dataObjectType)

ApplicationType

protected ApplicationType(String objectType,
                          String title,
                          String applicationObjectType)

ApplicationType

public ApplicationType(String title,
                       String applicationObjectType)
Creates a new application type. Types created via this constructor are "legacy free" and do not create a legacy package type for compatibility with older applications.


ApplicationType

protected ApplicationType(String dataObjectType,
                          PackageType packageType,
                          String title,
                          String applicationObjectType)
Creates a legacy-compatible application type. Types created via this constructor use the passed in package type to back the new application type.


ApplicationType

protected ApplicationType(String dataObjectType,
                          String key,
                          String title,
                          String applicationObjectType)
Creates a legacy-compatible application type. The key parameter is used to create a legacy package type to back the new application type.

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 ResourceType

createApplicationType

public static ApplicationType createApplicationType(PackageType packageType,
                                                    String title,
                                                    String applicationObjectType)
Creates a legacy-compatible application type using the passed in package type.


createApplicationType

public static ApplicationType createApplicationType(String key,
                                                    String title,
                                                    String applicationObjectType)
Creates a legacy-compatible application type. The key parameter is used to create a legacy package type to back the new application type.


retrieveApplicationType

public static ApplicationType retrieveApplicationType(BigDecimal id)

retrieveApplicationType

public static ApplicationType retrieveApplicationType(OID oid)

retrieveApplicationType

public static ApplicationType retrieveApplicationType(DataObject dataObject)

retrieveApplicationTypeForApplication

public static ApplicationType retrieveApplicationTypeForApplication(String applicationObjectType)

retrieveAllApplicationTypes

public static ApplicationTypeCollection retrieveAllApplicationTypes()

getPackageType

public PackageType getPackageType()

setPackageType

protected void setPackageType(PackageType packageType)
Deprecated. with no replacement.

Throws:
UnsupportedOperationException - when this method is called for an application type without a corresponding package type.

addStylesheet

public void addStylesheet(Stylesheet stylesheet)
Deprecated. with no replacement.

Throws:
UnsupportedOperationException - when this method is called for an application type without a corresponding package type.

setDispatcherClass

public void setDispatcherClass(String className)
Deprecated. with no replacement.

Throws:
UnsupportedOperationException - when this method is called for an application type without a corresponding package type.

getTitle

public String getTitle()
Overrides:
getTitle in class ResourceType

setTitle

public void setTitle(String title)
Overrides:
setTitle in class ResourceType

getDescription

public String getDescription()
Overrides:
getDescription in class ResourceType

setDescription

public void setDescription(String description)
Overrides:
setDescription in class ResourceType

isWorkspaceApplication

public boolean isWorkspaceApplication()

setWorkspaceApplication

public void setWorkspaceApplication(boolean isWorkspaceApplication)
Deprecated. with no replacement.

Throws:
UnsupportedOperationException - when this method is called for an application type without a corresponding package type.

hasFullPageView

public boolean hasFullPageView()

setFullPageView

protected void setFullPageView(boolean hasFullPageView)
Deprecated. with no replacement.

Throws:
UnsupportedOperationException - when this method is called for an application type without a corresponding package type.

hasEmbeddedView

public boolean hasEmbeddedView()

setEmbeddedView

protected void setEmbeddedView(boolean hasEmbeddedView)
Deprecated. with no replacement.

Throws:
UnsupportedOperationException - when this method is called for an application type without a corresponding package type.

getProfile

public String getProfile()

setProfile

protected void setProfile(String profile)

getRelevantPrivileges

public Collection getRelevantPrivileges()

Get the list of relevant privileges for this ApplicationType.

Overrides:
getRelevantPrivileges in class ResourceType
Returns:
A Collection of PrivilegeDescriptors

addRelevantPrivilege

public void addRelevantPrivilege(PrivilegeDescriptor privilege)

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

Overrides:
addRelevantPrivilege in class ResourceType

addRelevantPrivilege

public void addRelevantPrivilege(String privilegeName)

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

Overrides:
addRelevantPrivilege in class ResourceType

removeRelevantPrivilege

public void removeRelevantPrivilege(PrivilegeDescriptor privilege)

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

Overrides:
removeRelevantPrivilege in class ResourceType

removeRelevantPrivilege

public void removeRelevantPrivilege(String privilegeName)

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

Overrides:
removeRelevantPrivilege in class ResourceType

getApplicationObjectType

public String getApplicationObjectType()

setApplicationObjectType

protected void setApplicationObjectType(String objectType)

setSingleton

public void setSingleton(boolean isSingleton)
Deprecated. with no replacement.

Declare this ApplicationType to be a singleton. That is to say, there ought to only ever be one Application of this type directly under a given Workspace.

Throws:
UnsupportedOperationException - when this method is called for an application type without a corresponding package type.

isSingleton

public boolean isSingleton()
Tell whether this ApplicationType is a singleton.


getID

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

Overrides:
getID in class ResourceType
Returns:
the value of the ID property.

getStylesheet

public String getStylesheet()


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