Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.sakaiproject.mock.service
Class SiteService

java.lang.Object
  extended by org.sakaiproject.mock.service.SiteService
All Implemented Interfaces:
org.sakaiproject.entity.api.EntityProducer, org.sakaiproject.site.api.SiteService
public class SiteService
extends Object
implements org.sakaiproject.site.api.SiteService

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.sakaiproject.site.api.SiteService
org.sakaiproject.site.api.SiteService.SelectionType, org.sakaiproject.site.api.SiteService.SortType
 
Field Summary
 
Fields inherited from interface org.sakaiproject.site.api.SiteService
APPLICATION_ID, EVENT_USER_GROUP_MEMBERSHIP_ADD, EVENT_USER_GROUP_MEMBERSHIP_REMOVE, EVENT_USER_GROUP_MEMBERSHIP_UPDATE, EVENT_USER_SITE_MEMBERSHIP_ADD, EVENT_USER_SITE_MEMBERSHIP_REMOVE, EVENT_USER_SITE_MEMBERSHIP_UPDATE, GROUP_SUBTYPE, MAIN_CONTAINER, PAGE_SUBTYPE, PROP_PARENT_ID, PROP_SHOW_SUBSITES, REFERENCE_ROOT, SECURE_ADD_COURSE_SITE, SECURE_ADD_PORTFOLIO_SITE, SECURE_ADD_SITE, SECURE_ADD_USER_SITE, SECURE_REMOVE_SITE, SECURE_REMOVE_SOFTLY_DELETED_SITE, SECURE_UPDATE_GROUP_MEMBERSHIP, SECURE_UPDATE_SITE, SECURE_UPDATE_SITE_MEMBERSHIP, SECURE_VIEW_ROSTER, SITE_ERROR, SITE_ROLE_SWAP, SITE_SUBTYPE, SITE_TEMPLATE, SITE_VISIT, SITE_VISIT_SOFTLY_DELETED, SITE_VISIT_UNPUBLISHED, TOOL_SUBTYPE, URL_ERROR, USER_SITE_TEMPLATE
 
Constructor Summary
SiteService()
           
 
Method Summary
 Site addSite(String id, org.sakaiproject.site.api.Site other)
           
 Site addSite(String id, String type)
           
 void addSiteAdvisor(org.sakaiproject.site.api.SiteAdvisor advisor)
           
 boolean allowAccessSite(String id)
           
 boolean allowAddCourseSite()
           
 boolean allowAddPortfolioSite()
           
 boolean allowAddSite(String id)
           
 boolean allowRemoveSite(String id)
           
 boolean allowRoleSwap(String id)
           
 boolean allowUnjoinSite(String id)
           
 boolean allowUpdateGroupMembership(String id)
           
 boolean allowUpdateSite(String id)
           
 boolean allowUpdateSiteMembership(String id)
           
 boolean allowViewRoster(String id)
           
 String archive(String siteId, Document doc, Stack stack, String archivePath, List attachments)
           
 int countSites(org.sakaiproject.site.api.SiteService.SelectionType type, Object ofType, String criteria, Map propertyCriteria)
           
 org.sakaiproject.site.api.Group findGroup(String refOrId)
           
 org.sakaiproject.site.api.SitePage findPage(String id)
           
 org.sakaiproject.site.api.ToolConfiguration findTool(String id)
           
 org.sakaiproject.entity.api.Entity getEntity(org.sakaiproject.entity.api.Reference ref)
           
 Collection getEntityAuthzGroups(org.sakaiproject.entity.api.Reference ref, String userId)
           
 String getEntityDescription(org.sakaiproject.entity.api.Reference ref)
           
 org.sakaiproject.entity.api.ResourceProperties getEntityResourceProperties(org.sakaiproject.entity.api.Reference ref)
           
 String getEntityUrl(org.sakaiproject.entity.api.Reference ref)
           
 org.sakaiproject.entity.api.HttpAccess getHttpAccess()
           
 String getLabel()
           
 String[] getLayoutNames()
           
 org.sakaiproject.site.api.Site getSite(String id)
           
 List<org.sakaiproject.site.api.SiteAdvisor> getSiteAdvisors()
           
 String getSiteDisplay(String id)
           
 List getSites(org.sakaiproject.site.api.SiteService.SelectionType type, Object ofType, String criteria, Map propertyCriteria, org.sakaiproject.site.api.SiteService.SortType sort, org.sakaiproject.javax.PagingPosition page)
           
 String getSiteSkin(String id)
           
 String getSiteSpecialId(String site)
           
 List getSiteTypes()
           
 String getSiteUserId(String site)
           
 org.sakaiproject.site.api.Site getSiteVisit(String id)
           
 List<org.sakaiproject.site.api.Site> getSoftlyDeletedSites()
           
 String getSpecialSiteId(String special)
           
 String getUserSiteId(String userId)
           
 boolean isSpecialSite(String site)
           
 boolean isUserSite(String site)
           
 void join(String id)
           
 String merge(String toSiteId, Element e, String creatorId)
           
 String merge(String siteId, Element root, String archivePath, String fromSiteId, Map attachmentNames, Map userIdTrans, Set userListAllowImport)
           
 boolean parseEntityReference(String reference, org.sakaiproject.entity.api.Reference ref)
           
 void removeSite(org.sakaiproject.site.api.Site site)
           
 boolean removeSiteAdvisor(org.sakaiproject.site.api.SiteAdvisor advisor)
           
 void save(org.sakaiproject.site.api.Site site)
           
 void saveGroupMembership(org.sakaiproject.site.api.Site site)
           
 void saveSiteInfo(String id, String description, String infoUrl)
           
 void saveSiteMembership(org.sakaiproject.site.api.Site site)
           
 void setSiteSecurity(String siteId, Set updateUsers, Set visitUnpUsers, Set visitUsers)
           
 void setUserSecurity(String userId, Set updateSites, Set visitUnpSites, Set visitSites)
           
 boolean siteExists(String id)
           
 String siteGroupReference(String siteId, String groupId)
           
 String sitePageReference(String siteId, String pageId)
           
 String siteReference(String id)
           
 String siteToolReference(String siteId, String toolId)
           
 void unjoin(String id)
           
 boolean willArchiveMerge()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SiteService

