|
|||||||||||
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.web.Application
com.arsdigita.portalserver.PortalSite
A PortalSite
is a mountable Portal instance, complete
with URL. A PortalSite is made up of one or more PortalTabs
.
A PortalTab
is in turn comprised of zero or more Portlets.
A PortalSite
presents what the User considers to be
a "Portal". For the sake of clarity, however, in the source code side
of things, a Portal
is actually a domain class in CCM Core,
used as a foundation class by PortalSite
.
Field Summary | |
static String |
BASE_DATA_OBJECT_TYPE
|
Fields inherited from class com.arsdigita.web.Application |
PRIMARY_URL, 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 |
PortalSite(com.arsdigita.persistence.DataObject dataObject)
Constructor for PortalSite. |
Method Summary | |
void |
addMember(com.arsdigita.kernel.Party member)
add a participant as a member, the party should not already be a participant. |
void |
addParticipant(com.arsdigita.kernel.Party participant)
Adds participant and grants participant read privilege on the workspace. |
void |
addParticipant(com.arsdigita.kernel.Party participant,
boolean addDefaultPriv)
Adds participant and optionally grants participant read privilege on the PortalSite. |
void |
addPortalTab(PortalTab ptab)
|
void |
addRelatedPortalSite(PortalSite portalsite)
|
protected void |
afterSave()
|
void |
archive()
|
void |
archiveRecurse()
|
protected void |
beforeDelete()
|
protected void |
beforeSave()
|
static PortalSite |
createPortalSite(String urlName,
String title,
PortalSite parent)
|
static PortalSite |
createPortalSite(String urlName,
String title,
PortalSite parent,
boolean inheritPermissions)
|
static PortalSite |
createSubPortal(PortalSite ps,
com.arsdigita.kernel.User user)
|
PortalSiteCollection |
getAllChildPortalSites()
|
PortalSiteCollection |
getAllRelatedPortalSites()
|
static PortalSiteCollection |
getAllRootPortalSites()
|
Date |
getArchiveDate()
|
protected String |
getBaseDataObjectType()
|
PortalSiteCollection |
getChildPortalSites()
|
Date |
getCreationDate()
|
static PortalSite |
getCurrentPortalSite(javax.servlet.http.HttpServletRequest request)
|
RoleCollection |
getDirectRolesFor(com.arsdigita.kernel.Party p)
|
com.arsdigita.web.ApplicationCollection |
getFullPagePortalSiteApplications()
|
Role |
getMemberRole()
Returns the member role. |
String |
getMission()
Returns the Mission statement for the Portal |
com.arsdigita.kernel.PartyCollection |
getNonParticipants()
|
long |
getParticipantCount()
|
Iterator |
getParticipantInitials()
Get a list of all the distinct "initials" of participants in a Portal Site. |
com.arsdigita.kernel.PartyCollection |
getParticipants()
|
com.arsdigita.kernel.PartyCollection |
getParticipantsWithInitial(String initial)
Get a collection of all participants in the Portal Site whose initial (see getParticipantInitials for a definition of a participant's
initial) is the specified value. |
static PortalSite |
getPortalSiteForApplication(com.arsdigita.web.Application app)
|
static PortalSite |
getPortalSiteForAppPortlet(com.arsdigita.portal.apportlet.AppPortlet portlet)
|
PortalSiteCollection |
getRelatedPortalSites()
|
RoleCollection |
getRoles()
Returns the collection of roles in this portal site. |
RoleCollection |
getRolesFor(com.arsdigita.kernel.Party p)
Returns the collection of roles in this workspace that the specified party is contained in. |
static PortalSiteCollection |
getRootPortalSites()
|
PortalTabCollection |
getTabsForPortalSite()
|
Theme |
getTheme()
Returns the Theme object for this Portal |
protected void |
initialize()
|
boolean |
isAppTypeInPortalSite(com.arsdigita.web.ApplicationType appType)
This method is used by portlet create and app create form flow to determine if an apptype is already present for a PortalSite. |
boolean |
isArchived()
|
boolean |
isDirectMember(com.arsdigita.kernel.Party party)
|
boolean |
isDirectParticipant(com.arsdigita.kernel.Party party)
|
boolean |
isDraft()
|
boolean |
isMember(com.arsdigita.kernel.Party party)
|
boolean |
isParticipant(com.arsdigita.kernel.Party party)
|
boolean |
isPersonalizable()
|
boolean |
isReady()
|
boolean |
isSubPortal()
|
void |
moveTabToHead(PortalTab ptab)
|
void |
moveTabToTail(PortalTab ptab)
|
void |
normalizeTabSortKeys()
|
void |
removeParticipant(com.arsdigita.kernel.Party participant)
remove a participant or member from workspace and revoke privileges on the Portal Site |
void |
removePortalTab(PortalTab ptab)
|
void |
removeRelatedPortalSite(PortalSite portalsite)
|
static PortalSiteCollection |
retrieveAll()
Deprecated. Use PortalSite.retrieveAllPortalSites(). |
static PortalSiteCollection |
retrieveAllActivePortalSites()
Returns a collection of all active PortalSite's currently mounted on the server. |
static PortalSiteCollection |
retrieveAllPortalSites()
Returns a collection of all PortalSite's currently mounted on the server. |
static PortalSite |
retrievePortalSite(BigDecimal id)
|
static PortalSite |
retrievePortalSite(com.arsdigita.persistence.DataObject dataObject)
|
static PortalSite |
retrievePortalSite(com.arsdigita.persistence.OID oid)
|
static PortalSite |
retrievePortalSiteForSiteNode(com.arsdigita.kernel.SiteNode siteNode)
|
void |
setArchived()
|
void |
setArchiveDate()
|
void |
setArchiveDate(Date adate)
|
void |
setCreationDate()
|
void |
setCreationDate(Date cdate)
|
void |
setDraft(boolean isDraft)
|
void |
setIsSubPortal(boolean issubportal)
|
void |
setMission(String mission)
Set's the mission statement for a Portal. |
void |
setPersonalizable(boolean isPersonalizable)
|
void |
setReady(boolean isReady)
|
void |
setTheme(Theme theme)
Associates a Theme object with this Portal. |
void |
setUnarchived()
|
void |
swapTabWithNext(PortalTab ptab)
|
void |
swapTabWithPrevious(PortalTab ptab)
|
void |
unarchive()
|
Methods inherited from class com.arsdigita.web.Application |
afterDelete, createApplication, createApplication, createRootApplication, getAncestorApplications, getApplicationType, getCanonicalURL, getChildApplications, getChildApplicationsForType, getContainingApplication, getContextPath, getCurrentApplication, getPackageType, getParentApplication, getPath, getPrimaryURL, getRelevantPrivileges, getServletPath, getSiteNode, getStylesheetPath, isInstalled, retrieveAllApplications, retrieveApplication, retrieveApplication, retrieveApplication, retrieveApplicationForPath, retrieveApplicationForSiteNode, setApplicationType, setParentApplication, setPath |
Methods inherited from class com.arsdigita.kernel.Resource |
createResource, createResource, getChildResources, getContainer, getContainingResource, getDescription, getDisplayName, getParentResource, getResourceType, getTimestamp, getTitle, isContainerModified, retrieveAllResources, retrieveResource, retrieveResource, retrieveResource, setDescription, setParentResource, setResourceType, setTitle |
Methods inherited from class com.arsdigita.kernel.ACSObject |
assertPrivilege, checkPrivilege, doCreateCheck, doWriteCheck, getDefaultDomainClass, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, setID, setID |
Methods inherited from class com.arsdigita.domain.ObservableDomainObject |
addObserver, getObservers |
Methods inherited from class com.arsdigita.domain.DomainObject |
add, add, addToAssociation, 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 BASE_DATA_OBJECT_TYPE
Constructor Detail |
protected PortalSite(com.arsdigita.persistence.DataObject dataObject)
createPortalSite()
method for a new PortalSite object.
Method Detail |
protected String getBaseDataObjectType()
protected void initialize()
public static PortalSite createPortalSite(String urlName, String title, PortalSite parent, boolean inheritPermissions)
public static PortalSite createPortalSite(String urlName, String title, PortalSite parent)
public static PortalSiteCollection retrieveAll()
public static PortalSiteCollection retrieveAllPortalSites()
public static PortalSiteCollection retrieveAllActivePortalSites()
public static PortalSite retrievePortalSiteForSiteNode(com.arsdigita.kernel.SiteNode siteNode)
public static PortalSite retrievePortalSite(BigDecimal id)
public static PortalSite retrievePortalSite(com.arsdigita.persistence.OID oid)
public static PortalSite retrievePortalSite(com.arsdigita.persistence.DataObject dataObject)
protected void beforeSave()
protected void afterSave()
protected void beforeDelete()
public com.arsdigita.web.ApplicationCollection getFullPagePortalSiteApplications()
public boolean isAppTypeInPortalSite(com.arsdigita.web.ApplicationType appType)
public PortalSiteCollection getChildPortalSites()
public PortalSiteCollection getAllChildPortalSites()
public PortalSiteCollection getRelatedPortalSites()
public PortalSiteCollection getAllRelatedPortalSites()
public static PortalSite getPortalSiteForApplication(com.arsdigita.web.Application app)
public static PortalSite getPortalSiteForAppPortlet(com.arsdigita.portal.apportlet.AppPortlet portlet)
public static PortalSite getCurrentPortalSite(javax.servlet.http.HttpServletRequest request)
public static PortalSiteCollection getRootPortalSites()
public static PortalSiteCollection getAllRootPortalSites()
public void addRelatedPortalSite(PortalSite portalsite)
public void removeRelatedPortalSite(PortalSite portalsite)
public boolean isDirectParticipant(com.arsdigita.kernel.Party party)
public boolean isParticipant(com.arsdigita.kernel.Party party)
public boolean isDirectMember(com.arsdigita.kernel.Party party)
public boolean isMember(com.arsdigita.kernel.Party party)
public void addMember(com.arsdigita.kernel.Party member)
public void addParticipant(com.arsdigita.kernel.Party participant)
public void addParticipant(com.arsdigita.kernel.Party participant, boolean addDefaultPriv)
addDefaultPriv
- whether or not the read privilege should be
grantedpublic void removeParticipant(com.arsdigita.kernel.Party participant)
public com.arsdigita.kernel.PartyCollection getParticipants()
public long getParticipantCount()
public com.arsdigita.kernel.PartyCollection getNonParticipants()
public com.arsdigita.kernel.PartyCollection getParticipantsWithInitial(String initial)
Get a collection of all participants in the Portal Site whose
initial (see getParticipantInitials
for a definition of a participant's
initial) is the specified value.
initial
- Single-character string, must be uppercasepublic Role getMemberRole()
public RoleCollection getRoles()
public RoleCollection getDirectRolesFor(com.arsdigita.kernel.Party p)
public RoleCollection getRolesFor(com.arsdigita.kernel.Party p)
public void addPortalTab(PortalTab ptab)
public void removePortalTab(PortalTab ptab)
public PortalTabCollection getTabsForPortalSite()
public void swapTabWithPrevious(PortalTab ptab) throws com.arsdigita.persistence.PersistenceException
com.arsdigita.persistence.PersistenceException
public void swapTabWithNext(PortalTab ptab) throws com.arsdigita.persistence.PersistenceException
com.arsdigita.persistence.PersistenceException
public void moveTabToHead(PortalTab ptab)
public void moveTabToTail(PortalTab ptab)
public void normalizeTabSortKeys()
public boolean isReady()
public void setReady(boolean isReady)
public boolean isDraft()
public void setDraft(boolean isDraft)
public boolean isPersonalizable()
public void setPersonalizable(boolean isPersonalizable)
public boolean isSubPortal()
public void setIsSubPortal(boolean issubportal)
public boolean isArchived()
public void setArchived()
public void setUnarchived()
public void setCreationDate(Date cdate)
public void setCreationDate()
public Date getCreationDate()
public void setArchiveDate(Date adate)
public void setArchiveDate()
public Date getArchiveDate()
public void archive()
public void archiveRecurse()
public void unarchive()
public String getMission()
public void setMission(String mission)
public void setTheme(Theme theme)
public Theme getTheme()
public Iterator getParticipantInitials()
Get a list of all the distinct "initials" of participants in a Portal Site.
A participant's initial is defined as the first letter of their family name when the participant is a user (i.e. a person), and the first letter of the group name if the participant is a group.
The returned Iterator contains the initials in increasing alphabetical order.
public static PortalSite createSubPortal(PortalSite ps, com.arsdigita.kernel.User user)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |