Java Doc for BaseSite.java in  » ERP-CRM-Financial » sakai » org » sakaiproject » site » impl » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » ERP CRM Financial » sakai » org.sakaiproject.site.impl 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.sakaiproject.site.impl.BaseSite

BaseSite
public class BaseSite implements Site(Code)

BaseSite is a base implementation of the Site API Site.



Field Summary
protected  booleanm_active
     Active flag.
protected  AuthzGroupm_azg
     The azg from the AuthzGroupService that is my AuthzGroup impl.
protected  booleanm_azgChanged
     Set to true if we have changed our azg, so it need to be written back on save.
protected  Timem_createdTime
     The time created.
protected  Stringm_createdUserId
     The created user id.
protected  booleanm_customPageOrdered
     Set to true to use the site's page order, or false to let a toolOrder override the page order.
protected  Collectionm_deletedGroups
     List of groups deleted in this edit pass.
protected  Stringm_description
     The site description.
protected  Stringm_event
     The event code for this edit.
protected  ResourceVectorm_groups
     The list of site groups for this site.
protected  booleanm_groupsLazy
     Set true while the groups have not yet been read in for a site.
protected  Stringm_icon
     The icon url.
protected  Stringm_id
     The site id.
protected  Stringm_info
     The site info url.
protected  booleanm_joinable
     Is this site joinable.
protected  Stringm_joinerRole
     The name of the role given to users who join a joinable site.
protected  Timem_lastModifiedTime
     The time last modified.
protected  Stringm_lastModifiedUserId
     The last modified user id.
protected  ResourceVectorm_pages
     The list of site pages for this site.
protected  booleanm_pagesLazy
     Set true while the pages have not yet been read in for a site.
protected  ResourcePropertiesEditm_properties
     The properties.
protected  booleanm_pubView
     The pubView flag.
protected  booleanm_published
     Published or not.
protected  Stringm_shortDescription
     The site short description.
protected  Stringm_skin
     The skin to use for this site.
protected  Stringm_title
     The site title.
protected  Stringm_type
     The site type.

Constructor Summary
public  BaseSite(String id)
     Construct.
public  BaseSite(Site other)
     Construct from another Site, exact.
public  BaseSite(Site other, boolean exact)
     Construct from another Site.
public  BaseSite(Element el)
     Construct from an existing definition, in xml.
public  BaseSite(String id, String title, String type, String shortDesc, String description, String iconUrl, String infoUrl, String skin, boolean published, boolean joinable, boolean pubView, String joinRole, boolean isSpecial, boolean isUser, String createdBy, Time createdOn, String modifiedBy, Time modifiedOn, boolean customPageOrdered)
     ReConstruct.

Method Summary
protected  voidactivate()
     Enable editing.
public  GroupaddGroup()
    
public  voidaddMember(String userId, String roleId, boolean active, boolean provided)
    
public  SitePageaddPage()
    
public  RoleaddRole(String id)
    
public  RoleaddRole(String id, Role other)
    
protected  voidcloseEdit()
     Close the edit object - it cannot be used after this.
public  intcompareTo(Object obj)
    
public  booleanequals(Object obj)
    
protected  AuthzGroupgetAzg()
     Access (find if needed) the azg from the AuthzGroupService that implements my grouping.
public  UsergetCreatedBy()
    
public  TimegetCreatedTime()
    
public  StringgetDescription()
    
protected  StringgetEvent()
     Access the event code for this edit.
public  GroupgetGroup(String id)
    
public  CollectiongetGroups()
    
public  CollectiongetGroupsWithMember(String userId)
    
public  CollectiongetGroupsWithMemberHasRole(String userId, String role)
    
public  StringgetIconUrl()
    
public  StringgetIconUrlFull()
    
public  StringgetId()
    
public  StringgetInfoUrl()
    
public  StringgetInfoUrlFull()
    
public  StringgetJoinerRole()
    
public  StringgetMaintainRole()
    
public  MembergetMember(String userId)
    
public  SetgetMembers()
    
public  UsergetModifiedBy()
    
public  TimegetModifiedTime()
    
public  ListgetOrderedPages()
    
