Java Doc for Site.java in » ERP-CRM-Financial » sakai » org » sakaiproject » site » api » 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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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.api

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.sakaiproject.site.api .Site

All known Subclasses:   org.sakaiproject.site.impl .BaseSite,
Site
public interface Site extends Edit,Comparable,Serializable,AuthzGroup(Code)

Site is the object that knows the information, tools and layouts for a Sakai Site.

Method Summary
Group addGroup()
     Add a new group.
SitePage addPage()
     Create a new site page and add it to this site.
User getCreatedBy()

Time getCreatedTime()

String getDescription()
     A longer text Description of the site.
Group getGroup(String id)
     Get a site group
Parameters:
  id - The group id (or reference).
Collection getGroups()
     Get a collection of the groups in a Site.
Collection getGroupsWithMember(String userId)
     Get a collection of the groups in a Site that have this user as a member.
Parameters:
  userId - The user id.
Collection getGroupsWithMemberHasRole(String userId, String role)
     Get a collection of the groups in a Site that have this user as a member with this role.
Parameters:
  userId - The user id.
Parameters:
  role - The role.
String getIconUrl()
     The Site's icon URL.
String getIconUrlFull()
     The Site's icon URL as a full URL.
String getInfoUrl()
     The Site's info display URL.
String getInfoUrlFull()
     The Site's info display URL as a full URL.
String getJoinerRole()
     the role name given to users who join a joinable site.
User getModifiedBy()

Time getModifiedTime()

List getOrderedPages()
     The pages ordered by the tool order constraint for this site's type (as tool category), or the site's pages in defined order if the site is set to have a custom page order.
SitePage getPage(String id)
     Access the SitePage that has this id, if one is defined, else return null.
Parameters:
  id - The id of the SitePage.
List getPages()
     the List (SitePage) of Site Pages.
String getShortDescription()
     A short text Description of the site.
String getSkin()
     the skin to use for this site.
String getTitle()
     The human readable Title of the site.
ToolConfiguration getTool(String id)
     Access the ToolConfiguration that has this id, if one is defined, else return null.
ToolConfiguration getToolForCommonId(String commonToolId)
     Get the first tool placed on the site on any page with the specified common Tool id (such as sakai.chat)
