Package org.alfresco.utility.dsl

Interface DSL<Data>

All Known Implementing Classes:

DataCalendarEvent, DataContent, DataEmail, DataGroup, DataLink, DataSite, DataUser, DataUserAIS, DataWiki, DataWorkflow, DSLProtocol, DSLProtocolWithNetworkDrive, TestData

public interface DSL<Data>

Method Summary

Modifier and Type	Method	Description
String	getCurrentSpace()
UserModel	getCurrentUser()	gets the current test user
String	getDataDictionaryPath()
String	getRootPath()
String	getSitesPath()
String	getUserHomesPath()
Data	setCurrentSpace(String currentRepositorySpace)	getSitesPath(), getUserHomesPath(), getDataDictionaryPath(), etc If nothing is specified, the root folder is used
Data	usingAdmin()	Defines the current user to be Admin
Data	usingResource(ContentModel model)	Defines the current file/folder that is under test
Data	usingRoot()
Data	usingSite(String siteId)	Defines the current test site to be used
Data	usingSite(SiteModel siteModel)	Defines the current test site to be used based on SiteModel
Data	usingUser(UserModel user)	Defines the current test user that will be used
Data	usingUserHome()
Data	usingUserHome(String username)	Defines the current User Home to be used Example: /User Homes/

Method Details

usingUser

Data usingUser(UserModel user)
        throws Exception

Defines the current test user that will be used

Throws:

Exception

usingAdmin

Data usingAdmin()
         throws Exception

Defines the current user to be Admin

Returns:

Throws:

Exception

getCurrentUser

UserModel getCurrentUser()

gets the current test user

Returns:

usingRoot

Data usingRoot()
        throws Exception

Returns:

the rootPath

Throws:

Exception

getCurrentSpace

String getCurrentSpace()
                throws TestConfigurationException

Returns:

the current Repository Space

Throws:

TestConfigurationException

setCurrentSpace

Data setCurrentSpace(String currentRepositorySpace)

getSitesPath(), getUserHomesPath(), getDataDictionaryPath(), etc If nothing is specified, the root folder is used

usingResource

Data usingResource(ContentModel model)
            throws Exception

Defines the current file/folder that is under test

Parameters:

model -

Returns:

Throws:

Exception

usingSite

Data usingSite(String siteId)
        throws Exception

Defines the current test site to be used

Parameters:

siteId -

Returns:

Throws:

Exception

usingSite

Data usingSite(SiteModel siteModel)
        throws Exception

Defines the current test site to be used based on SiteModel

Parameters:

siteModel -

Returns:

Throws:

Exception

usingUserHome

Data usingUserHome(String username)
            throws Exception

Defines the current User Home to be used Example: /User Homes/

Parameters:

username -

Returns:

Throws:

Exception

usingUserHome

Data usingUserHome()
            throws Exception

Returns:

the userhome path based on getCurrentUser()

Throws:

Exception

getRootPath

String getRootPath()
            throws TestConfigurationException

Returns:

the root path

Throws:

TestConfigurationException

getSitesPath

String getSitesPath()
             throws TestConfigurationException

Returns:

the Sites path Example: /Sites

Throws:

TestConfigurationException

getUserHomesPath

String getUserHomesPath()
                 throws TestConfigurationException

Returns:

user home path Example: /User Homes

Throws:

TestConfigurationException

getDataDictionaryPath

String getDataDictionaryPath()
                      throws TestConfigurationException

Returns:

the Data Dictionary path /Data Dictionary

Throws:

TestConfigurationException