public  SitePagegetPage(String id)
    
public  ListgetPages()
    
public  ResourcePropertiesgetProperties()
    
public  ResourcePropertiesEditgetPropertiesEdit()
    
public  StringgetProviderGroupId()
    
public  StringgetReference()
    
public  StringgetReference(String rootProperty)
    
public  RolegetRole(String id)
    
public  SetgetRoles()
    
public  SetgetRolesIsAllowed(String function)
    
public  StringgetShortDescription()
    
public  StringgetSkin()
    
public  StringgetTitle()
    
public  ToolConfigurationgetTool(String id)
    
public  ToolConfigurationgetToolForCommonId(String commonToolId)
    
public  CollectiongetTools(String commonToolId)
    
public  CollectiongetTools(String[] toolIds)
    
public  StringgetType()
    
public  StringgetUrl()
    
public  StringgetUrl(String rootProperty)
    
public  RolegetUserRole(String userId)
    
public  SetgetUsers()
    
public  SetgetUsersHasRole(String role)
    
public  SetgetUsersIsAllowed(String function)
    
public  booleanhasGroups()
    
public  booleanhasRole(String userId, String role)
    
public  inthashCode()
    
public  booleanisActiveEdit()
    
public  booleanisAllowed(String userId, String function)
    
public  booleanisCustomPageOrdered()
    
public  booleanisEmpty()
    
public  booleanisJoinable()
    
public  booleanisPubView()
    
public  booleanisPublished()
    
public  booleanisType(Object type)
    
public  booleankeepIntersection(AuthzGroup other)
    
public  voidloadAll()
    
public  voidregenerateIds()
    
public  voidremoveGroup(Group group)
    
public  voidremoveMember(String userId)
    
public  voidremoveMembers()
    
public  voidremovePage(SitePage page)
    
public  voidremoveRole(String role)
    
public  voidremoveRoles()
    
protected  voidset(BaseSite other, boolean exact)
    
public  voidsetCustomPageOrdered(boolean setting)
    
public  voidsetDescription(String description)
    
protected  voidsetEvent(String event)
     Set the event code for this edit.
public  voidsetIconUrl(String url)
    
public  voidsetInfoUrl(String url)
    
public  voidsetJoinable(boolean joinable)
    
public  voidsetJoinerRole(String role)
    
public  voidsetMaintainRole(String role)
    
public  voidsetProviderGroupId(String id)
    
public  voidsetPubView(boolean pubView)
    
public  voidsetPublished(boolean published)
    
public  voidsetShortDescription(String shortDescripion)
    
public  voidsetSkin(String skin)
    
public  voidsetTitle(String title)
    
public  voidsetType(String type)
    
public  ElementtoXml(Document doc, Stack stack)
    

Field Detail
m_active
protected boolean m_active(Code)
Active flag.



m_azg
protected AuthzGroup m_azg(Code)
The azg from the AuthzGroupService that is my AuthzGroup impl.



m_azgChanged
protected boolean m_azgChanged(Code)
Set to true if we have changed our azg, so it need to be written back on save.



m_createdTime
protected Time m_createdTime(Code)
The time created.



m_createdUserId
protected String m_createdUserId(Code)
The created user id.



m_customPageOrdered
protected boolean m_customPageOrdered(Code)
Set to true to use the site's page order, or false to let a toolOrder override the page order.



m_deletedGroups
protected Collection m_deletedGroups(Code)
List of groups deleted in this edit pass.



m_description
protected String m_description(Code)
The site description.



m_event
protected String m_event(Code)
The event code for this edit.



m_groups
protected ResourceVector m_groups(Code)
The list of site groups for this site.



m_groupsLazy
protected boolean m_groupsLazy(Code)
Set true while the groups have not yet been read in for a site.



m_icon
protected String m_icon(Code)
The icon url.



m_id
protected String m_id(Code)
The site id.



m_info
protected String m_info(Code)
The site info url.



m_joinable
protected boolean m_joinable(Code)
Is this site joinable.



m_joinerRole
protected String m_joinerRole(Code)
The name of the role given to users who join a joinable site.