public SiteService()
Method Detail

addSite

public Site addSite(String id,
                    String type)
Specified by:
addSite in interface org.sakaiproject.site.api.SiteService

addSite

public Site addSite(String id,
                    org.sakaiproject.site.api.Site other)
             throws org.sakaiproject.exception.IdInvalidException,
                    org.sakaiproject.exception.IdUsedException,
                    org.sakaiproject.exception.PermissionException
Specified by:
addSite in interface org.sakaiproject.site.api.SiteService
Throws:
org.sakaiproject.exception.IdInvalidException
org.sakaiproject.exception.IdUsedException
org.sakaiproject.exception.PermissionException

addSiteAdvisor

public void addSiteAdvisor(org.sakaiproject.site.api.SiteAdvisor advisor)
Specified by:
addSiteAdvisor in interface org.sakaiproject.site.api.SiteService

allowAccessSite

public boolean allowAccessSite(String id)
Specified by:
allowAccessSite in interface org.sakaiproject.site.api.SiteService

allowAddPortfolioSite

public boolean allowAddPortfolioSite()
Specified by:
allowAddPortfolioSite in interface org.sakaiproject.site.api.SiteService

allowAddSite

public boolean allowAddSite(String id)
Specified by:
allowAddSite in interface org.sakaiproject.site.api.SiteService

allowRemoveSite

public boolean allowRemoveSite(String id)
Specified by:
allowRemoveSite in interface org.sakaiproject.site.api.SiteService

allowUnjoinSite

public boolean allowUnjoinSite(String id)
Specified by:
allowUnjoinSite in interface org.sakaiproject.site.api.SiteService

allowUpdateGroupMembership

public boolean allowUpdateGroupMembership(String id)
Specified by:
allowUpdateGroupMembership in interface org.sakaiproject.site.api.SiteService

allowUpdateSite

public boolean allowUpdateSite(String id)
Specified by:
allowUpdateSite in interface org.sakaiproject.site.api.SiteService

allowUpdateSiteMembership

public boolean allowUpdateSiteMembership(String id)
Specified by:
allowUpdateSiteMembership in interface org.sakaiproject.site.api.SiteService

allowViewRoster

public boolean allowViewRoster(String id)
Specified by:
allowViewRoster in interface org.sakaiproject.site.api.SiteService

allowRoleSwap

public boolean allowRoleSwap(String id)
Specified by:
allowRoleSwap in interface org.sakaiproject.site.api.SiteService

countSites

public int countSites(org.sakaiproject.site.api.SiteService.SelectionType type,
                      Object ofType,
                      String criteria,
                      Map propertyCriteria)
Specified by:
countSites in interface org.sakaiproject.site.api.SiteService

findGroup

public org.sakaiproject.site.api.Group findGroup(String refOrId)
Specified by:
findGroup in interface org.sakaiproject.site.api.SiteService

findPage

public org.sakaiproject.site.api.SitePage findPage(String id)
Specified by:
findPage in interface org.sakaiproject.site.api.SiteService

findTool

public org.sakaiproject.site.api.ToolConfiguration findTool(String id)
Specified by:
findTool in interface org.sakaiproject.site.api.SiteService

