|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.bea.netuix.application.definition.CommunityDefinition
public class CommunityDefinition
Runtime representation of a community. <p/>The overview of community functionality contains a description of the community framework.
Constructor Summary | |
---|---|
CommunityDefinition(CommunityInfo communityInfo) Constructor |
Method Summary | |
---|---|
protected Map<String,CommunityProperty> |
cloneProperties() Returns a clone of the properties associated with this community. |
boolean |
equals(Object o) |
String |
getCommunityCallbackClass() Returns the name of the callback class associated with this community. |
CommunityDefinitionId |
getCommunityDefinitionId() Retrieves the CommunityDefinitionId for this this community. |
CommunityDesktop |
getCommunityDesktop() This property is only used by the Communities framework to specify the CommunityDesktop for use in creating a new Community, as the information contained withing a CommunityDesktop object is only useful for specifying various flags that control the creation of a Community. |
CommunityInfo |
getCommunityInfo() Get a CommunityInfo object representing all the settings for this CommunityDefinition |
CommunityURI |
getCommunityURI() Retrieves the CommunityURI for this community, which serves to uniquely identify the community. |
Date |
getCreatedDate() Returns date this CommunityDefinition was created. |
String |
getDescription() Retrieves the localized description for this community. |
DesktopDefinitionId |
getDesktopDefinitionId() Retrieves the DesktopDefinitionId of the desktop associated with this community. |
DesktopPath |
getDesktopPath() Returns the desktop path of the desktop associated with this community. |
String |
getErrorUri() Retrieves the error page URI for this community. |
Date |
getExpirationDate() Retrieves the expiration date for this community. |
LocalizationIntersectionId |
getLocalizationIntersectionId() Returns the LocalizationIntersectionId for this community. |
LocalizationResource |
getLocalizationResource() Returns the LocalizationResource associated with this CommunityDefinition based on the locale of the request used for retrieving it. |
LocalizationResource |
getLocalizationResource(javax.servlet.http.HttpServletRequest request) Returns the LocalizationResource associated with this CommunityDefinition based the locale(s) specified in the input request. |
Date |
getModifiedDate() Returns date last time this CommunityDefinition was modified. |
CommunityDefinitionId |
getParentId() Returns the CommunityDefinitionId of the community that is the parent of this community. |
PortalPath |
getPortalPath() Returns the portal path of the portal this community resides in. |
Map<String,CommunityProperty> |
getProperties() Returns the properties associated with this community. |
String |
getRegistrationPageUri() Returns the uri to the registration page. |
TimeZone |
getTimeZone() Retrieves the TimeZone associated with this Community . |
String |
getTitle() Retrieves the localized title for this community. |
String |
getWebAppName() Returns the name of the web application this template resides in |
int |
hashCode() |
boolean |
isAccessTrackingEnabled() Returns true if member access tracking is enabled for this community. |
boolean |
isActive() Returns true if this community is active, false otherwise. |
boolean |
isGlobal() Returns true if this community is a global template |
boolean |
isPersonalPagesEnabled() Returns true if this community allows its members to add personal pages to the community, false otherwise. |
boolean |
isPublic() Returns true if this community is public, false otherwise. |
boolean |
isPublicRegistrationEnabled() Returns true if this community allows members to self register without an invitation, false otherwise. |
boolean |
isTemplate() Returns true if this community is marked as a template, false otherwise. |
String |
toString() |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public CommunityDefinition(CommunityInfo communityInfo)
communityInfo
- data object that holds information about this CommunityDefinition
Method Detail |
---|
public CommunityInfo getCommunityInfo()
CommunityDefinition
public CommunityDefinitionId getCommunityDefinitionId()
CommunityDefinitionId
for this this community. May be null
if this CommunityDefinition
has not been retrieved using the ICommunityManager
api.CommunityDefinitionId
for this communitypublic LocalizationResource getLocalizationResource()
LocalizationResource
associated with this CommunityDefinition
based on the locale of the request used for retrieving it. May return null if this CommunityDefinition
is retrieved by setting the localize
flag to false
on the various getCommunity
methods on ICommunityManager
.getLocalizationResource
in interface TemplateDefinition
LocalizationResource
associated with this communitypublic LocalizationResource getLocalizationResource(javax.servlet.http.HttpServletRequest request) throws CommunityException
LocalizationResource
associated with this CommunityDefinition
based the locale(s) specified in the input request.request
- http requestCommunityException
public String getWebAppName()
TemplateDefinition
getWebAppName
in interface TemplateDefinition
public LocalizationIntersectionId getLocalizationIntersectionId()
LocalizationIntersectionId
for this community. Returns null if no LocalizationResource is associated with this desktop or this CommunityDefinition
has not been retrieved from the database. A LocalizationIntersectionId
is a reference to all localized versions of title and description for an entity.LocalizationIntersectionId
for this communitypublic String getTitle()
public String getDescription()
public CommunityDesktop getCommunityDesktop()
CommunityDesktop
for use in creating a new Community, as the information contained withing a CommunityDesktop object is only useful for specifying various flags that control the creation of a Community. In all other cases, such as retrieving a CommunityDefinition
from the ICommunityManager
, this property will be null.CommunityDesktop
public DesktopDefinitionId getDesktopDefinitionId()
DesktopDefinitionId
of the desktop associated with this community. May return null
if this CommunityDefinition was not retrieved using the CommunityManager API.DesktopDefinitionId
public CommunityURI getCommunityURI()
CommunityURI
for this community, which serves to uniquely identify the community.CommunityURI
for this community, or null
if none has yet been associated with the community.public Date getExpirationDate()
null
if the community never expires.public TimeZone getTimeZone()
TimeZone
associated with this Community
.public boolean isActive()
true
if this community is active, false
otherwise.true
if this community is active, false
otherwisepublic boolean isPublic()
true
if this community is public, false
otherwise.true
if this community is public, false
otherwise.public boolean isTemplate()
true
if this community is marked as a template, false
otherwise.true
if this community is marked as a template, false
otherwisepublic boolean isGlobal()
true
if this community is a global templatetrue
if this community is a global template, false
otherwisepublic boolean isPersonalPagesEnabled()
true
if this community allows its members to add personal pages to the community, false
otherwise.true
if this community allows its members to add personal pages to the community, false
otherwisepublic boolean isPublicRegistrationEnabled()
true
if this community allows members to self register without an invitation, false
otherwise.true
if this community allows members to self register without an invitation, false
otherwisepublic String getRegistrationPageUri()
public String getErrorUri()
public boolean isAccessTrackingEnabled()
true
if member access tracking is enabled for this community.true
if member access tracking is enabled, false otherwisepublic Map<String,CommunityProperty> getProperties()
null
if this CommunityDefinition
has not been retrieved using the ICommunityManager
api.public DesktopPath getDesktopPath()
public PortalPath getPortalPath()
public String getCommunityCallbackClass()
public CommunityDefinitionId getParentId()
CommunityDefinitionId
of the community that is the parent of this community. Returns null if this community has no parent.CommunityDefinitionId
of parent communitypublic String toString()
toString
in class Object
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public Date getCreatedDate()
CommunityDefinition
was created.getCreatedDate
in interface DateableDefinition
public Date getModifiedDate()
CommunityDefinition
was modified.getModifiedDate
in interface DateableDefinition
protected Map<String,CommunityProperty> cloneProperties()
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.