m_lastModifiedTime
protected Time m_lastModifiedTime(Code)
The time last modified.



m_lastModifiedUserId
protected String m_lastModifiedUserId(Code)
The last modified user id.



m_pages
protected ResourceVector m_pages(Code)
The list of site pages for this site.



m_pagesLazy
protected boolean m_pagesLazy(Code)
Set true while the pages have not yet been read in for a site.



m_properties
protected ResourcePropertiesEdit m_properties(Code)
The properties.



m_pubView
protected boolean m_pubView(Code)
The pubView flag.



m_published
protected boolean m_published(Code)
Published or not.



m_shortDescription
protected String m_shortDescription(Code)
The site short description.



m_skin
protected String m_skin(Code)
The skin to use for this site.



m_title
protected String m_title(Code)
The site title.



m_type
protected String m_type(Code)
The site type.




Constructor Detail
BaseSite
public BaseSite(String id)(Code)
Construct.
Parameters:
  id - The site id.



BaseSite
public BaseSite(Site other)(Code)
Construct from another Site, exact.
Parameters:
  site - The other site to copy values from.
Parameters:
  exact - If true, we copy ids - else we generate new ones for site, page and tools.



BaseSite
public BaseSite(Site other, boolean exact)(Code)
Construct from another Site.
Parameters:
  site - The other site to copy values from.
Parameters:
  exact - If true, we copy ids - else we generate new ones for site, page and tools.



BaseSite
public BaseSite(Element el)(Code)
Construct from an existing definition, in xml.
Parameters:
  el - The message in XML in a DOM element.



BaseSite
public BaseSite(String id, String title, String type, String shortDesc, String description, String iconUrl, String infoUrl, String skin, boolean published, boolean joinable, boolean pubView, String joinRole, boolean isSpecial, boolean isUser, String createdBy, Time createdOn, String modifiedBy, Time modifiedOn, boolean customPageOrdered)(Code)
ReConstruct.
Parameters:
  id -
Parameters:
  title -
Parameters:
  type -
Parameters:
  shortDesc -
Parameters:
  description -
Parameters:
  iconUrl -
Parameters:
  infoUrl -
Parameters:
  skin -
Parameters:
  published -
Parameters:
  joinable -
Parameters:
  pubView -
Parameters:
  joinRole -
Parameters:
  isSpecial -
Parameters:
  isUser -
Parameters:
  createdBy -
Parameters:
  createdOn -
Parameters:
  modifiedBy -
Parameters:
  modifiedOn -




Method Detail
activate
protected void activate()(Code)
Enable editing.



addGroup
public Group addGroup()(Code)



addMember
public void addMember(String userId, String roleId, boolean active, boolean provided)(Code)



addPage
public SitePage addPage()(Code)



addRole
public Role addRole(String id) throws RoleAlreadyDefinedException(Code)



addRole
public Role addRole(String id, Role other) throws RoleAlreadyDefinedException(Code)



closeEdit
protected void closeEdit()(Code)
Close the edit object - it cannot be used after this.



compareTo
public int compareTo(Object obj)(Code)



equals
public boolean equals(Object obj)(Code)



getAzg
protected AuthzGroup getAzg()(Code)
Access (find if needed) the azg from the AuthzGroupService that implements my grouping. My azg.



getCreatedBy
public User getCreatedBy()(Code)



getCreatedTime
public Time getCreatedTime()(Code)



getDescription
public String getDescription()(Code)



getEvent
protected String getEvent()(Code)
Access the event code for this edit. The event code for this edit.



getGroup
public Group getGroup(String id)(Code)



getGroups
public Collection getGroups()(Code)



getGroupsWithMember
public Collection getGroupsWithMember(String userId)(Code)



getGroupsWithMemberHasRole
public Collection getGroupsWithMemberHasRole(String userId, String role)(Code)



getIconUrl
public String getIconUrl()(Code)



getIconUrlFull
public String getIconUrlFull()(Code)



getId
public String getId()(Code)



getInfoUrl
public String getInfoUrl()(Code)



getInfoUrlFull
public String getInfoUrlFull()(Code)



getJoinerRole
public String getJoinerRole()(Code)



getMaintainRole
public String getMaintainRole()(Code)



getMember
public Member getMember(String userId)(Code)



getMembers
public Set getMembers()(Code)



getModifiedBy
public User getModifiedBy()(Code)



getModifiedTime
public Time getModifiedTime()(Code)



getOrderedPages
public List getOrderedPages()(Code)



getPage
public SitePage getPage(String id)(Code)



getPages
public List getPages()(Code)



getProperties
public ResourceProperties getProperties()(Code)



getPropertiesEdit
public ResourcePropertiesEdit getPropertiesEdit()(Code)



getProviderGroupId
public String getProviderGroupId()(Code)



getReference
public String getReference()(Code)



getReference
public String getReference(String rootProperty)(Code)



getRole
public Role getRole(String id)(Code)



getRoles
public Set getRoles()(Code)



getRolesIsAllowed
public Set getRolesIsAllowed(String function)(Code)



getShortDescription
public String getShortDescription()(Code)



getSkin
public String getSkin()(Code)



getTitle
public String getTitle()(Code)



getTool
public ToolConfiguration getTool(String id)(Code)



getToolForCommonId
public ToolConfiguration getToolForCommonId(String commonToolId)(Code)



getTools
public Collection getTools(String commonToolId)(Code)



getTools
public Collection getTools(String[] toolIds)(Code)



getType
public String getType()(Code)



getUrl
public String getUrl()(Code)



getUrl
public String getUrl(String rootProperty)(Code)



getUserRole
public Role getUserRole(String userId)(Code)



getUsers
public Set getUsers()(Code)



getUsersHasRole
public Set getUsersHasRole(String role)(Code)



getUsersIsAllowed
public Set getUsersIsAllowed(String function)(Code)



hasGroups
public boolean hasGroups()(Code)



hasRole
public boolean hasRole(String userId, String role)(Code)



hashCode
public int hashCode()(Code)



isActiveEdit
public boolean isActiveEdit()(Code)



isAllowed
public boolean isAllowed(String userId, String function)(Code)



isCustomPageOrdered
public boolean isCustomPageOrdered()(Code)



isEmpty
public boolean isEmpty()(Code)



isJoinable
public boolean isJoinable()(Code)



isPubView
public boolean isPubView()(Code)



isPublished
public boolean isPublished()(Code)



isType
public boolean isType(Object type)(Code)



keepIntersection
public boolean keepIntersection(AuthzGroup other)(Code)



loadAll
public void loadAll()(Code)



regenerateIds
public void regenerateIds()(Code)



removeGroup
public void removeGroup(Group group)(Code)



removeMember
public void removeMember(String userId)(Code)



removeMembers
public void removeMembers()(Code)



removePage
public void removePage(SitePage page)(Code)



removeRole
public void removeRole(String role)(Code)



removeRoles
public void removeRoles()(Code)



set
protected void set(BaseSite other, boolean exact)(Code)
Set me to be a deep copy of other (all but my id.)
Parameters:
  bOther - the other to copy.
Parameters:
  exact - If true, we copy ids - else we generate new ones for site, page and tools.



setCustomPageOrdered
public void setCustomPageOrdered(boolean setting)(Code)



setDescription
public void setDescription(String description)(Code)



setEvent
protected void setEvent(String event)(Code)
Set the event code for this edit.
Parameters:
  event - The event code for this edit.



setIconUrl
public void setIconUrl(String url)(Code)



setInfoUrl
public void setInfoUrl(String url)(Code)



setJoinable
public void setJoinable(boolean joinable)(Code)



setJoinerRole
public void setJoinerRole(String role)(Code)



setMaintainRole
public void setMaintainRole(String role)(Code)



setProviderGroupId
public void setProviderGroupId(String id)(Code)



setPubView
public void setPubView(boolean pubView)(Code)



setPublished
public void setPublished(boolean published)(Code)



setShortDescription
public void setShortDescription(String shortDescripion)(Code)



setSkin
public void setSkin(String skin)(Code)



setTitle
public void setTitle(String title)(Code)



setType
public void setType(String type)(Code)



toXml
public Element toXml(Document doc, Stack stack)(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.