Parameters:
  commonToolId - The common ToolID to search for (i.e.
Collection getTools(String[] toolIds)
     Get all the tools placed in the site on any page that are of any of these tool ids.
Parameters:
  toolIds - The tool id array (String, such as sakai.chat, not a tool configuration / placement uuid) to search for.
Collection getTools(String commonToolId)
     Get all the tools placed in the site on any page for a particular common Tool Id.
Parameters:
  commonToolId - The tool id (String, such as sakai.chat, not a tool configuration / placement uuid) to search for.
String getType()
     Access the site type.
boolean hasGroups()

boolean isCustomPageOrdered()

boolean isJoinable()
     true if this Site can be joined by anyone, false if not.
boolean isPubView()
     Check if the site is marked for viewing.
boolean isPublished()
     true if the site is published, false if not.
boolean isType(Object type)
     Test if the site is of this type.
void loadAll()

void regenerateIds()
     Generate a new set of pages and tools that have new, unique ids.
void removeGroup(Group group)
     Remove this group from the groups for this site.
void removePage(SitePage page)
     Remove a site page from this site.
void setCustomPageOrdered(boolean custom)
     Set the site's custom page order flag.
void setDescription(String description)
     Set the Description of the site.
void setIconUrl(String url)
     Set the url of an icon for the site.
void setInfoUrl(String url)
     Set the url for information about the site.
void setJoinable(boolean joinable)
     Set the joinable status of the site.
void setJoinerRole(String role)
     Set the joiner role for a site.
void setPubView(boolean pubView)
     Set the site view.
void setPublished(boolean published)
     Set the published state of this site.
void setShortDescription(String description)
     Set the short Description of the site.
void setSkin(String skin)
     Set the skin to use for this site.
void setTitle(String title)
     Set the human readable Title of the site.
void setType(String type)
     Set the site type.

Method Detail
addGroup
Group addGroup()(Code)
Add a new group. The Id is generated, the rest of the fields can be set using calls to the Group object returned.

addPage
SitePage addPage()(Code)
Create a new site page and add it to this site. The SitePage object for the new site page.

getCreatedBy
User getCreatedBy()(Code)
the user who created this.

getCreatedTime
Time getCreatedTime()(Code)
the time created.

getDescription
String getDescription()(Code)
A longer text Description of the site.

getGroup
Group getGroup(String id)(Code)
Get a site group
Parameters:
  id - The group id (or reference). The Group object if found, or null if not found.

getGroups
Collection getGroups()(Code)
Get a collection of the groups in a Site. A collection (Group) of groups defined in the site, empty if there are none.

getGroupsWithMember
Collection getGroupsWithMember(String userId)(Code)
Get a collection of the groups in a Site that have this user as a member.
Parameters:
  userId - The user id. A collection (Group) of groups defined in the site that have this user as a member, empty if there are none.

getGroupsWithMemberHasRole
Collection getGroupsWithMemberHasRole(String userId, String role)(Code)
Get a collection of the groups in a Site that have this user as a member with this role.
Parameters:
  userId - The user id.
Parameters:
  role - The role. A collection (Group) of groups defined in the site that have this user as a member with this role, empty if there are none.

getIconUrl
String getIconUrl()(Code)
The Site's icon URL.

getIconUrlFull
String getIconUrlFull()(Code)
The Site's icon URL as a full URL.

getInfoUrl
String getInfoUrl()(Code)
The Site's info display URL.

getInfoUrlFull
String getInfoUrlFull()(Code)
The Site's info display URL as a full URL.

getJoinerRole
String getJoinerRole()(Code)
the role name given to users who join a joinable site.

getModifiedBy
User getModifiedBy()(Code)
the user who last modified this.

getModifiedTime
Time getModifiedTime()(Code)
the time last modified.

getOrderedPages
List getOrderedPages()(Code)
The pages ordered by the tool order constraint for this site's type (as tool category), or the site's pages in defined order if the site is set to have a custom page order.

getPage
SitePage getPage(String id)(Code)
Access the SitePage that has this id, if one is defined, else return null.
Parameters:
  id - The id of the SitePage. The SitePage that has this id, if one is defined, else return null.

getPages
List getPages()(Code)
the List (SitePage) of Site Pages.

getShortDescription
String getShortDescription()(Code)
A short text Description of the site.

getSkin
String getSkin()(Code)
the skin to use for this site.

getTitle
String getTitle()(Code)
The human readable Title of the site.

getTool
ToolConfiguration getTool(String id)(Code)
Access the ToolConfiguration that has this id, if one is defined, else return null. The tool may be on any SitePage in the site.
Parameters:
  id - The id of the tool. The ToolConfiguration that has this id, if one is defined, else return null.

getToolForCommonId
ToolConfiguration getToolForCommonId(String commonToolId)(Code)
Get the first tool placed on the site on any page with the specified common Tool id (such as sakai.chat)
Parameters:
  commonToolId - The common ToolID to search for (i.e. sakai.chat) ToolConfiguration for the tool which has the ID (if any) or null if no tools match.

getTools
Collection getTools(String[] toolIds)(Code)
Get all the tools placed in the site on any page that are of any of these tool ids.
Parameters:
  toolIds - The tool id array (String, such as sakai.chat, not a tool configuration / placement uuid) to search for. A Collection (ToolConfiguration) of all the tools placed in the site on any page that are of this tool id (may be empty).

getTools
Collection getTools(String commonToolId)(Code)
Get all the tools placed in the site on any page for a particular common Tool Id.
Parameters:
  commonToolId - The tool id (String, such as sakai.chat, not a tool configuration / placement uuid) to search for. A Collection (ToolConfiguration) of all the tools placed in the site on any page that are of this tool id (may be empty).

getType
String getType()(Code)
Access the site type. The site type.

hasGroups
boolean hasGroups()(Code)
Does the site have any groups defined? true if the site and has any groups, false if not.

isCustomPageOrdered
boolean isCustomPageOrdered()(Code)
Check if the site has a custom page order true if the site has a custom page order, false if not.

isJoinable
boolean isJoinable()(Code)
true if this Site can be joined by anyone, false if not.

isPubView
boolean isPubView()(Code)
Check if the site is marked for viewing. True if the site is marked for viewing, false if not

isPublished
boolean isPublished()(Code)
true if the site is published, false if not.

isType
boolean isType(Object type)(Code)
Test if the site is of this type. It is if the param is null.
Parameters:
  type - A String type to match, or a String[], List or Set of Strings, any of which can match. true if the site is of the type(s) specified, false if not.

loadAll
void loadAll()(Code)
Make sure pages and tools, groups and properties are loaded, not lazy

regenerateIds
void regenerateIds()(Code)
Generate a new set of pages and tools that have new, unique ids. Good if the site had non-unique-system-wide ids for pages and tools. The Site Id does not change.

removeGroup
void removeGroup(Group group)(Code)
Remove this group from the groups for this site.
Parameters:
  group - The group to remove.

removePage
void removePage(SitePage page)(Code)
Remove a site page from this site.
Parameters:
  page - The SitePage to remove.

setCustomPageOrdered
void setCustomPageOrdered(boolean custom)(Code)
Set the site's custom page order flag.
Parameters:
  custom - true if the site has a custom page ordering, false if not.

setDescription
void setDescription(String description)(Code)
Set the Description of the site. Used to give a longer text description of the site.
Parameters:
  description - The new description.

setIconUrl
void setIconUrl(String url)(Code)
Set the url of an icon for the site.
Parameters:
  url - The new icon's url.

setInfoUrl
void setInfoUrl(String url)(Code)
Set the url for information about the site.
Parameters:
  url - The new information url.

setJoinable
void setJoinable(boolean joinable)(Code)
Set the joinable status of the site.
Parameters:
  joinable - represents whether the site is joinable (true) or not (false).

setJoinerRole
void setJoinerRole(String role)(Code)
Set the joiner role for a site.
Parameters:
  role - the joiner role for a site.

setPubView
void setPubView(boolean pubView)(Code)
Set the site view.
Parameters:
  pubView - The site view setting.

setPublished
void setPublished(boolean published)(Code)
Set the published state of this site.
Parameters:
  status - The published state of the site.

setShortDescription
void setShortDescription(String description)(Code)
Set the short Description of the site. Used to give a short text description of the site.
Parameters:
  description - The new short description.

setSkin
void setSkin(String skin)(Code)
Set the skin to use for this site.
Parameters:
  skin - The skin to use for this site.

setTitle
void setTitle(String title)(Code)
Set the human readable Title of the site.
Parameters:
  title - the new title.

setType
void setType(String type)(Code)
Set the site type.
Parameters:
  type - The site type.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.