getLayoutNames

public String[] getLayoutNames()
Specified by:
getLayoutNames in interface org.sakaiproject.site.api.SiteService

getSite

public org.sakaiproject.site.api.Site getSite(String id)
                                       throws org.sakaiproject.exception.IdUnusedException
Specified by:
getSite in interface org.sakaiproject.site.api.SiteService
Throws:
org.sakaiproject.exception.IdUnusedException

getSiteAdvisors

public List<org.sakaiproject.site.api.SiteAdvisor> getSiteAdvisors()
Specified by:
getSiteAdvisors in interface org.sakaiproject.site.api.SiteService

getSiteDisplay

public String getSiteDisplay(String id)
Specified by:
getSiteDisplay in interface org.sakaiproject.site.api.SiteService

getSiteSkin

public String getSiteSkin(String id)
Specified by:
getSiteSkin in interface org.sakaiproject.site.api.SiteService

getSiteSpecialId

public String getSiteSpecialId(String site)
Specified by:
getSiteSpecialId in interface org.sakaiproject.site.api.SiteService

getSiteTypes

public List getSiteTypes()
Specified by:
getSiteTypes in interface org.sakaiproject.site.api.SiteService

getSiteUserId

public String getSiteUserId(String site)
Specified by:
getSiteUserId in interface org.sakaiproject.site.api.SiteService

getSiteVisit

public org.sakaiproject.site.api.Site getSiteVisit(String id)
                                            throws org.sakaiproject.exception.IdUnusedException,
                                                   org.sakaiproject.exception.PermissionException
Specified by:
getSiteVisit in interface org.sakaiproject.site.api.SiteService
Throws:
org.sakaiproject.exception.IdUnusedException
org.sakaiproject.exception.PermissionException

getSites

public List getSites(org.sakaiproject.site.api.SiteService.SelectionType type,
                     Object ofType,
                     String criteria,
                     Map propertyCriteria,
                     org.sakaiproject.site.api.SiteService.SortType sort,
                     org.sakaiproject.javax.PagingPosition page)
Specified by:
getSites in interface org.sakaiproject.site.api.SiteService

getSpecialSiteId

public String getSpecialSiteId(String special)
Specified by:
getSpecialSiteId in interface org.sakaiproject.site.api.SiteService

getUserSiteId

public String getUserSiteId(String userId)
Specified by:
getUserSiteId in interface org.sakaiproject.site.api.SiteService

isSpecialSite

public boolean isSpecialSite(String site)
Specified by:
isSpecialSite in interface org.sakaiproject.site.api.SiteService

isUserSite

public boolean isUserSite(String site)
Specified by:
isUserSite in interface org.sakaiproject.site.api.SiteService

join

public void join(String id)
          throws org.sakaiproject.exception.IdUnusedException,
                 org.sakaiproject.exception.PermissionException
Specified by:
join in interface org.sakaiproject.site.api.SiteService
Throws:
org.sakaiproject.exception.IdUnusedException
org.sakaiproject.exception.PermissionException

merge

public String merge(String toSiteId,
                    Element e,
                    String creatorId)
Specified by:
merge in interface org.sakaiproject.site.api.SiteService

removeSite

public void removeSite(org.sakaiproject.site.api.Site site)
                throws org.sakaiproject.exception.PermissionException
Specified by:
removeSite in interface org.sakaiproject.site.api.SiteService
Throws:
org.sakaiproject.exception.PermissionException

removeSiteAdvisor

public boolean removeSiteAdvisor(org.sakaiproject.site.api.SiteAdvisor advisor)
Specified by:
removeSiteAdvisor in interface org.sakaiproject.site.api.SiteService

save

public void save(org.sakaiproject.site.api.Site site)
          throws org.sakaiproject.exception.IdUnusedException,
                 org.sakaiproject.exception.PermissionException
Specified by:
save in interface org.sakaiproject.site.api.SiteService
Throws:
org.sakaiproject.exception.IdUnusedException
org.sakaiproject.exception.PermissionException

saveGroupMembership

public void saveGroupMembership(org.sakaiproject.site.api.Site site)
                         throws org.sakaiproject.exception.IdUnusedException,
                                org.sakaiproject.exception.PermissionException
Specified by:
saveGroupMembership in interface org.sakaiproject.site.api.SiteService
Throws:
org.sakaiproject.exception.IdUnusedException
org.sakaiproject.exception.PermissionException

saveSiteInfo

public void saveSiteInfo(String id,
                         String description,
                         String infoUrl)
                  throws org.sakaiproject.exception.IdUnusedException,
                         org.sakaiproject.exception.PermissionException
Specified by:
saveSiteInfo in interface org.sakaiproject.site.api.SiteService
Throws:
org.sakaiproject.exception.IdUnusedException
org.sakaiproject.exception.PermissionException

saveSiteMembership

public void saveSiteMembership(org.sakaiproject.site.api.Site site)
                        throws org.sakaiproject.exception.IdUnusedException,
                               org.sakaiproject.exception.PermissionException
Specified by:
saveSiteMembership in interface org.sakaiproject.site.api.SiteService
Throws:
org.sakaiproject.exception.IdUnusedException
org.sakaiproject.exception.PermissionException

setSiteSecurity

public void setSiteSecurity(String siteId,
                            Set updateUsers,
                            Set visitUnpUsers,
                            Set visitUsers)
Specified by:
setSiteSecurity in interface org.sakaiproject.site.api.SiteService

setUserSecurity

public void setUserSecurity(String userId,
                            Set updateSites,
                            Set visitUnpSites,
                            Set visitSites)
Specified by:
setUserSecurity in interface org.sakaiproject.site.api.SiteService

siteExists

public boolean siteExists(String id)
Specified by:
siteExists in interface org.sakaiproject.site.api.SiteService

siteGroupReference

public String siteGroupReference(String siteId,
                                 String groupId)
Specified by:
siteGroupReference in interface org.sakaiproject.site.api.SiteService

sitePageReference

public String sitePageReference(String siteId,
                                String pageId)
Specified by:
sitePageReference in interface org.sakaiproject.site.api.SiteService

siteReference

public String siteReference(String id)
Specified by:
siteReference in interface org.sakaiproject.site.api.SiteService

siteToolReference

public String siteToolReference(String siteId,
                                String toolId)
Specified by:
siteToolReference in interface org.sakaiproject.site.api.SiteService

unjoin

public void unjoin(String id)
            throws org.sakaiproject.exception.IdUnusedException,
                   org.sakaiproject.exception.PermissionException
Specified by:
unjoin in interface org.sakaiproject.site.api.SiteService
Throws:
org.sakaiproject.exception.IdUnusedException
org.sakaiproject.exception.PermissionException

archive

public String archive(String siteId,
                      Document doc,
                      Stack stack,
                      String archivePath,
                      List attachments)
Specified by:
archive in interface org.sakaiproject.entity.api.EntityProducer

getEntity

public org.sakaiproject.entity.api.Entity getEntity(org.sakaiproject.entity.api.Reference ref)
Specified by:
getEntity in interface org.sakaiproject.entity.api.EntityProducer

getEntityAuthzGroups

public Collection getEntityAuthzGroups(org.sakaiproject.entity.api.Reference ref,
                                       String userId)
Specified by:
getEntityAuthzGroups in interface org.sakaiproject.entity.api.EntityProducer

getEntityDescription

public String getEntityDescription(org.sakaiproject.entity.api.Reference ref)
Specified by:
getEntityDescription in interface org.sakaiproject.entity.api.EntityProducer

getEntityResourceProperties

public org.sakaiproject.entity.api.ResourceProperties getEntityResourceProperties(org.sakaiproject.entity.api.Reference ref)
Specified by:
getEntityResourceProperties in interface org.sakaiproject.entity.api.EntityProducer

getEntityUrl

public String getEntityUrl(org.sakaiproject.entity.api.Reference ref)
Specified by:
getEntityUrl in interface org.sakaiproject.entity.api.EntityProducer

getHttpAccess

public org.sakaiproject.entity.api.HttpAccess getHttpAccess()
Specified by:
getHttpAccess in interface org.sakaiproject.entity.api.EntityProducer

getLabel

public String getLabel()
Specified by:
getLabel in interface org.sakaiproject.entity.api.EntityProducer

merge

public String merge(String siteId,
                    Element root,
                    String archivePath,
                    String fromSiteId,
                    Map attachmentNames,
                    Map userIdTrans,
                    Set userListAllowImport)
Specified by:
merge in interface org.sakaiproject.entity.api.EntityProducer

parseEntityReference

public boolean parseEntityReference(String reference,
                                    org.sakaiproject.entity.api.Reference ref)
Specified by:
parseEntityReference in interface org.sakaiproject.entity.api.EntityProducer

willArchiveMerge

public boolean willArchiveMerge()
Specified by:
willArchiveMerge in interface org.sakaiproject.entity.api.EntityProducer

allowAddCourseSite

public boolean allowAddCourseSite()
Specified by:
allowAddCourseSite in interface org.sakaiproject.site.api.SiteService

getSoftlyDeletedSites

public List<org.sakaiproject.site.api.Site> getSoftlyDeletedSites()
Specified by:
getSoftlyDeletedSites in interface org.sakaiproject.site.api.SiteService
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2003-2012 Sakai Project. All Rights Reserved.