|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.arsdigita.domain.DomainObject
com.arsdigita.domain.ObservableDomainObject
com.arsdigita.kernel.ACSObject
com.arsdigita.kernel.Resource
com.arsdigita.portal.Portal
A domain class for portals. A Portal has a set of Portlet
s.
A Portal is a Persistence-backed framework for aggregating content
from multiple web applications/content sources.
The com.arsdigita.portal
package is an infrastructural package that can be used to quickly
implement a basic portal server, but is primarily intended as a
foundation for the development of more sophisticated Portal systems such as
workspaces that feature multiple portals as named tabs within the workspace.
Containment properties of Portals, such as versioning, permissioning, and
searchability are available within Portal's parent class Resource
.
Field Summary | |
static String |
BASE_DATA_OBJECT_TYPE
|
static String |
versionId
|
Fields inherited from class com.arsdigita.kernel.Resource |
CHILD_RESOURCE, DESCRIPTION, PARENT_RESOURCE, RESOURCE_TYPE, TIMESTAMP, TITLE |
Fields inherited from class com.arsdigita.kernel.ACSObject |
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE |
Constructor Summary | |
protected |
Portal(DataObject dataObject)
|
|
Portal(OID oid)
|
protected |
Portal(String dataObjectType)
|
Method Summary | |
void |
addPortlet(Portlet portlet,
int cellNumber)
Add a portlet to this portal or portal template. |
protected void |
beforeSave()
|
void |
clearPortlets()
Deletes all portlets on the portal |
static Portal |
create(String title,
Resource parent)
Create a new portal. |
static Portal |
create(String dataobj,
String title,
Resource parent)
|
static Portal |
createTemplate(String title)
Create a new portal template. |
protected String |
getBaseDataObjectType()
Returns the base data object type for this domain object class. |
PortletCollection |
getPortlets()
Return all of this Portal's Portlets, ordered by cell number then sort key. |
PortletCollection |
getPortletsForCell(int cellNumber)
Return all of this Portal's Portlets for the given cell. |
String |
getTitle()
|
boolean |
isTemplate()
|
void |
movePortletToHead(Portlet portlet)
|
void |
movePortletToTail(Portlet portlet)
|
static Portal |
retrieve(BigDecimal portalID)
Retrieve an existing portal based on a portal ID. |
static Portal |
retrieve(DataObject dataObject)
Retrieve an existing portal based on a portal data object. |
static Portal |
retrieve(OID oid)
Retrieve an existing portal based on an OID. |
static PortalCollection |
retrieveAll()
|
protected void |
setTemplate(boolean isTemplate)
|
void |
setTitle(String title)
|
void |
swapPortletWithNext(Portlet portlet)
|
void |
swapPortletWithPrevious(Portlet portlet)
|
Methods inherited from class com.arsdigita.kernel.Resource |
afterSave, createResource, createResource, getChildResources, getContainer, getContainingResource, getDescription, getDisplayName, getParentResource, getResourceType, getTimestamp, isContainerModified, retrieveAllResources, retrieveResource, retrieveResource, retrieveResource, setDescription, setParentResource, setResourceType |
Methods inherited from class com.arsdigita.kernel.ACSObject |
assertPrivilege, checkPrivilege, doCreateCheck, doWriteCheck, getDefaultDomainClass, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, initialize, setID, setID |
Methods inherited from class com.arsdigita.domain.ObservableDomainObject |
addObserver, getObservers |
Methods inherited from class com.arsdigita.domain.DomainObject |
add, add, addToAssociation, afterDelete, beforeDelete, clear, delete, disconnect, equals, get, getObjectType, getOID, getSession, hashCode, 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 |
public static final String versionId
public static final String BASE_DATA_OBJECT_TYPE
Constructor Detail |
protected Portal(DataObject dataObject)
protected Portal(String dataObjectType)
public Portal(OID oid) throws DataObjectNotFoundException
Method Detail |
protected String getBaseDataObjectType()
DomainObject
getBaseDataObjectType
in class Resource
public static Portal createTemplate(String title)
title
- the default title of the portal template.
public static Portal create(String title, Resource parent)
title
- the default title of the portal template.
public static Portal create(String dataobj, String title, Resource parent)
public static Portal retrieve(BigDecimal portalID)
portalID
- the ID of the portal to retrieve.
public static Portal retrieve(OID oid)
oid
- the OID of the portal to retrieve.
public static Portal retrieve(DataObject dataObject)
dataObject
- the data object of the portal to retrieve.
public static PortalCollection retrieveAll()
public void clearPortlets()
public String getTitle()
getTitle
in class Resource
public void setTitle(String title)
setTitle
in class Resource
public boolean isTemplate()
protected void setTemplate(boolean isTemplate)
public void addPortlet(Portlet portlet, int cellNumber)
portlet
- the portlet instance to add.cellNumber
- the cell in which to place this portlet. cellNumber's
value must be greater than or equal to 1.public PortletCollection getPortlets()
public PortletCollection getPortletsForCell(int cellNumber)
public void swapPortletWithPrevious(Portlet portlet) throws PersistenceException
PersistenceException
public void swapPortletWithNext(Portlet portlet) throws PersistenceException
PersistenceException
public void movePortletToHead(Portlet portlet) throws PersistenceException
PersistenceException
public void movePortletToTail(Portlet portlet) throws PersistenceException
PersistenceException
protected void beforeSave()
beforeSave
in class Resource
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |